IDLgrFont

A font object represents a typeface, style, weight, and point size that may be associated with text objects.

Superclasses

This class has no superclass.

Subclasses

This class has no subclasses.

Creation

See IDLgrFont::Init

Methods

Intrinsic Methods

This class has the following methods:


IDLgrFont::Cleanup

The IDLgrFont:: Cleanup procedure method performs all cleanup on the object. IDLgrFont is described above.

Calling Sequence

OBJ_DESTROY, Obj

or

Obj -> [IDLgrFont::] Cleanup                               ( In a subclass' Cleanup method only .)

Arguments

There are no arguments for this method.

Keywords

There are no keywords for this method.


IDLgrFont::GetProperty

The IDLgrFont:: GetProperty procedure method retrieves the value of a property or group of properties for the font. IDLgrFont is described above.

Calling Sequence

Obj -> [IDLgrFont:] GetProperty

Arguments

There are no arguments for this method.

Keywords

Any keyword to IDLgrFont::Init

ALL

Set this keyword to a named variable that will contain an anonymous structure containing the values of all of the properties associated with the state of this object. State information about the object includes things like color, range, tick direction, etc., but not image, vertex, or connectivity data, or user values.


IDLgrFont::Init

The IDLgrFont:: Init function method initializes the font object. IDLgrFont is described above.

Calling Sequence

Obj = OBJ_NEW('IDLgrFont' [, Fontname] )

or

Result = Obj -> [IDLgrFont::] Init( [Fontname] )         ( In a subclass' Init method only .)

Arguments

Fontname

A string representing the name of the font to be used. This string should take the form 'fontname*modifier1*modifier2*...*modifierN'. All destination objects support the following fontnames: Helvetica, Courier, Times, Symbol. (These fonts are included with IDL; you may have other fonts installed on your system as well.) Valid modifiers for each of these fonts (except Symbol) are:

To select a Hershey font, use a fontname of the form: 'Hershey*fontnum'.

See Fonts in the IDL Reference Guide for further information and a list of fonts supported by IDL.

Keywords

Properties retrievable via IDLgrFont::GetProperty

NAME (Get, Set)

Set this keyword equal to a string containing the name of the font to use. Setting the NAME keyword is the same as supplying the Fontname argument described above.

SIZE (Get, Set)

Set this keyword equal to a floating-point integer representing the point size of the font. The default is 12.0 points.

SUBSTITUTE (Get, Set)

Set this keyword to a string that indicates the font to use as a substitute if the specified Fontname is not available on the graphics destination. Valid values are only those fonts that are available on all destination objects (the fonts included with IDL). These are: 'Helvetica' (the default), 'Courier', 'Times', 'Symbol', or 'Hershey'.

THICK (Get, Set)

Set this keyword to an integer value between 1 and 10, indicating the line thickness (measured in device units) to use for the Hershey vector fonts. The default is one pixel.

UVALUE (Get, Set)

Set this keyword to a value of any type. You can use this "user value" to contain any information you wish. Remember that if you set the user value equal to a pointer or object reference, you should destroy the pointer or object reference explicitly when destroying the object it is a user value of.


IDLgrFont::SetProperty

The IDLgrFont:: SetProperty procedure method sets the value of a property or group of properties for the font. IDLgrFont is described above.

Calling Sequence

Obj -> [IDLgrFont:] SetProperty

Arguments

There are no arguments for this method.

Keywords

Any keyword to IDLgrFont::Init