Class: Wx::PG::IntProperty

Inherits:

NumericProperty

• Object
• Object
• PGProperty
• NumericProperty
• Wx::PG::IntProperty

Defined in:

lib/wx/doc/gen/pg/pg_properties.rb

Overview

Basic property with integer value.

Supported special attributes: - PG_ATTR_MIN, PG_ATTR_MAX, PG_ATTR_SPINCTRL_STEP, PG_ATTR_SPINCTRL_WRAP, PG_ATTR_SPINCTRL_MOTION: like in NumericProperty.

Requires:

• USE_PROPGRID

Class Method Summary

• .get_class_validator ⇒ Wx::Validator

Instance Method Summary

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

• #do_get_validator ⇒ Wx::Validator

  Returns pointer to the Validator that should be used with the editor of this property (NULL for no validator).

• #initialize(*args) ⇒ IntProperty constructor

  A new instance of IntProperty.

• #int_to_value(variant, number, argFlags = 0) ⇒ Boolean

  Converts integer (possibly a choice selection) into Variant value appropriate for this property.

• #max_val_ ⇒ Wx::Variant
• #max_val_=(val) ⇒ void
• #min_val_ ⇒ Wx::Variant
• #min_val_=(val) ⇒ void
• #spin_motion_ ⇒ Boolean
• #spin_motion_=(val) ⇒ void
• #spin_step_ ⇒ Wx::Variant
• #spin_step_=(val) ⇒ void
• #spin_wrap_ ⇒ Boolean
• #spin_wrap_=(val) ⇒ void
• #string_to_value(variant, text, argFlags = 0) ⇒ Boolean

  Converts text into Variant value appropriate for this property.

• #validate_value(value, validationInfo) ⇒ Boolean

  Implement this function in derived class to check the value.

• #value_ ⇒ Wx::Variant
• #value_=(val) ⇒ void
• #value_to_string(value, argFlags = 0) ⇒ String

  Converts property value into a text representation.

Methods inherited from NumericProperty

#do_set_attribute, #use_spin_motion

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_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_flag, #has_flags_exact, #has_visible_children, #hide, #index, #insert_child, #insert_choice, #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, #update_parent_values, #uses_auto_unspecified

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 = 0) ⇒ Wx::PG::IntProperty #initialize(label, name, value) ⇒ Wx::PG::IntProperty

Returns a new instance of IntProperty.

Overloads:

• #initialize(label = Wx::PG::PG_LABEL, name = Wx::PG::PG_LABEL, value = 0) ⇒ Wx::PG::IntProperty

  Parameters:

  • label (String) (defaults to: Wx::PG::PG_LABEL)
  • name (String) (defaults to: Wx::PG::PG_LABEL)
  • value (Integer) (defaults to: 0)
• #initialize(label, name, value) ⇒ Wx::PG::IntProperty

  Parameters:

  • label (String)
  • name (String)
  • value (Integer)

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

def initialize(*args) end

Class Method Details

.get_class_validator ⇒ Wx::Validator

Returns:

• (Wx::Validator)

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

def self.get_class_validator; 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:

• (Wx::Variant)

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

def add_spin_step_value(stepScale) end

#do_get_validator ⇒ Wx::Validator

Returns pointer to the Validator that should be used with the editor of this property (NULL for no validator).

Setting validator explicitly via #set_property_validator will override this. In most situations, code like this should work well:

class MyPropertyClass < Wx::PG::IntProperty

    class << self
      def validator
        @validator ||= MyValidator.new(...)
      end
    end

    # ...

    def do_get_validator
      MyPropertyClass.validator
    end

    # ...

  end

Remark:

You can get common filename validator by returning FileProperty.get_class_validator. DirProperty, for example, uses it.

Returns:

• (Wx::Validator)

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

def do_get_validator; end

#int_to_value(variant, number, argFlags = 0) ⇒ Boolean

Converts integer (possibly a choice selection) into Variant value appropriate for this property.

Returns true if resulting Variant value was different.

Remark:

- If property is not supposed to use choice or spinctrl or other editor with int-based value, it is not necessary to implement this method. - Default implementation simply assign given int to m_value. - If property uses choice control, and displays a dialog on some choice items, then it is preferred to display that dialog in IntToValue instead of OnEvent. - You might want to take into account that m_value is Mull 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.

• number (Integer) —

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

Returns:

• (Boolean)

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

def int_to_value(variant, number, argFlags=0) end

#max_val_ ⇒ Wx::Variant

Returns:

• (Wx::Variant)

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

def max_val_; end

#max_val_=(val) ⇒ void

This method returns an undefined value.

Parameters:

• val (nil, String, Integer, Float, Time, Wx::Font, Wx::Colour, Wx::Variant, Array<WxVariant>, Array<String>, ObjectWx::PG::ColourPropertyValue)

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

def max_val_=(val); end

#min_val_ ⇒ Wx::Variant

Returns:

• (Wx::Variant)

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

def min_val_; end

#min_val_=(val) ⇒ void

This method returns an undefined value.

Parameters:

• val (nil, String, Integer, Float, Time, Wx::Font, Wx::Colour, Wx::Variant, Array<WxVariant>, Array<String>, ObjectWx::PG::ColourPropertyValue)

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

def min_val_=(val); end

#spin_motion_ ⇒ Boolean

Returns:

• (Boolean)

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

def spin_motion_; end

#spin_motion_=(val) ⇒ void

This method returns an undefined value.

Parameters:

• val (Boolean)

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

def spin_motion_=(val); end

#spin_step_ ⇒ Wx::Variant

Returns:

• (Wx::Variant)

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

def spin_step_; end

#spin_step_=(val) ⇒ void

This method returns an undefined value.

Parameters:

• val (nil, String, Integer, Float, Time, Wx::Font, Wx::Colour, Wx::Variant, Array<WxVariant>, Array<String>, ObjectWx::PG::ColourPropertyValue)

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

def spin_step_=(val); end

#spin_wrap_ ⇒ Boolean

Returns:

• (Boolean)

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

def spin_wrap_; end

#spin_wrap_=(val) ⇒ void

This method returns an undefined value.

Parameters:

• val (Boolean)

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

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

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

def string_to_value(variant, text, argFlags=0) 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:

• value (Wx::Variant)
• validationInfo (Wx::PG::PGValidationInfo)

Returns:

• (Boolean)

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

def validate_value(value, validationInfo) end

#value_ ⇒ Wx::Variant

Returns:

• (Wx::Variant)

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

def value_; end

#value_=(val) ⇒ void

This method returns an undefined value.

Parameters:

• val (nil, String, Integer, Float, Time, Wx::Font, Wx::Colour, Wx::Variant, Array<WxVariant>, Array<String>, ObjectWx::PG::ColourPropertyValue)

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

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:

• value (Wx::Variant) —

  Value to be converted.

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

  If 0 (default value), then displayed string is returned. If PG_MISC_ARG_FLAGS::PG_FULL_VALUE is set, returns complete, storable string value instead of displayable. If PG_MISC_ARG_FLAGS::PG_EDITABLE_VALUE is set, returns string value that must be editable in textctrl. If PG_MISC_ARG_FLAGS::PG_COMPOSITE_FRAGMENT is set, returns text that is appropriate to display as a part of string property’s composite text representation.

Returns:

• (String)

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

def value_to_string(value, argFlags=0) end