Erlang logo
User's Guide
Reference Manual
Release Notes
PDF
Top

wxErlang
Reference Manual
Version 1.3


Expand All
Contract All

Table of Contents

wxTextAttr

MODULE

wxTextAttr

MODULE SUMMARY

See external documentation: wxTextAttr.

DESCRIPTION

See external documentation: wxTextAttr.

DATA TYPES

wxTextAttr()

An object reference, The representation is internal and can be changed without notice. It can't be used for comparsion stored on disc or distributed for use on other nodes.

EXPORTS

new() -> wxTextAttr()

new(ColText) -> wxTextAttr()

Types:

ColText = wx_colour() (see module wx)

Equivalent to new(ColText, []).

new(ColText, Option::[Option]) -> wxTextAttr()

Types:

ColText = wx_colour() (see module wx)
Option = {colBack, wx_colour() (see module wx)} | {font, wxFont() (see module wxFont)} | {alignment, wx_enum() (see module wx)}

See external documentation.
Alignment = ?wxTEXT_ALIGNMENT_DEFAULT | ?wxTEXT_ALIGNMENT_LEFT | ?wxTEXT_ALIGNMENT_CENTRE | ?wxTEXT_ALIGNMENT_CENTER | ?wxTEXT_ALIGNMENT_RIGHT | ?wxTEXT_ALIGNMENT_JUSTIFIED

getAlignment(This) -> wx_enum() (see module wx)

Types:

This = wxTextAttr()

See external documentation.
Res = ?wxTEXT_ALIGNMENT_DEFAULT | ?wxTEXT_ALIGNMENT_LEFT | ?wxTEXT_ALIGNMENT_CENTRE | ?wxTEXT_ALIGNMENT_CENTER | ?wxTEXT_ALIGNMENT_RIGHT | ?wxTEXT_ALIGNMENT_JUSTIFIED

getBackgroundColour(This) -> wx_colour4() (see module wx)

Types:

This = wxTextAttr()

getFont(This) -> wxFont() (see module wxFont)

Types:

This = wxTextAttr()

getLeftIndent(This) -> integer()

Types:

This = wxTextAttr()

getLeftSubIndent(This) -> integer()

Types:

This = wxTextAttr()

getRightIndent(This) -> integer()

Types:

This = wxTextAttr()

getTabs(This) -> [integer()]

Types:

This = wxTextAttr()

getTextColour(This) -> wx_colour4() (see module wx)

Types:

This = wxTextAttr()

hasBackgroundColour(This) -> boolean()

Types:

This = wxTextAttr()

hasFont(This) -> boolean()

Types:

This = wxTextAttr()

hasTextColour(This) -> boolean()

Types:

This = wxTextAttr()

getFlags(This) -> integer()

Types:

This = wxTextAttr()

isDefault(This) -> boolean()

Types:

This = wxTextAttr()

setAlignment(This, Alignment) -> ok

Types:

This = wxTextAttr()
Alignment = wx_enum() (see module wx)

See external documentation.
Alignment = ?wxTEXT_ALIGNMENT_DEFAULT | ?wxTEXT_ALIGNMENT_LEFT | ?wxTEXT_ALIGNMENT_CENTRE | ?wxTEXT_ALIGNMENT_CENTER | ?wxTEXT_ALIGNMENT_RIGHT | ?wxTEXT_ALIGNMENT_JUSTIFIED

setBackgroundColour(This, ColBack) -> ok

Types:

This = wxTextAttr()
ColBack = wx_colour() (see module wx)

setFlags(This, Flags) -> ok

Types:

This = wxTextAttr()
Flags = integer()

setFont(This, Font) -> ok

Types:

This = wxTextAttr()
Font = wxFont() (see module wxFont)

Equivalent to setFont(This, Font, []).

setFont(This, Font, Option::[Option]) -> ok

Types:

This = wxTextAttr()
Font = wxFont() (see module wxFont)
Option = {flags, integer()}

setLeftIndent(This, Indent) -> ok

Types:

This = wxTextAttr()
Indent = integer()

setLeftIndent(This, Indent, Option::[Option]) -> ok

Types:

This = wxTextAttr()
Indent = integer()
Option = {subIndent, integer()}

setRightIndent(This, Indent) -> ok

Types:

This = wxTextAttr()
Indent = integer()

setTabs(This, Tabs) -> ok

Types:

This = wxTextAttr()
Tabs = [integer()]

setTextColour(This, ColText) -> ok

Types:

This = wxTextAttr()
ColText = wx_colour() (see module wx)

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

Destroys this object, do not use object again