Class: Wx::PG::StringProperty
- Inherits:
-
PGProperty
- Object
- Object
- PGProperty
- Wx::PG::StringProperty
- Defined in:
- lib/wx/doc/gen/pg/pg_properties.rb
Overview
Basic property with string value.
Supported special attributes:
-
PG_STRING_PASSWORD: set to true in order to enable TE_PASSWORD on the editor.
- If value "
Instance Method Summary collapse
-
#do_set_attribute(name, value) ⇒ Boolean
Reimplement this member function to add special handling for attributes of this property.
- #initialize(label = Wx::PG::PG_LABEL, name = Wx::PG::PG_LABEL, value = ('')) ⇒ Wx::PG::StringProperty constructor
-
#on_set_value ⇒ void
This is updated so “<composed>” special value can be handled.
-
#string_to_value(variant, text, argFlags = 0) ⇒ Boolean
Converts text into Variant value appropriate for this property.
- #value_ ⇒ Wx::Variant
- #value_=(val) ⇒ void
-
#value_to_string(value, argFlags = 0) ⇒ String
Converts property value into a text representation.
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, #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_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, #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::PG::StringProperty
399 |
# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 399 def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=('')) end |
Instance Method Details
#do_set_attribute(name, value) ⇒ Boolean
Reimplement this member function to add special handling for attributes of this property.
Return false to have the attribute automatically stored in m_attributes. Default implementation simply does that and nothing else.
To actually set property attribute values from the application, use PGProperty#set_attribute instead.
442 |
# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 442 def do_set_attribute(name, value) end |
#on_set_value ⇒ void
This method returns an undefined value.
This is updated so “<composed>” special value can be handled.
446 |
# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 446 def on_set_value; end |
#string_to_value(variant, text, argFlags = 0) ⇒ Boolean
Converts text into Variant value appropriate for this property.
Returns true if resulting Variant value was different.
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).
428 |
# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 428 def string_to_value(variant, text, argFlags=0) end |
#value_=(val) ⇒ void
This method returns an undefined value.
454 |
# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 454 def value_=(val); end |
#value_to_string(value, argFlags = 0) ⇒ String
Converts property value into a text representation.
Default implementation calls PGProperty#generate_composed_value.
411 |
# File 'lib/wx/doc/gen/pg/pg_properties.rb', line 411 def value_to_string(value, argFlags=0) end |