Class: Wx::PG::ImageFileProperty

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

Overview

Property representing image file(name).

Supported special attributes:

Requires:

  • USE_PROPGRID

Instance Method Summary collapse

Methods inherited from FileProperty

#display_editor_dialog, #do_get_validator, #do_set_attribute, get_class_validator, #get_file_name, #m_base_path, #m_base_path=, #m_ind_filter, #m_ind_filter=, #m_initial_path, #m_initial_path=, #m_wildcard, #m_wildcard=, #string_to_value, #value_to_string

Methods inherited from EditorDialogProperty

#display_editor_dialog, #dlg_style_, #dlg_style_=, #dlg_title_, #dlg_title_=, #do_set_attribute, #get_editor_dialog

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_event, #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 = Wx::PG::PG_LABEL, name = Wx::PG::PG_LABEL, value = ('')) ⇒ Wx::PG::ImageFileProperty

Parameters:

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


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

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

Instance Method Details

#on_custom_paint(dc, rect, paintdata) ⇒ void

This method returns an undefined value.

Override to paint an image in front of the property value text or drop-down list item (but only if PGProperty#on_measure_image is overridden as well).

If property’s #on_measure_image returns size that has height != 0 but less than row height ( < 0 has special meanings), PropertyGrid calls this method to draw a custom image in a limited area in front of the editor control or value text/graphics, and if control has drop-down list, then the image is drawn there as well (even in the case #on_measure_image returned higher height than row height). NOTE: Following applies when #on_measure_image returns a “flexible” height ( using wxPG_FLEXIBLE_SIZE(W,H) macro), which implies variable height items: If (rect.x+rect.width) is < 0, then this is a measure item call, which means that dc is invalid and only thing that should be done is to set paintdata.m_drawnHeight to the height of the image of item at index paintdata.m_choiceItem. This call may be done even as often as once every drop-down popup show.

Remark:

- You can actually exceed rect width, but if you do so then paintdata.m_drawnWidth must be set to the full width drawn in pixels. - Due to technical reasons, rect's height will be default even if custom height was reported during measure call. - Brush is guaranteed to be default background colour. It has been already used to clear the background of area being painted. It can be modified. - Pen is guaranteed to be 1-wide 'black' (or whatever is the proper colour) pen for drawing framing rectangle. It can be changed as well.

Parameters:

  • dc (Wx::DC) —

    DC to paint on.

  • rect (Wx::Rect) —

    Box reserved for custom graphics. Includes surrounding rectangle, if any. If x+width is < 0, then this is a measure item call (see above).

  • paintdata (Wx::PG::PGPaintData) —

    PGPaintData structure with much useful data about painted item.

See Also:



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

def on_custom_paint(dc, rect, paintdata) end

#on_measure_image(item) ⇒ Wx::Size

Returns size of the custom painted image in front of property.

This method must be overridden to return non-default value if OnCustomPaint is to be called.

Remark:

- Default behaviour is to return size(0,0), which means no image. - Default image width or height is indicated with dimension -1. - You can also return PG_DEFAULT_IMAGE_SIZE which equals DEFAULT_SIZE.

Parameters:

  • item (Integer) —

    Normally -1, but can be an index to the property’s list of items.

Returns:



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

def on_measure_image(item) end

#on_set_value ⇒ void

This method returns an undefined value.

This virtual function is called after m_value has been set.

Remark:

- If m_value was set to Null variant (i.e. unspecified value), #on_set_value will not be called. - m_value may be of any variant type. Typically properties internally support only one variant type, and as such #on_set_value provides a good opportunity to convert supported values into internal type. - Default implementation does nothing. 



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

def on_set_value; end

#value_ ⇒ Wx::Variant

Returns:



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

def value_; end

#value_=(val) ⇒ void

This method returns an undefined value.

Parameters:



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

def value_=(val); end