Class: Wx::PG::EditEnumProperty

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

Overview

EnumProperty with String value and writable combo box editor.

Remark:

Uses int value, similar to EnumProperty, unless text entered by user is not in choices (in which case string value is used).

Requires:

  • USE_PROPGRID

Instance Method Summary collapse

Methods inherited from EnumProperty

#get_choice_selection, #get_index, #get_index_for_value, #get_item_count, #int_to_value, #set_index, #value_to_string

Methods inherited from PGProperty

#adapt_list_to_value, #add_choice, #add_private_child, #append_child, #are_all_children_specified, #are_children_components, #change_flag, #child_changed, #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_any_child, #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_children, #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, #update_parent_values, #uses_auto_unspecified, #value_to_string

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(label = Wx::PG::PG_LABEL, name = Wx::PG::PG_LABEL, labels = (Wx::ArrayString.new()), values = (Wx::ArrayInt.new()), value = ('')) ⇒ Wx::PG::EditEnumProperty #initialize(label, name, choices, value = ('')) ⇒ Wx::PG::EditEnumProperty

Returns a new instance of EditEnumProperty.

Overloads:

  • #initialize(label = Wx::PG::PG_LABEL, name = Wx::PG::PG_LABEL, labels = (Wx::ArrayString.new()), values = (Wx::ArrayInt.new()), value = ('')) ⇒ Wx::PG::EditEnumProperty

    Parameters:

    • label (String) (defaults to: Wx::PG::PG_LABEL)
    • name (String) (defaults to: Wx::PG::PG_LABEL)
    • labels (Array<String>) (defaults to: (Wx::ArrayString.new()))
    • values (Array<Integer>) (defaults to: (Wx::ArrayInt.new()))
    • value (String) (defaults to: (''))
  • #initialize(label, name, choices, value = ('')) ⇒ Wx::PG::EditEnumProperty

    Parameters:

    • label (String)
    • name (String)
    • choices (Wx::PG::PGChoices)
    • value (String) (defaults to: ('')) 


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

def initialize(*args) end

Instance Method Details

#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. 



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

def on_set_value; end

#string_to_value(variant, text, flags = PGPropValFormatFlags::Null) ⇒ Boolean

Converts text into Variant value appropriate for this property.

Returns true if resulting Variant value was different.

Remark:

Default implementation converts semicolon delimited tokens into child values. Only works for properties with children.

You might want to take into account that m_value is Null variant if property value is unspecified (which is usually only case if you explicitly enabled that sort behaviour).

Parameters:

Returns:

  • (Boolean) 


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

def string_to_value(variant, text, flags=PGPropValFormatFlags::Null) end

#validate_value(value, validationInfo) ⇒ Boolean

Implement this function in derived class to check the value.

Return true if it is ok. Returning false prevents property change events from occurring.

Remark:

- Default implementation always returns true.

Parameters:

Returns:

  • (Boolean) 


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

def validate_value(value, validationInfo) end

#value_ ⇒ Wx::Variant

Returns:



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

def value_; end

#value_=(val) ⇒ void

This method returns an undefined value.

Parameters:



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

def value_=(val); end