Class: Wx::PG::FontProperty

Inherits:
EditorDialogProperty show all
Defined in:
lib/wx/doc/gen/pg/pg_properties.rb

Overview

Property representing Font.

Supported special attributes:

  • PG_DIALOG_TITLE: Sets a specific title for the font dialog (since 3.1.3).

Requires:

  • USE_PROPGRID

Instance Method Summary collapse

Methods inherited from EditorDialogProperty

#dlg_style_, #dlg_style_=, #dlg_title_, #dlg_title_=, #do_set_attribute, #get_editor_dialog

Methods inherited from PGProperty

#adapt_list_to_value, #add_choice, #add_private_child, #append_child, #are_all_children_specified, #are_children_components, #change_flag, #clear_cells, #delete_children, #delete_choice, #do_get_attribute, #do_get_editor_class, #do_get_validator, #do_get_value, #do_set_attribute, #each_attribute, #empty, #enable, #enable_common_value, #ensure_cells, #generate_composed_value, #get_attribute, #get_attribute_as_double, #get_attribute_as_long, #get_attributes, #get_attributes_as_list, #get_base_name, #get_cell, #get_cell_or_default, #get_child_count, #get_children_height, #get_choice_selection, #get_choices, #get_client_object, #get_column_editor, #get_common_value, #get_default_value, #get_depth, #get_displayed_common_value_count, #get_displayed_string, #get_editor_class, #get_editor_dialog, #get_flags_as_string, #get_grid, #get_grid_if_displayed, #get_help_string, #get_hint_text, #get_image_offset, #get_index_in_parent, #get_item_at_y, #get_label, #get_last_visible_sub_item, #get_main_parent, #get_max_length, #get_name, #get_parent, #get_property_by_name, #get_property_by_name_wh, #get_validator, #get_value, #get_value_as_string, #get_value_image, #get_value_type, #get_y, #has_flag, #has_flags_exact, #has_visible_children, #hide, #index, #insert_child, #insert_choice, #int_to_value, #is_category, #is_child_selected, #is_enabled, #is_expanded, #is_root, #is_some_parent, #is_sub_property, #is_text_editable, #is_value_unspecified, #is_visible, #item, #last, #on_custom_paint, #on_event, #on_measure_image, #on_validation_failure, #recreate_editor, #refresh_editor, #set_attribute, #set_attributes, #set_auto_unspecified, #set_background_colour, #set_cell, #set_choice_selection, #set_choices, #set_client_object, #set_common_value, #set_default_colours, #set_default_value, #set_editor, #set_expanded, #set_flag_recursively, #set_flags_from_string, #set_help_string, #set_label, #set_max_length, #set_modified_status, #set_name, #set_parental_type, #set_text_colour, #set_validator, #set_value, #set_value_from_int, #set_value_from_string, #set_value_image, #set_value_in_event, #set_value_to_unspecified, #set_was_modified, #string_to_value, #update_parent_values, #uses_auto_unspecified, #validate_value

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(label = Wx::PG::PG_LABEL, name = Wx::PG::PG_LABEL, value = (Wx::Font.new())) ⇒ Wx::PG::FontProperty

Parameters:

  • label (String) (defaults to: Wx::PG::PG_LABEL)
  • name (String) (defaults to: Wx::PG::PG_LABEL)
  • value (Wx::Font, Wx::FontInfo) (defaults to: (Wx::Font.new())) 


1162
 
# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 1162

def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=(Wx::Font.new())) end

Instance Method Details

#child_changed(thisValue, childIndex, childValue) ⇒ Wx::Variant

Called after value of a child property has been altered.

Must return new value of the whole property (after any alterations warranted by child’s new value). Note that this function is usually called at the time that value of this property, or given child property, is still pending for change, and as such, result of PGProperty#get_value or m_value should not be relied on. Sample pseudo-code implementation:

class WxFontDataProperty < Wx::PG::FontProperty

    def child_changed(thisValue, childIndex, childValue)
      fontData = thisValue.object
      fontData.initial_font = fontData.chosen_font
      
      case childIndex
        when 6
          col = childValue.colour
          fontData.colour = col
        else
          # Transfer from subset to superset.
          font = fontData.chosen_font
          variant = Wx::Variant.new(font)
          variant = super(variant, childIndex, childValue)
          font = variant.font
          fontData.chosen_font = font
      end
      
      Wx::Variant.new(fontData)
    end

  end

Modified value of the whole property.

Parameters:

  • thisValue (Wx::Variant) —

    Value of this property. Changed value should be returned (in previous versions of PropertyGrid it was only necessary to write value back to this argument).

  • childIndex (Integer) —

    Index of child changed (you can use Item(childIndex) to get child property).

  • childValue (Wx::Variant) —

    (Pending) value of the child property.

Returns:



1228
 
# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 1228

def child_changed(thisValue, childIndex, childValue) end

#display_editor_dialog(pg, value) ⇒ Boolean (protected)

Shows editor dialog.

Value to be edited should be read from value, and if dialog is not cancelled, it should be stored back and true should be returned.

Returns true if editor dialog was not cancelled and value was updated.

Parameters:

Returns:

  • (Boolean) 


1255
 
# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 1255

def display_editor_dialog(pg, value) end

#on_set_value ⇒ void

This method returns an undefined value.

This virtual function is called after m_value has been set.

Remark:

- If m_value was set to Null variant (i.e. unspecified value), #on_set_value will not be called. - m_value may be of any variant type. Typically properties internally support only one variant type, and as such #on_set_value provides a good opportunity to convert supported values into internal type. - Default implementation does nothing. 



1177
 
# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 1177

def on_set_value; end

#refresh_children ⇒ void

This method returns an undefined value.

Refresh values of child properties.

Automatically called after value is set.



1234
 
# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 1234

def refresh_children; end

#value_ ⇒ Wx::Variant

Returns:



1238
 
# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 1238

def value_; end

#value_=(val) ⇒ void

This method returns an undefined value.

Parameters:



1242
 
# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 1242

def value_=(val); end

#value_to_string(value, argFlags = 0) ⇒ String

Converts property value into a text representation.

Remark:

Default implementation calls PGProperty#generate_composed_value.

Parameters:

Returns:

  • (String) 


1189
 
# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 1189

def value_to_string(value, argFlags=0) end