mirror of
https://github.com/status-im/snorenotify.git
synced 2025-02-18 11:17:21 +00:00
Added some doc.
This commit is contained in:
parent
ba8e6bde21
commit
b08310d869
@ -31,14 +31,55 @@ class SNORE_EXPORT Utils : public QObject
|
|||||||
{
|
{
|
||||||
Q_OBJECT
|
Q_OBJECT
|
||||||
public:
|
public:
|
||||||
|
/**
|
||||||
|
* The MARKUP_FLAG enum.
|
||||||
|
* If a falg is not present the markup key will be removed.
|
||||||
|
* If any flag is present, special characters mus be html escaped.
|
||||||
|
*/
|
||||||
enum MARKUP_FLAG {
|
enum MARKUP_FLAG {
|
||||||
|
/**
|
||||||
|
* No markup is supported.
|
||||||
|
* All markup will be removed.
|
||||||
|
*/
|
||||||
NO_MARKUP = 0,
|
NO_MARKUP = 0,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Urls are supprotet.
|
||||||
|
* <a href="www.foo.bar">Foo Bar</a>
|
||||||
|
*/
|
||||||
HREF = 1 << 0,
|
HREF = 1 << 0,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Line breeaks <br> are supprotet.
|
||||||
|
* If the flag is not present <br> will be replaced by \\n
|
||||||
|
*/
|
||||||
BREAK = 1 << 1,
|
BREAK = 1 << 1,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Bold <b> is supportet.
|
||||||
|
*/
|
||||||
BOLD = 1 << 2,
|
BOLD = 1 << 2,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Italic <i> is supportet.
|
||||||
|
*/
|
||||||
ITALIC = 1 << 3,
|
ITALIC = 1 << 3,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Underline <u> is supportet.
|
||||||
|
*/
|
||||||
UNDERLINE = 1 << 4,
|
UNDERLINE = 1 << 4,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Fonst are supportet.
|
||||||
|
* <font color="blue"> word </font>
|
||||||
|
*/
|
||||||
FONT = 1 << 5,
|
FONT = 1 << 5,
|
||||||
|
|
||||||
|
/**
|
||||||
|
* All markup is supported.
|
||||||
|
* No markup will be removed.
|
||||||
|
*/
|
||||||
ALL_MARKUP = ~0
|
ALL_MARKUP = ~0
|
||||||
};
|
};
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user