class chooseFontDialog

superclass(es) object
subclass(es) -
description The chooseFontDialog class implements a standard "Select Font" dialog. With the dialog a specific font and it's properties can be choosen.

tasks

The method execute/2 can be used to show the "Select Font" dialog, after the dialog has been closed information about the selected font can be retrieved.

methods

size(Output)

func Get the choosen size of the font.
pre TRUE.
post The value of the choosen size is assigned to Output.

bold(Output)

func Determine if the font choosen must be displayed bold or normal.
pre TRUE.
post If the font must be displayed bold then true is assigned to the variable Output, else false is assigned.

italic(Output)

func Determine if the font must be displayed italic.
pre TRUE.
post If the font must be displayed italic then true is assigned to the variable Output, else false is assigned.

strikeout(Output)

func Determine if the font must be displayed strikeout.
pre TRUE.
post If the font must be displayed strikeout then true is assigned to the variable Output, else false is assigned.

underline(Output)

func Determine if the font must be displayed underlined or not.
pre TRUE.
post If the font must be displayed underlined then true is assigned to the variable Output, else false is assigned.

color(Red, Green, Blue)

func Get the selected color for the font. The Red, Green and Blue values of the color chosen are returned.
pre TRUE.
post The red, green and blue values of the color are assigned to the variables Red, Green and Blue.

name(Output)

func Get the name of the selected color.
pre TRUE.
post The name of the selected font was assigned to Output.

fixedPitch(Output)

func Check if the selected font is a fixed pitch font or not. If the font is a fixed pitch font then all characters have the same width.
pre TRUE.
post If the font was a fixed pitch font then true was unified with Output, else the value false.

putFont(FontInstance)

func Set the font of which the properties will be displayed if the font dialog is opened.
pre The value of the parameter FontInstance must refer to an instance of the class font.
post If the dialog is opened all the relevant properties of the dialog are the same as those of the font instance.

font(OutputFontInstance)

func Collect all properties selected by the user and apply them to the font instance that is unified with the parameter OutputFontInstance.
pre TRUE
post The returned font instance contains all properties selected by the user of a dialog.

putFontSelectOptions(Effects, OnlyFixedPitch, OnlyTrueType, PrinterFonts, ScreenFonts)

func Set properties of the font dialog. If the value of the Effects parameter is false then it is not possible to select the underline, strikethrough or color properties for a font. If OnlyFixedPitch is true then the list of fonts will only display fonts with characters that all have the same pixel width. If OnlyTrueType is true then no fixed pitch or printer fonts will be in the list of available fonts. If PrinterFonts is true then fonts installed on a printer are displayed, if ScreenFonts is true then only fonts available for the screen are displayed.
pre All parameters must be boolean values.
post The next time the dialog is opened it will have adapted itself to the options.

execute(Parent, Output)

func Show the "Select Font" dialog.
pre The Parent variable must refer to a window or an empty variable.
post If the dialog was closed by pressing on the "OK" button then true is assigned to Output, else false is assigned to Output.

execute(Parent, Canvas, Output)

func Show the "Select Font" dialog, the font dialog will adapt itself to the type of canvas and the capabilities of the output device connected to the canvas.
pre The Parent variable must refer to a window or an empty variable and Canvas must refer to an instance of the canvas class (or an empty variable).
post If the dialog was closed by pressing on the "OK" button then true is assigned to Output, else false is assigned to Output.