Class: Wx::FontData

Inherits:
Object show all
Defined in:
lib/wx/doc/gen/font_data.rb

Overview

Note:

This class is untracked and should not be derived from nor instances extended!

This class holds a variety of information related to font dialogs.

Category: Common Dialogs, Data Structures

See Also:

Requires:

  • USE_FONTDLG

Instance Method Summary collapse

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::FontData

Constructor.

Initializes fontColour to black, showHelp to false, allowSymbols to true, enableEffects to true, minSize to 0 and maxSize to 0.



26
 
# File 'lib/wx/doc/gen/font_data.rb', line 26

def initialize; end

Instance Method Details

#enable_effects(enable) ⇒ void

This method returns an undefined value.

Enables or disables “effects” under Windows or generic only.

This refers to the controls for manipulating colour, strikeout and underline properties. The default value is true.

Parameters:

  • enable (Boolean) 


34
 
# File 'lib/wx/doc/gen/font_data.rb', line 34

def enable_effects(enable) end

#get_allow_symbols ⇒ Boolean Also known as: allow_symbols

Under Windows, returns a flag determining whether symbol fonts can be selected.

Has no effect on other platforms. The default value is true.

Returns:

  • (Boolean) 


41
 
# File 'lib/wx/doc/gen/font_data.rb', line 41

def get_allow_symbols; end

#get_chosen_font ⇒ Wx::Font Also known as: chosen_font

Gets the font chosen by the user if the user pressed OK (Wx::FontDialog#show_modal returned StandardID::ID_OK).

Returns:



46
 
# File 'lib/wx/doc/gen/font_data.rb', line 46

def get_chosen_font; end

#get_colour ⇒ Wx::Colour, ... Also known as: colour

Gets the colour associated with the font dialog.

The default value is black.

Returns:



53
 
# File 'lib/wx/doc/gen/font_data.rb', line 53

def get_colour; end

#get_enable_effects ⇒ Boolean

Determines whether “effects” are enabled under Windows.

This refers to the controls for manipulating colour, strikeout and underline properties. The default value is true.

Returns:

  • (Boolean) 


61
 
# File 'lib/wx/doc/gen/font_data.rb', line 61

def get_enable_effects; end

#get_initial_font ⇒ Wx::Font Also known as: initial_font

Gets the font that will be initially used by the font dialog.

This should have previously been set by the application.

Returns:



79
 
# File 'lib/wx/doc/gen/font_data.rb', line 79

def get_initial_font; end

#get_restrict_selection ⇒ Integer

Returns the state of the flags restricting the selection.

Note that currently these flags are only effectively used in WXMSW.

The default value is Wx::FONTRESTRICT_NONE.

Returns:

  • (Integer) 


73
 
# File 'lib/wx/doc/gen/font_data.rb', line 73

def get_restrict_selection; end

#get_show_help ⇒ Boolean Also known as: show_help

Returns true if the Help button will be shown (Windows only).

The default value is false.

Returns:

  • (Boolean) 


86
 
# File 'lib/wx/doc/gen/font_data.rb', line 86

def get_show_help; end

#restrict_selection(flags) ⇒ void

This method returns an undefined value.

Restricts the selection to a subset of the available fonts.

Note that currently these flags are only effectively used in WXMSW and are ignored in the other ports. Possible values are:

The default value is Wx::FONTRESTRICT_NONE.

Parameters:

  • flags (Integer) 


101
 
# File 'lib/wx/doc/gen/font_data.rb', line 101

def restrict_selection(flags) end

#set_allow_symbols(allowSymbols) ⇒ void Also known as: allow_symbols=

This method returns an undefined value.

Under Windows, determines whether symbol fonts can be selected.

Has no effect on other platforms. The default value is true.

Parameters:

  • allowSymbols (Boolean) 


109
 
# File 'lib/wx/doc/gen/font_data.rb', line 109

def set_allow_symbols(allowSymbols) end

#set_chosen_font(font) ⇒ void Also known as: chosen_font=

This method returns an undefined value.

Sets the font that will be returned to the user (for internal use only).

Parameters:



115
 
# File 'lib/wx/doc/gen/font_data.rb', line 115

def set_chosen_font(font) end

#set_colour(colour) ⇒ void Also known as: colour=

This method returns an undefined value.

Sets the colour that will be used for the font foreground colour.

The default colour is black.

Parameters:



123
 
# File 'lib/wx/doc/gen/font_data.rb', line 123

def set_colour(colour) end

#set_initial_font(font) ⇒ void Also known as: initial_font=

This method returns an undefined value.

Sets the font that will be initially used by the font dialog.

Parameters:



129
 
# File 'lib/wx/doc/gen/font_data.rb', line 129

def set_initial_font(font) end

#set_range(min, max) ⇒ void

This method returns an undefined value.

Sets the valid range for the font point size (Windows only).

The default is 0, 0 (unrestricted range).

Parameters:

  • min (Integer)
  • max (Integer) 


138
 
# File 'lib/wx/doc/gen/font_data.rb', line 138

def set_range(min, max) end

#set_show_help(showHelp) ⇒ void Also known as: show_help=

This method returns an undefined value.

Determines whether the Help button will be displayed in the font dialog (Windows only).

The default value is false.

Parameters:

  • showHelp (Boolean) 


145
 
# File 'lib/wx/doc/gen/font_data.rb', line 145

def set_show_help(showHelp) end