Class: Wx::PG::EditorDialogProperty

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

Overview

This is an abstract class which serves as a base class for the properties having a button triggering an editor dialog, like e.g.

LongStringProperty, DirProperty, FileProperty. Supported special attributes:

Requires:

  • USE_PROPGRID

Instance Method Summary collapse

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_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_set_value, #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, #string_to_value, #update_parent_values, #uses_auto_unspecified, #validate_value, #value_to_string

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize(label, name) ⇒ Wx::PG::EditorDialogProperty (protected)

Constructor is protected because Wx::PG::EditorDialogProperty is only the base class for other property classes.

Parameters:

  • label (String)
  • name (String) 


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

def initialize(label, name) end

Instance Method Details

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


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

def display_editor_dialog(pg, value) end

#dlg_style_ ⇒ Integer

Returns:

  • (Integer) 


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

def dlg_style_; end

#dlg_style_=(val) ⇒ void

This method returns an undefined value.

Parameters:

  • val (Integer) 


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

def dlg_style_=(val); end

#dlg_title_ ⇒ String

Returns:

  • (String) 


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

def dlg_title_; end

#dlg_title_=(val) ⇒ void

This method returns an undefined value.

Parameters:

  • val (String) 


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

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


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

def do_set_attribute(name, value) end

#get_editor_dialog ⇒ Wx::PG::PGEditorDialogAdapter Also known as: editor_dialog

Returns instance of a new PGEditorDialogAdapter instance, which is used when user presses the (optional) button next to the editor control;.

Default implementation returns NULL (i.e. no action is generated when button is pressed).

Returns:



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

def get_editor_dialog; end

#value_ ⇒ Wx::Variant

Returns:



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

def value_; end

#value_=(val) ⇒ void

This method returns an undefined value.

Parameters:



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

def value_=(val); end