Class: Wx::PG::ArrayStringProperty

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

Overview

Property that manages a list of strings.

Supported special attributes:

Requires:

  • USE_PROPGRID

Defined Under Namespace

Classes: ConversionFlags

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from EditorDialogProperty

#dlg_style_, #dlg_style_=, #dlg_title_, #dlg_title_=, #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, #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::ArrayString.new())) ⇒ Wx::PG::ArrayStringProperty

Parameters:

  • label (String) (defaults to: Wx::PG::PG_LABEL)
  • name (String) (defaults to: Wx::PG::PG_LABEL)
  • value (Array<String>) (defaults to: (Wx::ArrayString.new())) 


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

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

Class Method Details

.array_string_to_string(src, delimiter, flags) ⇒ String

Generates string based on the contents of ArrayString src.

Parameters:

  • src (Array<String>)
  • delimiter (String)
  • flags (Integer)

Returns:

  • (String) 


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

def self.array_string_to_string(src, delimiter, flags) end

Instance Method Details

#convert_array_to_string(arr, delimiter) ⇒ String

Implement in derived class for custom array-to-string conversion.

Parameters:

  • arr (Array<String>)
  • delimiter (String)

Returns:

  • (String) 


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

def convert_array_to_string(arr, delimiter) end

#create_editor_dialog ⇒ Wx::PG::PGArrayEditorDialog

Creates PGArrayEditorDialog for string editing.

Returns:



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

def create_editor_dialog; end

#custom_btn_text_ ⇒ String

Returns:

  • (String) 


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

def custom_btn_text_; end

#custom_btn_text_=(val) ⇒ void

This method returns an undefined value.

Parameters:

  • val (String) 


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

def custom_btn_text_=(val); end

#delimiter_ ⇒ String

Returns:

  • (String) 


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

def delimiter_; end

#delimiter_=(val) ⇒ void

This method returns an undefined value.

Parameters:

  • val (String) 


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

def delimiter_=(val); end

#display_ ⇒ String

Returns:

  • (String) 


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

def display_; end

#display_=(val) ⇒ void

This method returns an undefined value.

Parameters:

  • val (String) 


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

def display_=(val); 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) 


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

def display_editor_dialog(pg, value) end

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

Remark:

To actually set property attribute values from the application, use PGProperty#set_attribute instead.

Parameters:

Returns:

  • (Boolean) 


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

def do_set_attribute(name, value) end

#on_custom_string_edit(parent) ⇒ String

Shows string editor dialog to edit the individual item.

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 if that was the case.

Parameters:

Returns:

  • (String) 


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

def on_custom_string_edit(parent) 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. 



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

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.

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:

  • variant (Wx::Variant) —

    On function entry this is the old value (should not be NullVariant in normal cases). Translated value must be assigned back to it.

  • text (String) —

    Text to be translated into variant.

  • argFlags (Integer) (defaults to: 0) —

    If PG_MISC_ARG_FLAGS::PG_FULL_VALUE is set, returns complete, storable value instead of displayable one (they may be different). If PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT is set, text is interpreted as a part of composite property string value (as generated by #value_to_string called with this same flag).

Returns:

  • (Boolean) 


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

def string_to_value(variant, text, argFlags=0) end

#value_ ⇒ Wx::Variant

Returns:



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

def value_; end

#value_=(val) ⇒ void

This method returns an undefined value.

Parameters:



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

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) 


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

def value_to_string(value, argFlags=0) end