SIMPOL Documentation

wxfont

Description

A wxfont object represents a font definition that can be referenced by any of the wxformcontrol objects that provide text.

Type Tags

None

Object Value

wxfont.new()

Description

Creates a new wxfont object with the specified face name, point size and features.

Prototype

wxfont.new ( string facename, integer pointsize, string style, string weight, string decoration, integer error )

Parameters

ParameterDefault valueType nameDescription
facenameNonestring The face name of the new font, such as "Arial", or "Times".
pointsizeNoneinteger The size of the new font, in points.
style.nulstring The style of the new font. Use "i" for italic.
weight.nulstring The weight of the new font. Use "b" for bold.
decoration.nulstring The decoration of the new font. Use "u" for underlined and "s" for strikethrough.
error.nulinteger Specifies an object which is used to output any error code generated during creation of the wxfont object. If error is not specified or is .nul then any error which occurs during object creation will halt the program. If an error object is specified and an error occurs during object creation then the error code is output into that object and the new() method returns .nul.

Properties

PropertyTypeDescription
_type(*) This property is provided for use by the user to attach any object of any type to the type in which this property is provided.
__type(*) This property is provided for use by the user to attach any object of any type to the type in which this property is provided. It has the additional feature of being marked with the resolve keyword, so that object resolution can continue down this property.
decorationstring Gives the decoration of the font. The letter u stands for underlined. The letter s stands for strikethrough. The empty string implies no decoration. This could contain either s, u, both or the empty string.
facenamestring Gives the face name of the font.
pointsizeinteger Gives the size of the font, in points.
stylestring Gives the style of the font. The letter i stands for italic and the letter n stands for normal.
typetype Specifies the wxfont type object.
weightstring Gives the weight of the font. The letter b stands for bold, the letter l for light and the letter n for normal.