Class: Wx::PG::ColourProperty

Inherits:

SystemColourProperty

• Object
• Object
• PGProperty
• EnumProperty
• SystemColourProperty
• Wx::PG::ColourProperty

Defined in:

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

Overview

Allows to select a colour from the list or with colour dialog.

Value used is of ColourPropertyValue type. Supported special attributes: PG_COLOUR_ALLOW_CUSTOM, PG_COLOUR_HAS_ALPHA

Requires:

• USE_PROPGRID

Instance Method Summary

• #do_translate_val(v) ⇒ Wx::Variant protected
• #get_colour(index) ⇒ Wx::Colour (also: #colour)

  Default is to use SystemSettings.get_colour(index).

• #initialize(label = Wx::PG::PG_LABEL, name = Wx::PG::PG_LABEL, value = Wx::WHITE) ⇒ Wx::PG::ColourProperty constructor
• #value_ ⇒ Wx::Variant
• #value_=(val) ⇒ void
• #value_to_string(value, argFlags = 0) ⇒ String

  Converts property value into a text representation.

Methods inherited from SystemColourProperty

#col_to_ind, #colour_to_string, #do_set_attribute, #get_custom_colour_index, #get_val, #init, #int_to_value, #on_custom_paint, #on_event, #on_measure_image, #on_set_value, #query_colour_from_user, #string_to_value

Methods inherited from EnumProperty

#get_choice_selection, #get_index, #get_index_for_value, #get_item_count, #int_to_value, #on_set_value, #set_index, #string_to_value, #validate_value

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

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::WHITE) ⇒ Wx::PG::ColourProperty

Parameters:

• label (String) (defaults to: Wx::PG::PG_LABEL)
• name (String) (defaults to: Wx::PG::PG_LABEL)
• value (Wx::Colour, String, Symbol) (defaults to: Wx::WHITE)

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

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

Instance Method Details

#do_translate_val(v) ⇒ Wx::Variant (protected)

Parameters:

• v (Wx::PG::ColourPropertyValue)

Returns:

• (Wx::Variant)

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

def do_translate_val(v) end

#get_colour(index) ⇒ Wx::Colour Also known as: colour

Default is to use SystemSettings.get_colour(index).

Override to use custom colour tables etc.

Parameters:

• index (Integer)

Returns:

• (Wx::Colour)

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

def get_colour(index) end

#value_ ⇒ Wx::Variant

Returns:

• (Wx::Variant)

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

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 2710

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 2694

def value_to_string(value, argFlags=0) end