Class: Wx::PG::NumericProperty

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 numeric properties, like IntProperty, UIntProperty, FloatProperty.

Supported special attributes:

Requires:

  • USE_PROPGRID

Direct Known Subclasses

FloatProperty, IntProperty, UIntProperty

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_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_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::NumericProperty (protected)

Constructor is protected because Wx::PG::NumericProperty is only a base class for other numeric property classes.

Parameters:

  • label (String)
  • name (String) 


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

def initialize(label, name) end

Instance Method Details

#add_spin_step_value(stepScale) ⇒ Wx::Variant

Returns what would be the new value of the property after adding SpinCtrl editor step to the current value.

Current value range and wrapping (if enabled) are taken into account. This member has to be implemented in derived properties.

Value which property would have after adding SpinCtrl editor step.

Remark:

Current property value is not changed.

Parameters:

  • stepScale (Integer) —

    SpinCtrl editor step is first multiplied by this factor and next added to the current value.

Returns:



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

def add_spin_step_value(stepScale) 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) 


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

def do_set_attribute(name, value) end

#max_val_ ⇒ Wx::Variant

Returns:



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

def max_val_; end

#max_val_=(val) ⇒ void

This method returns an undefined value.

Parameters:



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

def max_val_=(val); end

#min_val_ ⇒ Wx::Variant

Returns:



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

def min_val_; end

#min_val_=(val) ⇒ void

This method returns an undefined value.

Parameters:



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

def min_val_=(val); end

#spin_motion_ ⇒ Boolean

Returns:

  • (Boolean) 


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

def spin_motion_; end

#spin_motion_=(val) ⇒ void

This method returns an undefined value.

Parameters:

  • val (Boolean) 


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

def spin_motion_=(val); end

#spin_step_ ⇒ Wx::Variant

Returns:



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

def spin_step_; end

#spin_step_=(val) ⇒ void

This method returns an undefined value.

Parameters:



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

def spin_step_=(val); end

#spin_wrap_ ⇒ Boolean

Returns:

  • (Boolean) 


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

def spin_wrap_; end

#spin_wrap_=(val) ⇒ void

This method returns an undefined value.

Parameters:

  • val (Boolean) 


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

def spin_wrap_=(val); end

#use_spin_motion ⇒ Boolean

Return true if value can be changed with SpinCtrl editor by moving the mouse.

Returns:

  • (Boolean) 


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

def use_spin_motion; end

#value_ ⇒ Wx::Variant

Returns:



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

def value_; end

#value_=(val) ⇒ void

This method returns an undefined value.

Parameters:



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

def value_=(val); end