interface revisions of ta*h te*h headers; grouped wxTextAttr #defines into enums to make it easier to document them
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56075 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -161,96 +161,108 @@ enum wxTextAttrAlignment
|
||||
};
|
||||
|
||||
// Flags to indicate which attributes are being applied
|
||||
enum wxTextAttrFlags
|
||||
{
|
||||
wxTEXT_ATTR_TEXT_COLOUR = 0x00000001,
|
||||
wxTEXT_ATTR_BACKGROUND_COLOUR = 0x00000002,
|
||||
wxTEXT_ATTR_FONT_FACE = 0x00000004,
|
||||
wxTEXT_ATTR_FONT_SIZE = 0x00000008,
|
||||
wxTEXT_ATTR_FONT_WEIGHT = 0x00000010,
|
||||
wxTEXT_ATTR_FONT_ITALIC = 0x00000020,
|
||||
wxTEXT_ATTR_FONT_UNDERLINE = 0x00000040,
|
||||
wxTEXT_ATTR_FONT_ENCODING = 0x02000000,
|
||||
wxTEXT_ATTR_FONT = \
|
||||
( wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT | \
|
||||
wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE | wxTEXT_ATTR_FONT_ENCODING ),
|
||||
|
||||
#define wxTEXT_ATTR_TEXT_COLOUR 0x00000001
|
||||
#define wxTEXT_ATTR_BACKGROUND_COLOUR 0x00000002
|
||||
#define wxTEXT_ATTR_FONT_FACE 0x00000004
|
||||
#define wxTEXT_ATTR_FONT_SIZE 0x00000008
|
||||
#define wxTEXT_ATTR_FONT_WEIGHT 0x00000010
|
||||
#define wxTEXT_ATTR_FONT_ITALIC 0x00000020
|
||||
#define wxTEXT_ATTR_FONT_UNDERLINE 0x00000040
|
||||
#define wxTEXT_ATTR_FONT_ENCODING 0x02000000
|
||||
#define wxTEXT_ATTR_FONT \
|
||||
( wxTEXT_ATTR_FONT_FACE | wxTEXT_ATTR_FONT_SIZE | wxTEXT_ATTR_FONT_WEIGHT | \
|
||||
wxTEXT_ATTR_FONT_ITALIC | wxTEXT_ATTR_FONT_UNDERLINE | wxTEXT_ATTR_FONT_ENCODING )
|
||||
#define wxTEXT_ATTR_ALIGNMENT 0x00000080
|
||||
#define wxTEXT_ATTR_LEFT_INDENT 0x00000100
|
||||
#define wxTEXT_ATTR_RIGHT_INDENT 0x00000200
|
||||
#define wxTEXT_ATTR_TABS 0x00000400
|
||||
wxTEXT_ATTR_ALIGNMENT = 0x00000080,
|
||||
wxTEXT_ATTR_LEFT_INDENT = 0x00000100,
|
||||
wxTEXT_ATTR_RIGHT_INDENT = 0x00000200,
|
||||
wxTEXT_ATTR_TABS = 0x00000400,
|
||||
|
||||
#define wxTEXT_ATTR_PARA_SPACING_AFTER 0x00000800
|
||||
#define wxTEXT_ATTR_PARA_SPACING_BEFORE 0x00001000
|
||||
#define wxTEXT_ATTR_LINE_SPACING 0x00002000
|
||||
#define wxTEXT_ATTR_CHARACTER_STYLE_NAME 0x00004000
|
||||
#define wxTEXT_ATTR_PARAGRAPH_STYLE_NAME 0x00008000
|
||||
#define wxTEXT_ATTR_LIST_STYLE_NAME 0x00010000
|
||||
#define wxTEXT_ATTR_BULLET_STYLE 0x00020000
|
||||
#define wxTEXT_ATTR_BULLET_NUMBER 0x00040000
|
||||
#define wxTEXT_ATTR_BULLET_TEXT 0x00080000
|
||||
#define wxTEXT_ATTR_BULLET_NAME 0x00100000
|
||||
#define wxTEXT_ATTR_URL 0x00200000
|
||||
#define wxTEXT_ATTR_PAGE_BREAK 0x00400000
|
||||
#define wxTEXT_ATTR_EFFECTS 0x00800000
|
||||
#define wxTEXT_ATTR_OUTLINE_LEVEL 0x01000000
|
||||
wxTEXT_ATTR_PARA_SPACING_AFTER = 0x00000800,
|
||||
wxTEXT_ATTR_PARA_SPACING_BEFORE = 0x00001000,
|
||||
wxTEXT_ATTR_LINE_SPACING = 0x00002000,
|
||||
wxTEXT_ATTR_CHARACTER_STYLE_NAME = 0x00004000,
|
||||
wxTEXT_ATTR_PARAGRAPH_STYLE_NAME = 0x00008000,
|
||||
wxTEXT_ATTR_LIST_STYLE_NAME = 0x00010000,
|
||||
wxTEXT_ATTR_BULLET_STYLE = 0x00020000,
|
||||
wxTEXT_ATTR_BULLET_NUMBER = 0x00040000,
|
||||
wxTEXT_ATTR_BULLET_TEXT = 0x00080000,
|
||||
wxTEXT_ATTR_BULLET_NAME = 0x00100000,
|
||||
wxTEXT_ATTR_URL = 0x00200000,
|
||||
wxTEXT_ATTR_PAGE_BREAK = 0x00400000,
|
||||
wxTEXT_ATTR_EFFECTS = 0x00800000,
|
||||
wxTEXT_ATTR_OUTLINE_LEVEL = 0x01000000,
|
||||
|
||||
/*!
|
||||
* Character and paragraph combined styles
|
||||
*/
|
||||
/*!
|
||||
* Character and paragraph combined styles
|
||||
*/
|
||||
|
||||
#define wxTEXT_ATTR_CHARACTER (wxTEXT_ATTR_FONT|wxTEXT_ATTR_FONT_ENCODING|wxTEXT_ATTR_EFFECTS|wxTEXT_ATTR_BACKGROUND_COLOUR|wxTEXT_ATTR_TEXT_COLOUR|wxTEXT_ATTR_CHARACTER_STYLE_NAME|wxTEXT_ATTR_URL)
|
||||
wxTEXT_ATTR_CHARACTER = \
|
||||
(wxTEXT_ATTR_FONT|wxTEXT_ATTR_FONT_ENCODING|wxTEXT_ATTR_EFFECTS| \
|
||||
wxTEXT_ATTR_BACKGROUND_COLOUR|wxTEXT_ATTR_TEXT_COLOUR|wxTEXT_ATTR_CHARACTER_STYLE_NAME|wxTEXT_ATTR_URL),
|
||||
|
||||
#define wxTEXT_ATTR_PARAGRAPH (wxTEXT_ATTR_ALIGNMENT|wxTEXT_ATTR_LEFT_INDENT|wxTEXT_ATTR_RIGHT_INDENT|wxTEXT_ATTR_TABS|\
|
||||
wxTEXT_ATTR_PARA_SPACING_BEFORE|wxTEXT_ATTR_PARA_SPACING_AFTER|wxTEXT_ATTR_LINE_SPACING|\
|
||||
wxTEXT_ATTR_BULLET_STYLE|wxTEXT_ATTR_BULLET_NUMBER|wxTEXT_ATTR_BULLET_TEXT|wxTEXT_ATTR_BULLET_NAME|\
|
||||
wxTEXT_ATTR_PARAGRAPH_STYLE_NAME|wxTEXT_ATTR_LIST_STYLE_NAME|wxTEXT_ATTR_OUTLINE_LEVEL)
|
||||
wxTEXT_ATTR_PARAGRAPH = \
|
||||
(wxTEXT_ATTR_ALIGNMENT|wxTEXT_ATTR_LEFT_INDENT|wxTEXT_ATTR_RIGHT_INDENT|wxTEXT_ATTR_TABS|\
|
||||
wxTEXT_ATTR_PARA_SPACING_BEFORE|wxTEXT_ATTR_PARA_SPACING_AFTER|wxTEXT_ATTR_LINE_SPACING|\
|
||||
wxTEXT_ATTR_BULLET_STYLE|wxTEXT_ATTR_BULLET_NUMBER|wxTEXT_ATTR_BULLET_TEXT|wxTEXT_ATTR_BULLET_NAME|\
|
||||
wxTEXT_ATTR_PARAGRAPH_STYLE_NAME|wxTEXT_ATTR_LIST_STYLE_NAME|wxTEXT_ATTR_OUTLINE_LEVEL),
|
||||
|
||||
#define wxTEXT_ATTR_ALL (wxTEXT_ATTR_CHARACTER|wxTEXT_ATTR_PARAGRAPH)
|
||||
wxTEXT_ATTR_ALL = (wxTEXT_ATTR_CHARACTER|wxTEXT_ATTR_PARAGRAPH)
|
||||
};
|
||||
|
||||
/*!
|
||||
* Styles for wxTextAttr::SetBulletStyle
|
||||
*/
|
||||
enum wxTextAttrBulletStyle
|
||||
{
|
||||
wxTEXT_ATTR_BULLET_STYLE_NONE = 0x00000000,
|
||||
wxTEXT_ATTR_BULLET_STYLE_ARABIC = 0x00000001,
|
||||
wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER = 0x00000002,
|
||||
wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER = 0x00000004,
|
||||
wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER = 0x00000008,
|
||||
wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER = 0x00000010,
|
||||
wxTEXT_ATTR_BULLET_STYLE_SYMBOL = 0x00000020,
|
||||
wxTEXT_ATTR_BULLET_STYLE_BITMAP = 0x00000040,
|
||||
wxTEXT_ATTR_BULLET_STYLE_PARENTHESES = 0x00000080,
|
||||
wxTEXT_ATTR_BULLET_STYLE_PERIOD = 0x00000100,
|
||||
wxTEXT_ATTR_BULLET_STYLE_STANDARD = 0x00000200,
|
||||
wxTEXT_ATTR_BULLET_STYLE_RIGHT_PARENTHESIS = 0x00000400,
|
||||
wxTEXT_ATTR_BULLET_STYLE_OUTLINE = 0x00000800,
|
||||
|
||||
#define wxTEXT_ATTR_BULLET_STYLE_NONE 0x00000000
|
||||
#define wxTEXT_ATTR_BULLET_STYLE_ARABIC 0x00000001
|
||||
#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_UPPER 0x00000002
|
||||
#define wxTEXT_ATTR_BULLET_STYLE_LETTERS_LOWER 0x00000004
|
||||
#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_UPPER 0x00000008
|
||||
#define wxTEXT_ATTR_BULLET_STYLE_ROMAN_LOWER 0x00000010
|
||||
#define wxTEXT_ATTR_BULLET_STYLE_SYMBOL 0x00000020
|
||||
#define wxTEXT_ATTR_BULLET_STYLE_BITMAP 0x00000040
|
||||
#define wxTEXT_ATTR_BULLET_STYLE_PARENTHESES 0x00000080
|
||||
#define wxTEXT_ATTR_BULLET_STYLE_PERIOD 0x00000100
|
||||
#define wxTEXT_ATTR_BULLET_STYLE_STANDARD 0x00000200
|
||||
#define wxTEXT_ATTR_BULLET_STYLE_RIGHT_PARENTHESIS 0x00000400
|
||||
#define wxTEXT_ATTR_BULLET_STYLE_OUTLINE 0x00000800
|
||||
|
||||
#define wxTEXT_ATTR_BULLET_STYLE_ALIGN_LEFT 0x00000000
|
||||
#define wxTEXT_ATTR_BULLET_STYLE_ALIGN_RIGHT 0x00001000
|
||||
#define wxTEXT_ATTR_BULLET_STYLE_ALIGN_CENTRE 0x00002000
|
||||
wxTEXT_ATTR_BULLET_STYLE_ALIGN_LEFT = 0x00000000,
|
||||
wxTEXT_ATTR_BULLET_STYLE_ALIGN_RIGHT = 0x00001000,
|
||||
wxTEXT_ATTR_BULLET_STYLE_ALIGN_CENTRE = 0x00002000
|
||||
};
|
||||
|
||||
/*!
|
||||
* Styles for wxTextAttr::SetTextEffects
|
||||
*/
|
||||
|
||||
#define wxTEXT_ATTR_EFFECT_NONE 0x00000000
|
||||
#define wxTEXT_ATTR_EFFECT_CAPITALS 0x00000001
|
||||
#define wxTEXT_ATTR_EFFECT_SMALL_CAPITALS 0x00000002
|
||||
#define wxTEXT_ATTR_EFFECT_STRIKETHROUGH 0x00000004
|
||||
#define wxTEXT_ATTR_EFFECT_DOUBLE_STRIKETHROUGH 0x00000008
|
||||
#define wxTEXT_ATTR_EFFECT_SHADOW 0x00000010
|
||||
#define wxTEXT_ATTR_EFFECT_EMBOSS 0x00000020
|
||||
#define wxTEXT_ATTR_EFFECT_OUTLINE 0x00000040
|
||||
#define wxTEXT_ATTR_EFFECT_ENGRAVE 0x00000080
|
||||
#define wxTEXT_ATTR_EFFECT_SUPERSCRIPT 0x00000100
|
||||
#define wxTEXT_ATTR_EFFECT_SUBSCRIPT 0x00000200
|
||||
enum wxTextAttrEffects
|
||||
{
|
||||
wxTEXT_ATTR_EFFECT_NONE = 0x00000000,
|
||||
wxTEXT_ATTR_EFFECT_CAPITALS = 0x00000001,
|
||||
wxTEXT_ATTR_EFFECT_SMALL_CAPITALS = 0x00000002,
|
||||
wxTEXT_ATTR_EFFECT_STRIKETHROUGH = 0x00000004,
|
||||
wxTEXT_ATTR_EFFECT_DOUBLE_STRIKETHROUGH = 0x00000008,
|
||||
wxTEXT_ATTR_EFFECT_SHADOW = 0x00000010,
|
||||
wxTEXT_ATTR_EFFECT_EMBOSS = 0x00000020,
|
||||
wxTEXT_ATTR_EFFECT_OUTLINE = 0x00000040,
|
||||
wxTEXT_ATTR_EFFECT_ENGRAVE = 0x00000080,
|
||||
wxTEXT_ATTR_EFFECT_SUPERSCRIPT = 0x00000100,
|
||||
wxTEXT_ATTR_EFFECT_SUBSCRIPT = 0x00000200
|
||||
};
|
||||
|
||||
/*!
|
||||
* Line spacing values
|
||||
*/
|
||||
|
||||
#define wxTEXT_ATTR_LINE_SPACING_NORMAL 10
|
||||
#define wxTEXT_ATTR_LINE_SPACING_HALF 15
|
||||
#define wxTEXT_ATTR_LINE_SPACING_TWICE 20
|
||||
enum wxTextAttrLineSpacing
|
||||
{
|
||||
wxTEXT_ATTR_LINE_SPACING_NORMAL = 10,
|
||||
wxTEXT_ATTR_LINE_SPACING_HALF = 15,
|
||||
wxTEXT_ATTR_LINE_SPACING_TWICE = 20
|
||||
};
|
||||
|
||||
// ----------------------------------------------------------------------------
|
||||
// wxTextAttr: a structure containing the visual attributes of a text
|
||||
@@ -345,6 +357,8 @@ public:
|
||||
const wxString& GetListStyleName() const { return m_listStyleName; }
|
||||
int GetParagraphSpacingAfter() const { return m_paragraphSpacingAfter; }
|
||||
int GetParagraphSpacingBefore() const { return m_paragraphSpacingBefore; }
|
||||
|
||||
// TODO: should return the relative wxTextAttr* enumeration values
|
||||
int GetLineSpacing() const { return m_lineSpacing; }
|
||||
int GetBulletStyle() const { return m_bulletStyle; }
|
||||
int GetBulletNumber() const { return m_bulletNumber; }
|
||||
|
Reference in New Issue
Block a user