查看源代码 wxTextAttr (wx v2.4.3)

wxTextAttr 表示 wxTextCtrlwxRichTextCtrl (wx 中未实现) 中一段文本的字符和段落属性,或样式。

在设置 wxTextAttr 对象时,将位列表掩码传递给 setFlags/2 以指示应更改哪些样式元素。为了方便起见,当您调用诸如 SetFont 之类的设置器时,将设置相关的位。

参见:wxTextCtrl

wxWidgets 文档:wxTextAttr

摘要

函数

销毁对象

返回对齐标志。

返回背景颜色。

返回指示哪些属性适用的标志。

创建并返回 wxTextAttr 对象中字体属性指定的字体。

返回字体编码。

返回字体面名称。

返回以磅为单位的字体大小。

返回字体样式。

如果字体带有下划线,则返回 true。

返回字体粗细。

返回以十分之一毫米为单位的左缩进。

返回以十分之一毫米为单位的左子缩进。

返回以十分之一毫米为单位的右缩进。

返回制表位数组,每个制表位均以十分之一毫米为单位表示。

返回文本前景色。

如果属性对象指定了背景颜色,则返回 true。

如果属性对象指定了任何字体属性,则返回 true。

如果属性对象指定了文本前景色,则返回 true。

如果我们设置了任何属性,则返回 false,否则返回 true。

构造函数。

设置段落对齐方式。

设置背景颜色。

设置确定要指定哪些样式的标志。

设置给定字体的属性。

设置字体编码。

设置字体面名称。

设置字体系列。

设置以像素为单位的字体大小。

设置以磅为单位的字体大小。

设置以磅为单位的字体大小。

设置字体样式(正常、斜体或倾斜)。

设置字体下划线(实线,文本颜色)。

设置字体粗细。

设置以十分之一毫米为单位的左缩进和左子缩进。

设置以十分之一毫米为单位的右缩进。

设置以十分之一毫米为单位表示的制表位。

设置文本前景色。

类型

-type wxTextAttr() :: wx:wx_object().

函数

-spec destroy(This :: wxTextAttr()) -> ok.

销毁对象

-spec getAlignment(This) -> wx:wx_enum() when This :: wxTextAttr().

返回对齐标志。

有关可用样式的列表,请参见 ?wxTextAttrAlignment。

链接到此函数

getBackgroundColour(This)

查看源代码
-spec getBackgroundColour(This) -> wx:wx_colour4() when This :: wxTextAttr().

返回背景颜色。

-spec getFlags(This) -> integer() when This :: wxTextAttr().

返回指示哪些属性适用的标志。

有关可用标志的列表,请参见 setFlags/2

-spec getFont(This) -> wxFont:wxFont() when This :: wxTextAttr().

创建并返回 wxTextAttr 对象中字体属性指定的字体。

请注意,wxTextAttr 不会存储 wxFont 对象,因此这只是一个临时字体。

为了更高的效率,请直接访问字体属性。

-spec getFontEncoding(This) -> wx:wx_enum() when This :: wxTextAttr().

返回字体编码。

-spec getFontFaceName(This) -> unicode:charlist() when This :: wxTextAttr().

返回字体面名称。

-spec getFontSize(This) -> integer() when This :: wxTextAttr().

返回以磅为单位的字体大小。

-spec getFontStyle(This) -> wx:wx_enum() when This :: wxTextAttr().

返回字体样式。

链接到此函数

getFontUnderlined(This)

查看源代码
-spec getFontUnderlined(This) -> boolean() when This :: wxTextAttr().

如果字体带有下划线,则返回 true。

-spec getFontWeight(This) -> wx:wx_enum() when This :: wxTextAttr().

返回字体粗细。

-spec getLeftIndent(This) -> integer() when This :: wxTextAttr().

返回以十分之一毫米为单位的左缩进。

链接到此函数

getLeftSubIndent(This)

查看源代码
-spec getLeftSubIndent(This) -> integer() when This :: wxTextAttr().

返回以十分之一毫米为单位的左子缩进。

-spec getRightIndent(This) -> integer() when This :: wxTextAttr().

返回以十分之一毫米为单位的右缩进。

-spec getTabs(This) -> [integer()] when This :: wxTextAttr().

返回制表位数组,每个制表位均以十分之一毫米为单位表示。

每个停止位均从左边距开始测量,因此每个值都必须大于上一个值。

-spec getTextColour(This) -> wx:wx_colour4() when This :: wxTextAttr().

返回文本前景色。

链接到此函数

hasBackgroundColour(This)

查看源代码
-spec hasBackgroundColour(This) -> boolean() when This :: wxTextAttr().

如果属性对象指定了背景颜色,则返回 true。

-spec hasFont(This) -> boolean() when This :: wxTextAttr().

如果属性对象指定了任何字体属性,则返回 true。

-spec hasTextColour(This) -> boolean() when This :: wxTextAttr().

如果属性对象指定了文本前景色,则返回 true。

-spec isDefault(This) -> boolean() when This :: wxTextAttr().

如果我们设置了任何属性,则返回 false,否则返回 true。

-spec new() -> wxTextAttr().

构造函数。

-spec new(ColText) -> wxTextAttr() when ColText :: wx:wx_colour();
         (Attr) -> wxTextAttr() when Attr :: wxTextAttr().
