wxFont(3)



wxFont(3erl)               Erlang Module Definition               wxFont(3erl)

NAME
       wxFont - See external documentation: wxFont.

DESCRIPTION
       See external documentation: wxFont.

DATA TYPES
         wxFont():

           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() -> wxFont()

              See external documentation.

       new(Fontname) -> wxFont()

              Types:

                 Fontname = unicode:chardata()

              See external documentation.

       new(Size, Family, Style, Weight) -> wxFont()

              Types:

                 Size = integer()
                 Family = wx:wx_enum()
                 Style = wx:wx_enum()
                 Weight = integer()

              Equivalent to new(Size, Family, Style, Weight, []).

       new(Size, Family, Style, Weight, Options::[Option]) -> wxFont()

              Types:

                 Size = integer()
                 Family = wx:wx_enum()
                 Style = wx:wx_enum()
                 Weight = integer()
                 Option = {underlined, boolean()} | {face, unicode:chardata()}
                 | {encoding, wx:wx_enum()}

              See external documentation.
              Encoding = ?wxFONTENCODING_SYSTEM  |  ?wxFONTENCODING_DEFAULT  |
              ?wxFONTENCODING_ISO8859_1  |  ?wxFONTENCODING_ISO8859_2  |  ?wx-
              FONTENCODING_ISO8859_3  |   ?wxFONTENCODING_ISO8859_4   |   ?wx-
              FONTENCODING_ISO8859_5   |   ?wxFONTENCODING_ISO8859_6   |  ?wx-
              FONTENCODING_ISO8859_7  |   ?wxFONTENCODING_ISO8859_8   |   ?wx-
              FONTENCODING_ISO8859_9   |   ?wxFONTENCODING_ISO8859_10  |  ?wx-
              FONTENCODING_ISO8859_11  |  ?wxFONTENCODING_ISO8859_12  |   ?wx-
              FONTENCODING_ISO8859_13   |  ?wxFONTENCODING_ISO8859_14  |  ?wx-
              FONTENCODING_ISO8859_15  |  ?wxFONTENCODING_ISO8859_MAX  |  ?wx-
              FONTENCODING_KOI8 | ?wxFONTENCODING_KOI8_U | ?wxFONTENCODING_AL-
              TERNATIVE | ?wxFONTENCODING_BULGARIAN | ?wxFONTENCODING_CP437  |
              ?wxFONTENCODING_CP850  |  ?wxFONTENCODING_CP852  | ?wxFONTENCOD-
              ING_CP855 | ?wxFONTENCODING_CP866 | ?wxFONTENCODING_CP874 | ?wx-
              FONTENCODING_CP932   |   ?wxFONTENCODING_CP936  |  ?wxFONTENCOD-
              ING_CP949 |  ?wxFONTENCODING_CP950  |  ?wxFONTENCODING_CP1250  |
              ?wxFONTENCODING_CP1251  | ?wxFONTENCODING_CP1252 | ?wxFONTENCOD-
              ING_CP1253 | ?wxFONTENCODING_CP1254 |  ?wxFONTENCODING_CP1255  |
              ?wxFONTENCODING_CP1256  | ?wxFONTENCODING_CP1257 | ?wxFONTENCOD-
              ING_CP12_MAX |  ?wxFONTENCODING_UTF7  |  ?wxFONTENCODING_UTF8  |
              ?wxFONTENCODING_EUC_JP | ?wxFONTENCODING_UTF16BE | ?wxFONTENCOD-
              ING_UTF16LE | ?wxFONTENCODING_UTF32BE |  ?wxFONTENCODING_UTF32LE
              |  ?wxFONTENCODING_MACROMAN | ?wxFONTENCODING_MACJAPANESE | ?wx-
              FONTENCODING_MACCHINESETRAD | ?wxFONTENCODING_MACKOREAN  |  ?wx-
              FONTENCODING_MACARABIC   |   ?wxFONTENCODING_MACHEBREW   |  ?wx-
              FONTENCODING_MACGREEK  |  ?wxFONTENCODING_MACCYRILLIC   |   ?wx-
              FONTENCODING_MACDEVANAGARI  | ?wxFONTENCODING_MACGURMUKHI | ?wx-
              FONTENCODING_MACGUJARATI  |  ?wxFONTENCODING_MACORIYA   |   ?wx-
              FONTENCODING_MACBENGALI   |   ?wxFONTENCODING_MACTAMIL   |  ?wx-
              FONTENCODING_MACTELUGU  |  ?wxFONTENCODING_MACKANNADA   |   ?wx-
              FONTENCODING_MACMALAJALAM  | ?wxFONTENCODING_MACSINHALESE | ?wx-
              FONTENCODING_MACBURMESE  |   ?wxFONTENCODING_MACKHMER   |   ?wx-
              FONTENCODING_MACTHAI   |   ?wxFONTENCODING_MACLAOTIAN   |   ?wx-
              FONTENCODING_MACGEORGIAN |  ?wxFONTENCODING_MACARMENIAN  |  ?wx-
              FONTENCODING_MACCHINESESIMP  | ?wxFONTENCODING_MACTIBETAN | ?wx-
              FONTENCODING_MACMONGOLIAN | ?wxFONTENCODING_MACETHIOPIC  |  ?wx-
              FONTENCODING_MACCENTRALEUR   |  ?wxFONTENCODING_MACVIATNAMESE  |
              ?wxFONTENCODING_MACARABICEXT | ?wxFONTENCODING_MACSYMBOL |  ?wx-
              FONTENCODING_MACDINGBATS  |  ?wxFONTENCODING_MACTURKISH  |  ?wx-
              FONTENCODING_MACCROATIAN | ?wxFONTENCODING_MACICELANDIC  |  ?wx-
              FONTENCODING_MACROMANIAN   |  ?wxFONTENCODING_MACCELTIC  |  ?wx-
              FONTENCODING_MACGAELIC  |  ?wxFONTENCODING_MACKEYBOARD  |   ?wx-
              FONTENCODING_MAX | ?wxFONTENCODING_MACMIN | ?wxFONTENCODING_MAC-
              MAX  |  ?wxFONTENCODING_UTF16  |  ?wxFONTENCODING_UTF32  |  ?wx-
              FONTENCODING_UNICODE  |  ?wxFONTENCODING_GB2312  | ?wxFONTENCOD-
              ING_BIG5 | ?wxFONTENCODING_SHIFT_JIS
              Family = ?wxFONTFAMILY_DEFAULT | ?wxFONTFAMILY_DECORATIVE | ?wx-
              FONTFAMILY_ROMAN  | ?wxFONTFAMILY_SCRIPT | ?wxFONTFAMILY_SWISS |
              ?wxFONTFAMILY_MODERN  |  ?wxFONTFAMILY_TELETYPE  |   ?wxFONTFAM-
              ILY_MAX | ?wxFONTFAMILY_UNKNOWN
              Style   =   ?wxFONTSTYLE_NORMAL  |  ?wxFONTSTYLE_ITALIC  |  ?wx-
              FONTSTYLE_SLANT | ?wxFONTSTYLE_MAX

       isFixedWidth(This) -> boolean()

              Types:

                 This = wxFont()

              See external documentation.

       getDefaultEncoding() -> wx:wx_enum()

              See external documentation.
              Res = ?wxFONTENCODING_SYSTEM |  ?wxFONTENCODING_DEFAULT  |  ?wx-
              FONTENCODING_ISO8859_1   |   ?wxFONTENCODING_ISO8859_2   |  ?wx-
              FONTENCODING_ISO8859_3  |   ?wxFONTENCODING_ISO8859_4   |   ?wx-
              FONTENCODING_ISO8859_5   |   ?wxFONTENCODING_ISO8859_6   |  ?wx-
              FONTENCODING_ISO8859_7  |   ?wxFONTENCODING_ISO8859_8   |   ?wx-
              FONTENCODING_ISO8859_9   |   ?wxFONTENCODING_ISO8859_10  |  ?wx-
              FONTENCODING_ISO8859_11  |  ?wxFONTENCODING_ISO8859_12  |   ?wx-
              FONTENCODING_ISO8859_13   |  ?wxFONTENCODING_ISO8859_14  |  ?wx-
              FONTENCODING_ISO8859_15  |  ?wxFONTENCODING_ISO8859_MAX  |  ?wx-
              FONTENCODING_KOI8 | ?wxFONTENCODING_KOI8_U | ?wxFONTENCODING_AL-
              TERNATIVE | ?wxFONTENCODING_BULGARIAN | ?wxFONTENCODING_CP437  |
              ?wxFONTENCODING_CP850  |  ?wxFONTENCODING_CP852  | ?wxFONTENCOD-
              ING_CP855 | ?wxFONTENCODING_CP866 | ?wxFONTENCODING_CP874 | ?wx-
              FONTENCODING_CP932   |   ?wxFONTENCODING_CP936  |  ?wxFONTENCOD-
              ING_CP949 |  ?wxFONTENCODING_CP950  |  ?wxFONTENCODING_CP1250  |
              ?wxFONTENCODING_CP1251  | ?wxFONTENCODING_CP1252 | ?wxFONTENCOD-
              ING_CP1253 | ?wxFONTENCODING_CP1254 |  ?wxFONTENCODING_CP1255  |
              ?wxFONTENCODING_CP1256  | ?wxFONTENCODING_CP1257 | ?wxFONTENCOD-
              ING_CP12_MAX |  ?wxFONTENCODING_UTF7  |  ?wxFONTENCODING_UTF8  |
              ?wxFONTENCODING_EUC_JP | ?wxFONTENCODING_UTF16BE | ?wxFONTENCOD-
              ING_UTF16LE | ?wxFONTENCODING_UTF32BE |  ?wxFONTENCODING_UTF32LE
              |  ?wxFONTENCODING_MACROMAN | ?wxFONTENCODING_MACJAPANESE | ?wx-
              FONTENCODING_MACCHINESETRAD | ?wxFONTENCODING_MACKOREAN  |  ?wx-
              FONTENCODING_MACARABIC   |   ?wxFONTENCODING_MACHEBREW   |  ?wx-
              FONTENCODING_MACGREEK  |  ?wxFONTENCODING_MACCYRILLIC   |   ?wx-
              FONTENCODING_MACDEVANAGARI  | ?wxFONTENCODING_MACGURMUKHI | ?wx-
              FONTENCODING_MACGUJARATI  |  ?wxFONTENCODING_MACORIYA   |   ?wx-
              FONTENCODING_MACBENGALI   |   ?wxFONTENCODING_MACTAMIL   |  ?wx-
              FONTENCODING_MACTELUGU  |  ?wxFONTENCODING_MACKANNADA   |   ?wx-
              FONTENCODING_MACMALAJALAM  | ?wxFONTENCODING_MACSINHALESE | ?wx-
              FONTENCODING_MACBURMESE  |   ?wxFONTENCODING_MACKHMER   |   ?wx-
              FONTENCODING_MACTHAI   |   ?wxFONTENCODING_MACLAOTIAN   |   ?wx-
              FONTENCODING_MACGEORGIAN |  ?wxFONTENCODING_MACARMENIAN  |  ?wx-
              FONTENCODING_MACCHINESESIMP  | ?wxFONTENCODING_MACTIBETAN | ?wx-
              FONTENCODING_MACMONGOLIAN | ?wxFONTENCODING_MACETHIOPIC  |  ?wx-
              FONTENCODING_MACCENTRALEUR   |  ?wxFONTENCODING_MACVIATNAMESE  |
              ?wxFONTENCODING_MACARABICEXT | ?wxFONTENCODING_MACSYMBOL |  ?wx-
              FONTENCODING_MACDINGBATS  |  ?wxFONTENCODING_MACTURKISH  |  ?wx-
              FONTENCODING_MACCROATIAN | ?wxFONTENCODING_MACICELANDIC  |  ?wx-
              FONTENCODING_MACROMANIAN   |  ?wxFONTENCODING_MACCELTIC  |  ?wx-
              FONTENCODING_MACGAELIC  |  ?wxFONTENCODING_MACKEYBOARD  |   ?wx-
              FONTENCODING_MAX | ?wxFONTENCODING_MACMIN | ?wxFONTENCODING_MAC-
              MAX  |  ?wxFONTENCODING_UTF16  |  ?wxFONTENCODING_UTF32  |  ?wx-
              FONTENCODING_UNICODE  |  ?wxFONTENCODING_GB2312  | ?wxFONTENCOD-
              ING_BIG5 | ?wxFONTENCODING_SHIFT_JIS

       getFaceName(This) -> unicode:charlist()

              Types:

                 This = wxFont()

              See external documentation.

       getFamily(This) -> wx:wx_enum()

              Types:

                 This = wxFont()

              See external documentation.
              Res = ?wxFONTFAMILY_DEFAULT |  ?wxFONTFAMILY_DECORATIVE  |  ?wx-
              FONTFAMILY_ROMAN  | ?wxFONTFAMILY_SCRIPT | ?wxFONTFAMILY_SWISS |
              ?wxFONTFAMILY_MODERN  |  ?wxFONTFAMILY_TELETYPE  |   ?wxFONTFAM-
              ILY_MAX | ?wxFONTFAMILY_UNKNOWN

       getNativeFontInfoDesc(This) -> unicode:charlist()

              Types:

                 This = wxFont()

              See external documentation.

       getNativeFontInfoUserDesc(This) -> unicode:charlist()

              Types:

                 This = wxFont()

              See external documentation.

       getPointSize(This) -> integer()

              Types:

                 This = wxFont()

              See external documentation.

       getStyle(This) -> wx:wx_enum()

              Types:

                 This = wxFont()

              See external documentation.
              Res   =   ?wxFONTSTYLE_NORMAL   |   ?wxFONTSTYLE_ITALIC  |  ?wx-
              FONTSTYLE_SLANT | ?wxFONTSTYLE_MAX

       getUnderlined(This) -> boolean()

              Types:

                 This = wxFont()

              See external documentation.

       getWeight(This) -> integer()

              Types:

                 This = wxFont()

              See external documentation.

       ok(This) -> boolean()

              Types:

                 This = wxFont()

              See external documentation.

       setDefaultEncoding(Encoding) -> ok

              Types:

                 Encoding = wx:wx_enum()

              See external documentation.
              Encoding = ?wxFONTENCODING_SYSTEM  |  ?wxFONTENCODING_DEFAULT  |
              ?wxFONTENCODING_ISO8859_1  |  ?wxFONTENCODING_ISO8859_2  |  ?wx-
              FONTENCODING_ISO8859_3  |   ?wxFONTENCODING_ISO8859_4   |   ?wx-
              FONTENCODING_ISO8859_5   |   ?wxFONTENCODING_ISO8859_6   |  ?wx-
              FONTENCODING_ISO8859_7  |   ?wxFONTENCODING_ISO8859_8   |   ?wx-
              FONTENCODING_ISO8859_9   |   ?wxFONTENCODING_ISO8859_10  |  ?wx-
              FONTENCODING_ISO8859_11  |  ?wxFONTENCODING_ISO8859_12  |   ?wx-
              FONTENCODING_ISO8859_13   |  ?wxFONTENCODING_ISO8859_14  |  ?wx-
              FONTENCODING_ISO8859_15  |  ?wxFONTENCODING_ISO8859_MAX  |  ?wx-
              FONTENCODING_KOI8 | ?wxFONTENCODING_KOI8_U | ?wxFONTENCODING_AL-
              TERNATIVE | ?wxFONTENCODING_BULGARIAN | ?wxFONTENCODING_CP437  |
              ?wxFONTENCODING_CP850  |  ?wxFONTENCODING_CP852  | ?wxFONTENCOD-
              ING_CP855 | ?wxFONTENCODING_CP866 | ?wxFONTENCODING_CP874 | ?wx-
              FONTENCODING_CP932   |   ?wxFONTENCODING_CP936  |  ?wxFONTENCOD-
              ING_CP949 |  ?wxFONTENCODING_CP950  |  ?wxFONTENCODING_CP1250  |
              ?wxFONTENCODING_CP1251  | ?wxFONTENCODING_CP1252 | ?wxFONTENCOD-
              ING_CP1253 | ?wxFONTENCODING_CP1254 |  ?wxFONTENCODING_CP1255  |
              ?wxFONTENCODING_CP1256  | ?wxFONTENCODING_CP1257 | ?wxFONTENCOD-
              ING_CP12_MAX |  ?wxFONTENCODING_UTF7  |  ?wxFONTENCODING_UTF8  |
              ?wxFONTENCODING_EUC_JP | ?wxFONTENCODING_UTF16BE | ?wxFONTENCOD-
              ING_UTF16LE | ?wxFONTENCODING_UTF32BE |  ?wxFONTENCODING_UTF32LE
              |  ?wxFONTENCODING_MACROMAN | ?wxFONTENCODING_MACJAPANESE | ?wx-
              FONTENCODING_MACCHINESETRAD | ?wxFONTENCODING_MACKOREAN  |  ?wx-
              FONTENCODING_MACARABIC   |   ?wxFONTENCODING_MACHEBREW   |  ?wx-
              FONTENCODING_MACGREEK  |  ?wxFONTENCODING_MACCYRILLIC   |   ?wx-
              FONTENCODING_MACDEVANAGARI  | ?wxFONTENCODING_MACGURMUKHI | ?wx-
              FONTENCODING_MACGUJARATI  |  ?wxFONTENCODING_MACORIYA   |   ?wx-
              FONTENCODING_MACBENGALI   |   ?wxFONTENCODING_MACTAMIL   |  ?wx-
              FONTENCODING_MACTELUGU  |  ?wxFONTENCODING_MACKANNADA   |   ?wx-
              FONTENCODING_MACMALAJALAM  | ?wxFONTENCODING_MACSINHALESE | ?wx-
              FONTENCODING_MACBURMESE  |   ?wxFONTENCODING_MACKHMER   |   ?wx-
              FONTENCODING_MACTHAI   |   ?wxFONTENCODING_MACLAOTIAN   |   ?wx-
              FONTENCODING_MACGEORGIAN |  ?wxFONTENCODING_MACARMENIAN  |  ?wx-
              FONTENCODING_MACCHINESESIMP  | ?wxFONTENCODING_MACTIBETAN | ?wx-
              FONTENCODING_MACMONGOLIAN | ?wxFONTENCODING_MACETHIOPIC  |  ?wx-
              FONTENCODING_MACCENTRALEUR   |  ?wxFONTENCODING_MACVIATNAMESE  |
              ?wxFONTENCODING_MACARABICEXT | ?wxFONTENCODING_MACSYMBOL |  ?wx-
              FONTENCODING_MACDINGBATS  |  ?wxFONTENCODING_MACTURKISH  |  ?wx-
              FONTENCODING_MACCROATIAN | ?wxFONTENCODING_MACICELANDIC  |  ?wx-
              FONTENCODING_MACROMANIAN   |  ?wxFONTENCODING_MACCELTIC  |  ?wx-
              FONTENCODING_MACGAELIC  |  ?wxFONTENCODING_MACKEYBOARD  |   ?wx-
              FONTENCODING_MAX | ?wxFONTENCODING_MACMIN | ?wxFONTENCODING_MAC-
              MAX  |  ?wxFONTENCODING_UTF16  |  ?wxFONTENCODING_UTF32  |  ?wx-
              FONTENCODING_UNICODE  |  ?wxFONTENCODING_GB2312  | ?wxFONTENCOD-
              ING_BIG5 | ?wxFONTENCODING_SHIFT_JIS

       setFaceName(This, FaceName) -> boolean()

              Types:

                 This = wxFont()
                 FaceName = unicode:chardata()

              See external documentation.

       setFamily(This, Family) -> ok

              Types:

                 This = wxFont()
                 Family = wx:wx_enum()

              See external documentation.
              Family = ?wxFONTFAMILY_DEFAULT | ?wxFONTFAMILY_DECORATIVE | ?wx-
              FONTFAMILY_ROMAN  | ?wxFONTFAMILY_SCRIPT | ?wxFONTFAMILY_SWISS |
              ?wxFONTFAMILY_MODERN  |  ?wxFONTFAMILY_TELETYPE  |   ?wxFONTFAM-
              ILY_MAX | ?wxFONTFAMILY_UNKNOWN

       setPointSize(This, PointSize) -> ok

              Types:

                 This = wxFont()
                 PointSize = integer()

              See external documentation.

       setStyle(This, Style) -> ok

              Types:

                 This = wxFont()
                 Style = wx:wx_enum()

              See external documentation.
              Style   =   ?wxFONTSTYLE_NORMAL  |  ?wxFONTSTYLE_ITALIC  |  ?wx-
              FONTSTYLE_SLANT | ?wxFONTSTYLE_MAX

       setUnderlined(This, Underlined) -> ok

              Types:

                 This = wxFont()
                 Underlined = boolean()

              See external documentation.

       setWeight(This, Weight) -> ok

              Types:

                 This = wxFont()
                 Weight = integer()

              See external documentation.

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

              Destroys this object, do not use object again

AUTHORS
       <>

                                   wx 1.9.1                       wxFont(3erl)

Man(1) output converted with man2html
list of all man pages