Class: Wx::PG::FloatProperty

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

Overview

Basic property with double-precision floating point value.

Supported special attributes:

Requires:

  • USE_PROPGRID

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from NumericProperty

#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, #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, #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.0) ⇒ Wx::PG::FloatProperty

Parameters:

  • label (String) (defaults to: Wx::PG::PG_LABEL)
  • name (String) (defaults to: Wx::PG::PG_LABEL)
  • value (Float) (defaults to: 0.0) 


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

def initialize(label=Wx::PG::PG_LABEL, name=Wx::PG::PG_LABEL, value=0.0) end

Class Method Details

.get_class_validator ⇒ Wx::Validator

Returns:



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

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:



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

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::FloatProperty

    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 Wx::PG::FileProperty.get_class_validator. DirProperty, for example, uses it.

Returns:



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

def do_get_validator; 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) 


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

def do_set_attribute(name, value) end

#max_val_ ⇒ Wx::Variant

Returns:



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

def max_val_; end

#max_val_=(val) ⇒ void

This method returns an undefined value.

Parameters:



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

def max_val_=(val); end

#min_val_ ⇒ Wx::Variant

Returns:



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

def min_val_; end

#min_val_=(val) ⇒ void

This method returns an undefined value.

Parameters:



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

def min_val_=(val); end

#precision_ ⇒ Integer

Returns:

  • (Integer) 


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

def precision_; end

#precision_=(val) ⇒ void

This method returns an undefined value.

Parameters:

  • val (Integer) 


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

def precision_=(val); end

#spin_motion_ ⇒ Boolean

Returns:

  • (Boolean) 


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

def spin_motion_; end

#spin_motion_=(val) ⇒ void

This method returns an undefined value.

Parameters:

  • val (Boolean) 


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

def spin_motion_=(val); end

#spin_step_ ⇒ Wx::Variant

Returns:



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

def spin_step_; end

#spin_step_=(val) ⇒ void

This method returns an undefined value.

Parameters:



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

def spin_step_=(val); end

#spin_wrap_ ⇒ Boolean

Returns:

  • (Boolean) 


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

def spin_wrap_; end

#spin_wrap_=(val) ⇒ void

This method returns an undefined value.

Parameters:

  • val (Boolean) 


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

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) 


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

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:

Returns:

  • (Boolean) 


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

def validate_value(value, validationInfo) end

#value_ ⇒ Wx::Variant

Returns:



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

def value_; end

#value_=(val) ⇒ void

This method returns an undefined value.

Parameters:



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

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) 


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

def value_to_string(value, argFlags=0) end