-spec new(ColText, [Option]) -> wxTextAttr()
             when
                 ColText :: wx:wx_colour(),
                 Option ::
                     {colBack, wx:wx_colour()} | {font, wxFont:wxFont()} | {alignment, wx:wx_enum()}.
链接到此函数

setAlignment(This, Alignment)

查看源代码
-spec setAlignment(This, Alignment) -> ok when This :: wxTextAttr(), Alignment :: wx:wx_enum().

设置段落对齐方式。

请参见 ?wxTextAttrAlignment 枚举值。

其中,wxTEXT_ALIGNMENT_JUSTIFIED 未实现。将来,仅在打印或预览时才可能支持对齐。

链接到此函数

setBackgroundColour(This, ColBack)

查看源代码
-spec setBackgroundColour(This, ColBack) -> ok when This :: wxTextAttr(), ColBack :: wx:wx_colour().

设置背景颜色。

-spec setFlags(This, Flags) -> ok when This :: wxTextAttr(), Flags :: integer().

设置确定要指定哪些样式的标志。

可以在位列表中传递 ?wxTextAttrFlags 值。

-spec setFont(This, Font) -> ok when This :: wxTextAttr(), Font :: wxFont:wxFont().

等效于 setFont(This, Font, [])

-spec setFont(This, Font, [Option]) -> ok
                 when This :: wxTextAttr(), Font :: wxFont:wxFont(), Option :: {flags, integer()}.

设置给定字体的属性。

请注意,wxTextAttr 不存储实际的 wxFont 对象。

链接到此函数

setFontEncoding(This, Encoding)

查看源代码
-spec setFontEncoding(This, Encoding) -> ok when This :: wxTextAttr(), Encoding :: wx:wx_enum().

设置字体编码。

链接到此函数

setFontFaceName(This, FaceName)

查看源代码
-spec setFontFaceName(This, FaceName) -> ok when This :: wxTextAttr(), FaceName :: unicode:chardata().

设置字体面名称。

链接到此函数

setFontFamily(This, Family)

查看源代码
-spec setFontFamily(This, Family) -> ok when This :: wxTextAttr(), Family :: wx:wx_enum().

设置字体系列。

链接到此函数

setFontPixelSize(This, PixelSize)

查看源代码
-spec setFontPixelSize(This, PixelSize) -> ok when This :: wxTextAttr(), PixelSize :: integer().

设置以像素为单位的字体大小。

链接到此函数

setFontPointSize(This, PointSize)

查看源代码
-spec setFontPointSize(This, PointSize) -> ok when This :: wxTextAttr(), PointSize :: integer().

设置以磅为单位的字体大小。

链接到此函数

setFontSize(This, PointSize)

查看源代码
-spec setFontSize(This, PointSize) -> ok when This :: wxTextAttr(), PointSize :: integer().

设置以磅为单位的字体大小。

链接到此函数

setFontStyle(This, FontStyle)

查看源代码
-spec setFontStyle(This, FontStyle) -> ok when This :: wxTextAttr(), FontStyle :: wx:wx_enum().

设置字体样式(正常、斜体或倾斜)。

链接到此函数

setFontUnderlined(This, Underlined)

查看源代码
-spec setFontUnderlined(This, Underlined) -> ok when This :: wxTextAttr(), Underlined :: boolean().

设置字体下划线(实线,文本颜色)。

链接到此函数

setFontWeight(This, FontWeight)

查看源代码
-spec setFontWeight(This, FontWeight) -> ok when This :: wxTextAttr(), FontWeight :: wx:wx_enum().

设置字体粗细。

链接到此函数

setLeftIndent(This, Indent)

查看源代码
-spec setLeftIndent(This, Indent) -> ok when This :: wxTextAttr(), Indent :: integer().

等效于 setLeftIndent(This, Indent, [])

-spec setLeftIndent(This, Indent, [Option]) -> ok
                       when This :: wxTextAttr(), Indent :: integer(), Option :: {subIndent, integer()}.

设置以十分之一毫米为单位的左缩进和左子缩进。

子缩进是段落左侧的偏移量,用于段落中除第一行之外的所有行。

正值将导致第一行出现在后续行的左侧,而负值将导致第一行相对于后续行缩进。

wxRichTextBuffer (wx 中未实现) 使用缩进来渲染项目符号。左缩进是边距和项目符号之间的距离。段落的内容(包括第一行)从左边距 + 左子缩进处开始。因此,项目符号的左边缘与实际段落的左侧之间的距离是左子缩进。

链接到此函数

setRightIndent(This, Indent)

查看源代码
-spec setRightIndent(This, Indent) -> ok when This :: wxTextAttr(), Indent :: integer().

设置以十分之一毫米为单位的右缩进。

-spec setTabs(This, Tabs) -> ok when This :: wxTextAttr(), Tabs :: [integer()].

设置以十分之一毫米为单位表示的制表位。

每个停止位均从左边距开始测量,因此每个值都必须大于上一个值。

链接到此函数

setTextColour(This, ColText)

查看源代码
-spec setTextColour(This, ColText) -> ok when This :: wxTextAttr(), ColText :: wx:wx_colour().

设置文本前景色。