Class: Wx::PG::PropertyGrid

Inherits:
ScrolledControl show all
Includes:
PropertyGridInterface
Defined in:
lib/wx/doc/gen/pg/property_grid.rb,
lib/wx/doc/pg/property_grid.rb

Overview

PropertyGrid is a specialized grid for editing properties - in other words name = value pairs.

List of ready-to-use property classes include strings, numbers, flag sets, fonts, colours and many others. It is possible, for example, to categorize properties, set up a complete tree-hierarchy, add more than two columns, and set arbitrary per-property attributes. Please note that most member functions are inherited and as such not documented on this page. This means you will probably also want to read PropertyGridInterface class reference. See also wxPropertyGrid Overview.

Window Styles

See wxPropertyGrid Window Styles.

Event Handling

Please see PropertyGridEvent for the documentation of all event types you can use with PropertyGrid.

Remark:

Use Window#freeze and Window#thaw respectively to disable and enable drawing. This will also delay sorting etc. miscellaneous calculations to the last possible moment.

Category: PropertyGrid <div class=‘appearance’><span class=‘appearance’>Appearance:</span><table><tr><td> WXMSW Appearance </td><td> WXGTK Appearance </td><td> WXOSX Appearance </td></tr></table></div>

Requires:

  • USE_PROPGRID

Class Method Summary collapse

Instance Method Summary collapse

Methods included from PropertyGridInterface

#append, #append_in, #begin_add_children, #clear_modified_status, #clear_selection, #collapse, #collapse_all, #delete_property, #disable_property, #each_property, #each_property_attribute, #editor_validate, #enable_property, #end_add_children, #expand, #expand_all, #get_column_proportion, get_editor_by_name, #get_first, #get_first_child, #get_properties_with_flag, #get_property, #get_property_attribute, #get_property_background_colour, #get_property_by_label, #get_property_by_name, #get_property_by_name_a, #get_property_category, #get_property_client_data, #get_property_editor, #get_property_help_string, #get_property_image, #get_property_label, #get_property_name, #get_property_parent, #get_property_text_colour, #get_property_validator, #get_property_value, #get_property_value_as_array_int, #get_property_value_as_array_string, #get_property_value_as_bool, #get_property_value_as_date_time, #get_property_value_as_double, #get_property_value_as_int, #get_property_value_as_long, #get_property_value_as_long_long, #get_property_value_as_string, #get_property_value_as_u_long, #get_property_value_as_u_long_long, #get_property_values, #get_selected_properties, #get_state, #hide_property, init_all_type_handlers, #insert, #is_property_category, #is_property_enabled, #is_property_expanded, #is_property_modified, #is_property_selected, #is_property_shown, #is_property_value_unspecified, #limit_property_editing, #refresh_grid, register_additional_editors, #replace_property, #restore_editable_state, #reverse_each_property, #save_editable_state, set_bool_choices, #set_column_proportion, #set_prop_val, #set_property_attribute, #set_property_attribute_all, #set_property_background_colour, #set_property_cell, #set_property_client_data, #set_property_colours_to_default, #set_property_editor, #set_property_help_string, #set_property_image, #set_property_label, #set_property_max_length, #set_property_name, #set_property_read_only, #set_property_text_colour, #set_property_validator, #set_property_value, #set_property_value_string, #set_property_value_unspecified, #set_property_values, #set_validation_failure_behavior, #sort, #sort_children

Methods inherited from ScrolledControl

#adjust_scrollbars, #calc_scrolled_position, #calc_unscrolled_position, #disable_keyboard_scrolling, #do_prepare_dc, #enable_scrolling, #get_scale_x, #get_scale_y, #get_scroll_lines, #get_scroll_page_size, #get_scroll_pixels_per_unit, #get_target_rect, #get_target_window, #get_view_start, #get_virtual_size, #is_auto_scrolling, #is_retained, #prepare_dc, #scroll, #set_scale, #set_scroll_page_size, #set_scroll_rate, #set_scrollbars, #set_target_rect, #set_target_window, #show_scrollbars, #stop_auto_scrolling

Methods inherited from Control

#command, ellipsize, escape_mnemonics, #get_label, #get_label_text, #get_size_from_text, #get_size_from_text_size, remove_mnemonics, #set_label, #set_label_markup, #set_label_text

Methods inherited from Window

#accepts_focus, #accepts_focus_from_keyboard, #accepts_focus_recursively, #add_child, #adjust_for_layout_direction, #always_show_scrollbars, #begin_repositioning_children, #cache_best_size, #can_accept_focus, #can_accept_focus_from_keyboard, #can_scroll, #can_set_transparent, #capture_mouse, #center, #center_on_parent, #centre, #centre_on_parent, #clear_background, #client_to_screen, #client_to_window_size, #close, #convert_dialog_to_pixels, #convert_pixels_to_dialog, #destroy, #destroy_children, #disable, #disable_focus_from_keyboard, #do_update_window_ui, #drag_accept_files, #each_child, #enable, #enable_touch_events, #enable_visible_focus, #end_repositioning_children, find_focus, #find_window_by_id, find_window_by_id, #find_window_by_label, find_window_by_label, #find_window_by_name, find_window_by_name, #fit, #fit_inside, #freeze, #from_dip, from_dip, #from_phys, from_phys, #get_accelerator_table, #get_auto_layout, #get_background_colour, #get_background_style, #get_best_height, #get_best_size, #get_best_virtual_size, #get_best_width, #get_border, get_capture, #get_caret, #get_char_height, #get_char_width, #get_children, get_class_default_attributes, #get_client_area_origin, #get_client_rect, #get_client_size, #get_containing_sizer, #get_content_scale_factor, #get_cursor, #get_default_attributes, #get_dpi, #get_dpi_scale_factor, #get_drop_target, #get_effective_min_size, #get_event_handler, #get_extra_style, #get_font, #get_foreground_colour, #get_grand_parent, #get_help_text, #get_help_text_at_point, #get_id, #get_label, #get_layout_direction, #get_max_client_size, #get_max_height, #get_max_size, #get_max_width, #get_min_client_size, #get_min_height, #get_min_size, #get_min_width, #get_name, #get_next_sibling, #get_parent, #get_popup_menu_selection_from_user, #get_position, #get_prev_sibling, #get_rect, #get_screen_position, #get_screen_rect, #get_scroll_pos, #get_scroll_range, #get_scroll_thumb, #get_size, #get_sizer, #get_text_extent, #get_theme_enabled, #get_tool_tip, #get_tool_tip_text, #get_update_client_rect, #get_update_region, #get_validator, #get_virtual_size, #get_window_border_size, #get_window_style, #get_window_style_flag, #get_window_variant, #handle_as_navigation_key, #handle_window_event, #has_capture, #has_extra_style, #has_flag, #has_focus, #has_multiple_pages, #has_scrollbar, #has_transparent_background, #hide, #hide_with_effect, #inform_first_direction, #inherit_attributes, #inherits_background_colour, #inherits_foreground_colour, #init_dialog, #invalidate_best_size, #is_being_deleted, #is_descendant, #is_double_buffered, #is_enabled, #is_exposed, #is_focusable, #is_retained, #is_scrollbar_always_shown, #is_shown, #is_shown_on_screen, #is_this_enabled, #is_top_level, #is_transparent_background_supported, #layout, #line_down, #line_up, #locked, #lower_window, #move, #move_after_in_tab_order, #move_before_in_tab_order, #navigate, #navigate_in, new_control_id, #on_internal_idle, #page_down, #page_up, #paint, #paint_buffered, #popup_menu, #post_size_event, #post_size_event_to_parent, #process_window_event, #process_window_event_locally, #push_event_handler, #raise_window, #refresh, #refresh_rect, #register_hot_key, #release_mouse, #remove_child, #remove_event_handler, #reparent, #screen_to_client, #scroll_lines, #scroll_pages, #scroll_window, #send_size_event, #send_size_event_to_parent, #set_accelerator_table, #set_auto_layout, #set_background_colour, #set_background_style, #set_can_focus, #set_caret, #set_client_size, #set_containing_sizer, #set_cursor, #set_double_buffered, #set_drop_target, #set_event_handler, #set_extra_style, #set_focus, #set_focus_from_kbd, #set_font, #set_foreground_colour, #set_help_text, #set_id, #set_initial_size, #set_label, #set_layout_direction, #set_max_client_size, #set_max_size, #set_min_client_size, #set_min_size, #set_name, #set_next_handler, #set_own_background_colour, #set_own_font, #set_own_foreground_colour, #set_position, #set_previous_handler, #set_scroll_pos, #set_scrollbar, #set_size, #set_size_hints, #set_sizer, #set_sizer_and_fit, #set_theme_enabled, #set_tool_tip, #set_transparent, #set_validator, #set_virtual_size, #set_window_style, #set_window_style_flag, #set_window_variant, #should_inherit_colours, #show, #show_with_effect, #switch_sizer, #thaw, #to_dip, to_dip, #to_phys, to_phys, #toggle_window_style, #transfer_data_from_window, #transfer_data_to_window, #unregister_hot_key, unreserve_control_id, #unset_tool_tip, #update, #update_window_ui, #use_background_colour, #use_bg_col, #use_foreground_colour, #validate, #warp_pointer, #window_to_client_size

Methods inherited from EvtHandler

add_filter, #add_pending_event, #call_after, clear_filters, #connect, #delete_pending_events, #disconnect, #evt_activate, #evt_activate_app, #evt_aui_pane_activated, #evt_aui_pane_button, #evt_aui_pane_close, #evt_aui_pane_maximize, #evt_aui_pane_restore, #evt_aui_render, #evt_auinotebook_allow_dnd, #evt_auinotebook_begin_drag, #evt_auinotebook_bg_dclick, #evt_auinotebook_button, #evt_auinotebook_drag_done, #evt_auinotebook_drag_motion, #evt_auinotebook_end_drag, #evt_auinotebook_page_changed, #evt_auinotebook_page_changing, #evt_auinotebook_page_close, #evt_auinotebook_page_closed, #evt_auinotebook_tab_middle_down, #evt_auinotebook_tab_middle_up, #evt_auinotebook_tab_right_down, #evt_auinotebook_tab_right_up, #evt_auitoolbar_begin_drag, #evt_auitoolbar_middle_click, #evt_auitoolbar_overflow_click, #evt_auitoolbar_right_click, #evt_auitoolbar_tool_dropdown, #evt_button, #evt_calculate_layout, #evt_calendar, #evt_calendar_page_changed, #evt_calendar_sel_changed, #evt_calendar_week_clicked, #evt_calendar_weekday_clicked, #evt_char, #evt_char_hook, #evt_checkbox, #evt_checklistbox, #evt_child_focus, #evt_choice, #evt_choicebook_page_changed, #evt_choicebook_page_changing, #evt_close, #evt_collapsiblepane_changed, #evt_colourpicker_changed, #evt_colourpicker_current_changed, #evt_colourpicker_dialog_cancelled, #evt_combobox, #evt_combobox_closeup, #evt_combobox_dropdown, #evt_command, #evt_command_enter, #evt_command_kill_focus, #evt_command_left_click, #evt_command_left_dclick, #evt_command_range, #evt_command_right_click, #evt_command_scroll, #evt_command_scroll_bottom, #evt_command_scroll_changed, #evt_command_scroll_linedown, #evt_command_scroll_lineup, #evt_command_scroll_pagedown, #evt_command_scroll_pageup, #evt_command_scroll_thumbrelease, #evt_command_scroll_thumbtrack, #evt_command_scroll_top, #evt_command_set_focus, #evt_context_menu, #evt_date_changed, #evt_dialup_connected, #evt_dialup_disconnected, #evt_dirctrl_fileactivated, #evt_dirctrl_selectionchanged, #evt_dirpicker_changed, #evt_display_changed, #evt_dpi_changed, #evt_drop_files, #evt_end_session, #evt_enter_window, #evt_erase_background, #evt_filectrl_fileactivated, #evt_filectrl_filterchanged, #evt_filectrl_folderchanged, #evt_filectrl_selectionchanged, #evt_filepicker_changed, #evt_find, #evt_find_close, #evt_find_next, #evt_find_replace, #evt_find_replace_all, #evt_fontpicker_changed, #evt_fullscreen, #evt_gesture_pan, #evt_gesture_rotate, #evt_gesture_zoom, #evt_grid_cell_changed, #evt_grid_cell_changing, #evt_grid_cell_left_click, #evt_grid_cell_left_dclick, #evt_grid_cell_right_click, #evt_grid_cell_right_dclick, #evt_grid_cmd_col_size, #evt_grid_cmd_editor_created, #evt_grid_cmd_range_selected, #evt_grid_cmd_range_selecting, #evt_grid_cmd_row_size, #evt_grid_col_auto_size, #evt_grid_col_move, #evt_grid_col_size, #evt_grid_col_sort, #evt_grid_editor_created, #evt_grid_editor_hidden, #evt_grid_editor_shown, #evt_grid_label_left_click, #evt_grid_label_left_dclick, #evt_grid_label_right_click, #evt_grid_label_right_dclick, #evt_grid_range_selected, #evt_grid_range_selecting, #evt_grid_row_auto_size, #evt_grid_row_move, #evt_grid_row_size, #evt_grid_select_cell, #evt_grid_tabbing, #evt_header_begin_reorder, #evt_header_begin_resize, #evt_header_click, #evt_header_dclick, #evt_header_dragging_cancelled, #evt_header_end_reorder, #evt_header_end_resize, #evt_header_middle_click, #evt_header_middle_dclick, #evt_header_resizing, #evt_header_right_click, #evt_header_right_dclick, #evt_header_separator_dclick, #evt_help, #evt_help_range, #evt_hibernate, #evt_hotkey, #evt_html_cell_clicked, #evt_html_cell_hover, #evt_html_link_clicked, #evt_hyperlink, #evt_iconize, #evt_idle, #evt_init_dialog, #evt_joy_button_down, #evt_joy_button_up, #evt_joy_move, #evt_joy_zmove, #evt_joystick_events, #evt_key_down, #evt_key_up, #evt_kill_focus, #evt_leave_window, #evt_left_dclick, #evt_left_down, #evt_left_up, #evt_list_begin_drag, #evt_list_begin_label_edit, #evt_list_begin_rdrag, #evt_list_cache_hint, #evt_list_col_begin_drag, #evt_list_col_click, #evt_list_col_dragging, #evt_list_col_end_drag, #evt_list_col_right_click, #evt_list_delete_all_items, #evt_list_delete_item, #evt_list_end_label_edit, #evt_list_insert_item, #evt_list_item_activated, #evt_list_item_checked, #evt_list_item_deselected, #evt_list_item_focused, #evt_list_item_middle_click, #evt_list_item_right_click, #evt_list_item_selected, #evt_list_item_unchecked, #evt_list_key_down, #evt_listbook_page_changed, #evt_listbook_page_changing, #evt_listbox, #evt_listbox_dclick, #evt_long_press, #evt_magnify, #evt_maximize, #evt_media_finished, #evt_media_loaded, #evt_media_pause, #evt_media_play, #evt_media_statechanged, #evt_media_stop, #evt_menu, #evt_menu_close, #evt_menu_highlight, #evt_menu_highlight_all, #evt_menu_open, #evt_menu_range, #evt_middle_dclick, #evt_middle_down, #evt_middle_up, #evt_motion, #evt_mouse_aux1_dclick, #evt_mouse_aux1_down, #evt_mouse_aux1_up, #evt_mouse_aux2_dclick, #evt_mouse_aux2_down, #evt_mouse_aux2_up, #evt_mouse_capture_changed, #evt_mouse_capture_lost, #evt_mouse_events, #evt_mousewheel, #evt_move, #evt_move_end, #evt_move_start, #evt_moving, #evt_navigation_key, #evt_notebook_page_changed, #evt_notebook_page_changing, #evt_paint, #evt_pg_changed, #evt_pg_changing, #evt_pg_col_begin_drag, #evt_pg_col_dragging, #evt_pg_col_end_drag, #evt_pg_double_click, #evt_pg_highlighted, #evt_pg_item_collapsed, #evt_pg_item_expanded, #evt_pg_label_edit_begin, #evt_pg_label_edit_ending, #evt_pg_page_changed, #evt_pg_right_click, #evt_pg_selected, #evt_press_and_tap, #evt_query_end_session, #evt_query_layout_info, #evt_radiobox, #evt_radiobutton, #evt_ribbonbar_help_click, #evt_ribbonbar_page_changed, #evt_ribbonbar_page_changing, #evt_ribbonbar_tab_left_dclick, #evt_ribbonbar_tab_middle_down, #evt_ribbonbar_tab_middle_up, #evt_ribbonbar_tab_right_down, #evt_ribbonbar_tab_right_up, #evt_ribbonbar_toggled, #evt_ribbonbuttonbar_clicked, #evt_ribbonbuttonbar_dropdown_clicked, #evt_ribbongallery_clicked, #evt_ribbongallery_hover_changed, #evt_ribbongallery_selected, #evt_ribbonpanel_extbutton_activated, #evt_ribbontoolbar_clicked, #evt_ribbontoolbar_dropdown_clicked, #evt_richtext_buffer_reset, #evt_richtext_character, #evt_richtext_consuming_character, #evt_richtext_content_deleted, #evt_richtext_content_inserted, #evt_richtext_delete, #evt_richtext_focus_object_changed, #evt_richtext_left_click, #evt_richtext_left_dclick, #evt_richtext_middle_click, #evt_richtext_properties_changed, #evt_richtext_return, #evt_richtext_right_click, #evt_richtext_selection_changed, #evt_richtext_style_changed, #evt_richtext_stylesheet_changed, #evt_richtext_stylesheet_replaced, #evt_richtext_stylesheet_replacing, #evt_right_dclick, #evt_right_down, #evt_right_up, #evt_sash_dragged, #evt_sash_dragged_range, #evt_scroll, #evt_scroll_bottom, #evt_scroll_changed, #evt_scroll_command, #evt_scroll_linedown, #evt_scroll_lineup, #evt_scroll_pagedown, #evt_scroll_pageup, #evt_scroll_thumbrelease, #evt_scroll_thumbtrack, #evt_scroll_top, #evt_scrollbar, #evt_scrollwin, #evt_scrollwin_bottom, #evt_scrollwin_linedown, #evt_scrollwin_lineup, #evt_scrollwin_pagedown, #evt_scrollwin_pageup, #evt_scrollwin_thumbrelease, #evt_scrollwin_thumbtrack, #evt_scrollwin_top, #evt_search, #evt_search_cancel, #evt_set_cursor, #evt_set_focus, #evt_show, #evt_size, #evt_slider, #evt_spin, #evt_spin_down, #evt_spin_up, #evt_spinctrl, #evt_spinctrldouble, #evt_splitter_dclick, #evt_splitter_sash_pos_changed, #evt_splitter_sash_pos_changing, #evt_splitter_sash_pos_resize, #evt_splitter_unsplit, #evt_stc_autocomp_cancelled, #evt_stc_autocomp_char_deleted, #evt_stc_autocomp_completed, #evt_stc_autocomp_selection, #evt_stc_autocomp_selection_change, #evt_stc_calltip_click, #evt_stc_change, #evt_stc_charadded, #evt_stc_clipboard_copy, #evt_stc_clipboard_paste, #evt_stc_do_drop, #evt_stc_doubleclick, #evt_stc_drag_over, #evt_stc_dwellend, #evt_stc_dwellstart, #evt_stc_hotspot_click, #evt_stc_hotspot_dclick, #evt_stc_hotspot_release_click, #evt_stc_indicator_click, #evt_stc_indicator_release, #evt_stc_macrorecord, #evt_stc_margin_right_click, #evt_stc_marginclick, #evt_stc_modified, #evt_stc_needshown, #evt_stc_painted, #evt_stc_romodifyattempt, #evt_stc_savepointleft, #evt_stc_savepointreached, #evt_stc_start_drag, #evt_stc_styleneeded, #evt_stc_updateui, #evt_stc_userlistselection, #evt_stc_zoom, #evt_sys_colour_changed, #evt_taskbar_click, #evt_taskbar_left_dclick, #evt_taskbar_left_down, #evt_taskbar_left_up, #evt_taskbar_move, #evt_taskbar_right_dclick, #evt_taskbar_right_down, #evt_taskbar_right_up, #evt_text, #evt_text_copy, #evt_text_cut, #evt_text_enter, #evt_text_maxlen, #evt_text_paste, #evt_text_url, #evt_time_changed, #evt_timer, #evt_togglebutton, #evt_tool, #evt_tool_dropdown, #evt_tool_enter, #evt_tool_range, #evt_tool_rclicked, #evt_tool_rclicked_range, #evt_toolbook_page_changed, #evt_toolbook_page_changing, #evt_tree_begin_drag, #evt_tree_begin_label_edit, #evt_tree_begin_rdrag, #evt_tree_delete_item, #evt_tree_end_drag, #evt_tree_end_label_edit, #evt_tree_get_info, #evt_tree_item_activated, #evt_tree_item_collapsed, #evt_tree_item_collapsing, #evt_tree_item_expanded, #evt_tree_item_expanding, #evt_tree_item_gettooltip, #evt_tree_item_menu, #evt_tree_item_middle_click, #evt_tree_item_right_click, #evt_tree_key_down, #evt_tree_sel_changed, #evt_tree_sel_changing, #evt_tree_set_info, #evt_tree_state_image_click, #evt_treebook_node_collapsed, #evt_treebook_node_expanded, #evt_treebook_page_changed, #evt_treebook_page_changing, #evt_two_finger_tap, #evt_update_ui, #evt_update_ui_range, #evt_window_create, #evt_window_destroy, #evt_wizard_before_page_changed, #evt_wizard_cancel, #evt_wizard_finished, #evt_wizard_help, #evt_wizard_page_changed, #evt_wizard_page_changing, #evt_wizard_page_shown, #get_client_object, #get_evt_handler_enabled, #get_next_handler, #get_previous_handler, #is_unlinked, #process_event, #process_event_locally, #process_pending_events, #queue_event, register_class, remove_filter, #safely_process_event, #set_client_object, #set_evt_handler_enabled, #set_next_handler, #set_previous_handler, #try_after, #try_before, #unlink

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::PG::PropertyGrid #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::PG::PG_DEFAULT_STYLE, name = Wx::PROPERTY_GRID_NAME_STR) ⇒ Wx::PG::PropertyGrid

Returns a new instance of PropertyGrid.

Overloads:

  • #initialize ⇒ Wx::PG::PropertyGrid

    Two step constructor.

    Call #create when this constructor is called to build up the Wx::PG::PropertyGrid

  • #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::PG::PG_DEFAULT_STYLE, name = Wx::PROPERTY_GRID_NAME_STR) ⇒ Wx::PG::PropertyGrid

    Constructor.

    The styles to be used are styles valid for the Window.

    Parameters:

    • parent (Wx::Window)
    • id (Integer) (defaults to: Wx::StandardID::ID_ANY)
    • pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION)
    • size (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE)
    • style (Integer) (defaults to: Wx::PG::PG_DEFAULT_STYLE)
    • name (String) (defaults to: Wx::PROPERTY_GRID_NAME_STR)

    See Also:

    • Window Styles.


159
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 159

def initialize(*args) end

Class Method Details

.auto_get_translation(enable) ⇒ void

This method returns an undefined value.

This static function enables or disables automatic use of get_translation for following strings: EnumProperty list labels, FlagsProperty child property labels.

Default is false.

Parameters:

  • enable (Boolean) 


714
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 714

def self.auto_get_translation(enable) end

.do_register_editor_class(editor, name) ⇒ Wx::PG::PGEditor

Registers a new editor class.

Returns pointer to the editor class instance that should be used.

Parameters:

Returns:



722
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 722

def self.do_register_editor_class(editor, name) end

.get_editor_class(name) ⇒ Wx::PG::PGEditor?

Return a registered property editor (either custom or standard)

Parameters:

  • name (String) —

    Property editor class name

Returns:



15
 
# File 'lib/wx/doc/pg/property_grid.rb', line 15

def self.get_editor_class(name); end

.get_standard_editor_class(name) ⇒ Wx::PG::PGEditor?

Return a registered standard (wx) property editor.

Parameters:

  • name (String) —

    Property editor class name

Returns:



20
 
# File 'lib/wx/doc/pg/property_grid.rb', line 20

def self.get_standard_editor_class(name); end

.register_editor_class(editor) ⇒ Wx::PG::PGEditor

Forwards to DoRegisterEditorClass with class name of provided property editor.

Parameters:

Returns:



25
 
# File 'lib/wx/doc/pg/property_grid.rb', line 25

def self.register_editor_class(editor); end

Instance Method Details

#add_action_trigger(action, keycode, modifiers = 0) ⇒ void

This method returns an undefined value.

Adds given key combination to trigger given action.

Here is a sample code to make Enter key press move focus to the next property.

propGrid.add_action_trigger(Wx::PG::PG_ACTION_NEXT_PROPERTY, Wx::K_RETURN)
  propGrid.dedicate_key(Wx::K_RETURN)

Parameters:

  • action (Integer) —

    Which action to trigger. See wxPropertyGrid Action Identifiers.

  • keycode (Integer) —

    Which keycode triggers the action.

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

    Which key event modifiers, in addition to keycode, are needed to trigger the action.



173
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 173

def add_action_trigger(action, keycode, modifiers=0) end

#add_to_selection(id) ⇒ Boolean

Adds given property into selection.

If Wx::PG::PG_EX_WINDOW_STYLES::PG_EX_MULTIPLE_SELECTION extra style is not used, then this has same effect as calling #select_property.

Remark:

Multiple selection is not supported for categories. This means that if you have properties selected, you cannot add category to selection, and also if you have category selected, you cannot add other properties to selection. This member function will fail silently in these cases, even returning true.

Parameters:

Returns:

  • (Boolean) 


186
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 186

def add_to_selection(id) end

#begin_label_edit(colIndex = 0) ⇒ void

This method returns an undefined value.

Creates label editor TextCtrl for given column, for property that is currently selected.

When multiple selection is enabled, this applies to whatever property #get_selection returns.

Parameters:

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

    Which column’s label to edit. Note that you should not use value 1, which is reserved for property value column.

See Also:



195
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 195

def begin_label_edit(colIndex=0) end

#center_splitter(enableAutoResizing = false) ⇒ void

This method returns an undefined value.

Centers the splitter.

Parameters:



216
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 216

def center_splitter(enableAutoResizing=false) end

#change_property_value(id, newValue) ⇒ Boolean

Changes value of a property, as if from an editor.

Use this instead of Wx::PG::PropertyGridInterface#set_property_value if you need the value to run through validation process, and also send EVT_PG_CHANGED.

Remark:

Since this function sends EVT_PG_CHANGED, it should not be called from EVT_PG_CHANGED handler.

Returns true if value was successfully changed.

Parameters:

Returns:

  • (Boolean) 


211
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 211

def change_property_value(id, newValue) end

#clear ⇒ void

This method returns an undefined value.

Deletes all properties.



220
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 220

def clear; end

#clear_action_triggers(action) ⇒ void

This method returns an undefined value.

Clears action triggers for given action.

Parameters:

  • action (Integer) —

    Which action to trigger. wxPropertyGrid Action Identifiers.



225
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 225

def clear_action_triggers(action) end

#commit_changes_from_editor(flags = 0) ⇒ Boolean

Forces updating the value of property from the editor control.

Note that EVT_PG_CHANGING and EVT_PG_CHANGED are dispatched using ProcessEvent, meaning your event handlers will be called immediately. Returns true if anything was changed.

Parameters:

  • flags (Integer) (defaults to: 0)

Returns:

  • (Boolean) 


233
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 233

def commit_changes_from_editor(flags=0) end

#create(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::PG::PG_DEFAULT_STYLE, name = Wx::PROPERTY_GRID_NAME_STR) ⇒ Boolean

Two step creation.

Whenever the control is created without any parameters, use Create to actually create it. Don’t access the control’s public methods before this is called

Parameters:

  • parent (Wx::Window)
  • id (Integer) (defaults to: Wx::StandardID::ID_ANY)
  • pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION)
  • size (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE)
  • style (Integer) (defaults to: Wx::PG::PG_DEFAULT_STYLE)
  • name (String) (defaults to: Wx::PROPERTY_GRID_NAME_STR)

Returns:

  • (Boolean)

See Also:

  • Window Styles.


246
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 246

def create(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::PG::PG_DEFAULT_STYLE, name=Wx::PROPERTY_GRID_NAME_STR) end

#dedicate_key(keycode) ⇒ void

This method returns an undefined value.

Dedicates a specific keycode to Wx::PG::PropertyGrid.

This means that such key presses will not be redirected to editor controls. Using this function allows, for example, navigation between properties using arrow keys even when the focus is in the editor control.

Parameters:

  • keycode (Integer) 


254
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 254

def dedicate_key(keycode) end

#do_hide_property_error(property) ⇒ void

This method returns an undefined value.

Override in derived class to hide an error displayed by #do_show_property_error.

Parameters:

See Also:



60
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 60

def do_hide_property_error(property) end

#do_on_validation_failure(property, invalidValue) ⇒ Boolean

Override to customize property validation failure behaviour.

Return true if user is allowed to change to another property even if current has invalid value.

Parameters:

Returns:

  • (Boolean) 


75
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 75

def do_on_validation_failure(property, invalidValue) end

#do_on_validation_failure_reset(property) ⇒ void

This method returns an undefined value.

Override to customize resetting of property validation failure status.

Remark:

Property is guaranteed to have flag Wx::PG::PGPropertyFlags::PG_PROP_INVALID_VALUE set.

Parameters:



86
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 86

def do_on_validation_failure_reset(property) end

#do_show_property_error(property, msg) ⇒ void

This method returns an undefined value.

Override in derived class to display error messages in custom manner (these message usually only result from validation failure).

Remark:

If you implement this, then you also need to implement #do_hide_property_error - possibly to do nothing, if error does not need hiding (e.g. it was logged or shown in a message box).

Parameters:

See Also:



52
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 52

def do_show_property_error(property, msg) end

#draw_item_and_value_related(p) ⇒ void

This method returns an undefined value.

Draws item, children, and consecutive parents as long as category is not met.

Parameters:



707
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 707

def draw_item_and_value_related(p) end

#editors_value_was_modified ⇒ void

This method returns an undefined value.

Call when editor widget’s contents is modified.

For example, this is called when changes text in TextCtrl (used in StringProperty and IntProperty).

Remark:

This function should only be called by custom properties.

See Also:



99
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 99

def editors_value_was_modified; end

#editors_value_was_not_modified ⇒ void

This method returns an undefined value.

Reverse of #editors_value_was_modified.

Remark:

This function should only be called by custom properties. 



109
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 109

def editors_value_was_not_modified; end

#enable_categories(enable) ⇒ Boolean

Enables or disables (shows/hides) categories according to parameter enable.

Remark:

This functions deselects selected property, if any. Validation failure option Wx::PG::PG_VALIDATION_FAILURE_BEHAVIOR_FLAGS::PG_VFB_STAY_IN_PROPERTY is not respected, i.e. selection is cleared even if editor had invalid value.

Parameters:

  • enable (Boolean)

Returns:

  • (Boolean) 


265
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 265

def enable_categories(enable) end

#end_label_edit(commit = true) ⇒ void

This method returns an undefined value.

Destroys label editor TextCtrl, if any.

Parameters:

  • commit (Boolean) (defaults to: true) —

    Use true (default) to store edited label text in property cell data.

See Also:



274
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 274

def end_label_edit(commit=true) end

#ensure_visible(id) ⇒ Boolean

Scrolls and/or expands items to ensure that the given item is visible.

Returns true if something was actually done.

Parameters:

Returns:

  • (Boolean) 


281
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 281

def ensure_visible(id) end

#fit_columns ⇒ Wx::Size

Reduces column sizes to minimum possible, while still retaining fully visible grid contents (labels, images).

Minimum size for the grid to still display everything.

Remark:

Does not work well with Wx::PG::PG_WINDOW_STYLES::PG_SPLITTER_AUTO_CENTER window style. This function only works properly if grid size prior to call was already fairly large. Note that you can also get calculated column widths by calling GetState->GetColumnWidth() immediately after this function returns.

Returns:



299
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 299

def fit_columns; end

#get_caption_background_colour ⇒ Wx::Colour Also known as: caption_background_colour

Returns current category caption background colour.

Returns:



313
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 313

def get_caption_background_colour; end

#get_caption_font ⇒ Wx::Font Also known as: caption_font

Returns current category caption font.

Returns:



318
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 318

def get_caption_font; end

#get_caption_foreground_colour ⇒ Wx::Colour Also known as: caption_foreground_colour

Returns current category caption text colour.

Returns:



323
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 323

def get_caption_foreground_colour; end

#get_cell_background_colour ⇒ Wx::Colour Also known as: cell_background_colour

Returns current cell background colour.

Returns:



328
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 328

def get_cell_background_colour; end

#get_cell_disabled_text_colour ⇒ Wx::Colour Also known as: cell_disabled_text_colour

Returns current cell text colour when disabled.

Returns:



333
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 333

def get_cell_disabled_text_colour; end

#get_cell_text_colour ⇒ Wx::Colour Also known as: cell_text_colour

Returns current cell text colour.

Returns:



338
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 338

def get_cell_text_colour; end

#get_column_count ⇒ Integer Also known as: column_count

Returns number of columns currently on grid.

Returns:

  • (Integer) 


343
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 343

def get_column_count; end

#get_editor_control_secondary ⇒ Wx::Window? Also known as: editor_control_secondary

Returns current active secondary editor control or nil

Returns:



41
 
# File 'lib/wx/doc/pg/property_grid.rb', line 41

def get_editor_control_secondary; end

#get_editor_text_ctrl ⇒ Wx::TextCtrl Also known as: editor_text_ctrl

Returns TextCtrl active in currently selected property, if any.

Takes OwnerDrawnComboBox into account.

Returns:



440
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 440

def get_editor_text_ctrl; end

#get_empty_space_colour ⇒ Wx::Colour Also known as: empty_space_colour

Returns colour of empty space below properties.

Returns:



348
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 348

def get_empty_space_colour; end

#get_font_height ⇒ Integer Also known as: font_height

Returns height of highest characters of used font.

Returns:

  • (Integer) 


353
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 353

def get_font_height; end

#get_good_editor_dialog_position(p, sz) ⇒ Wx::Point Also known as: good_editor_dialog_position

Generates position for a widget editor dialog box.

Parameters:

  • p (Wx::PG::PGProperty) —

    Property the editor dialog is to be shown for.

  • sz (Wx::Size) —

    Size of the editor dialog to be shown.

Returns:

  • (Wx::Point) —

    Best position to show the dialog.



31
 
# File 'lib/wx/doc/pg/property_grid.rb', line 31

def get_good_editor_dialog_position(p, sz) end

#get_grid ⇒ Wx::PG::PropertyGrid Also known as: grid

Returns pointer to itself.

Dummy function that enables same kind of code to use Wx::PG::PropertyGrid and Wx::PG::PropertyGridManager.

Returns:



360
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 360

def get_grid; end

#get_image_rect(property, item) ⇒ Wx::Rect Also known as: image_rect

Returns rectangle of custom paint image.

Parameters:

  • property (Wx::PG::PGProperty) —

    Return image rectangle for this property.

  • item (Integer) —

    Which choice of property to use (each choice may have different image).

Returns:



367
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 367

def get_image_rect(property, item) end

#get_image_size(property = nil, item = -1)) ⇒ Wx::Size Also known as: image_size

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

Parameters:

  • property (Wx::PG::PGProperty) (defaults to: nil) —

    Return image rectangle for this property. If this argument is NULL, then preferred size is returned.

  • item (Integer) (defaults to: -1)) —

    Which choice of property to use (each choice may have different image).

Returns:



374
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 374

def get_image_size(property=nil, item=-1) end

#get_label_editor ⇒ Wx::TextCtrl Also known as: label_editor

Returns currently active label editor, NULL if none.

Returns:



303
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 303

def get_label_editor; end

#get_last_item(flags = Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_DEFAULT) ⇒ Wx::PG::PGProperty Also known as: last_item

Returns last item which could be iterated using given flags.

Parameters:

  • flags (Integer) (defaults to: Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_DEFAULT) —

    See wxPropertyGridIterator Flags.

Returns:



380
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 380

def get_last_item(flags=Wx::PG::PG_ITERATOR_FLAGS::PG_ITERATE_DEFAULT) end

#get_line_colour ⇒ Wx::Colour Also known as: line_colour

Returns colour of lines between cells.

Returns:



385
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 385

def get_line_colour; end

#get_margin_colour ⇒ Wx::Colour Also known as: margin_colour

Returns background colour of margin.

Returns:



390
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 390

def get_margin_colour; end

#get_margin_width ⇒ Integer Also known as: margin_width

Returns margin width.

Returns:

  • (Integer) 


395
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 395

def get_margin_width; end

#get_panel ⇒ Wx::Window Also known as: panel

Returns Window that the properties are painted on, and which should be used as the parent for editor controls.

Returns:



308
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 308

def get_panel; end

#get_primary_editor ⇒ Wx::Window Also known as: primary_editor

Returns current active primary editor control or nil

Returns:



36
 
# File 'lib/wx/doc/pg/property_grid.rb', line 36

def get_primary_editor; end

#get_property_rect(first, last) ⇒ Wx::Rect Also known as: property_rect

Returns rectangle that fully contains properties between and including first and last. Rectangle is in virtual scrolled window coordinates.

Parameters:

Returns:



49
 
# File 'lib/wx/doc/pg/property_grid.rb', line 49

def get_property_rect(first, last) end

#get_root ⇒ Wx::PG::PGProperty Also known as: root

Returns “root property”.

It does not have name, etc. and it is not visible. It is only useful for accessing its children.

Returns:



402
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 402

def get_root; end

#get_row_height ⇒ Integer Also known as: row_height

Returns height of a single grid row (in pixels).

Returns:

  • (Integer) 


407
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 407

def get_row_height; end

#get_selected_property ⇒ Wx::PG::PGProperty Also known as: selected_property

Returns currently selected property.

Returns:



412
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 412

def get_selected_property; end

#get_selection ⇒ Wx::PG::PGProperty Also known as: selection

Returns currently selected property.

Returns:



417
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 417

def get_selection; end

#get_selection_background_colour ⇒ Wx::Colour Also known as: selection_background_colour

Returns current selection background colour.

Returns:



422
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 422

def get_selection_background_colour; end

#get_selection_foreground_colour ⇒ Wx::Colour Also known as: selection_foreground_colour

Returns current selection text colour.

Returns:



427
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 427

def get_selection_foreground_colour; end

#get_splitter_position(splitterIndex = 0) ⇒ Integer Also known as: splitter_position

Returns current splitter x position.

Parameters:

  • splitterIndex (Integer) (defaults to: 0)

Returns:

  • (Integer) 


433
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 433

def get_splitter_position(splitterIndex=0) end

#get_status_bar ⇒ Wx::StatusBar Also known as: status_bar

Return StatusBar that is used by this Wx::PG::PropertyGrid.

You can reimplement this member function in derived class to override the default behaviour of using the top-level Frame‘s status bar, if any.

Returns:



66
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 66

def get_status_bar; end

#get_uncommitted_property_value ⇒ Wx::Variant Also known as: uncommitted_property_value

Returns most up-to-date value of selected property.

This will return value different from #get_selected_property->GetValue() only when text editor is activate and string edited by user represents valid, uncommitted property value.

Returns:



115
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 115

def get_uncommitted_property_value; end

#get_unspecified_value_appearance ⇒ Wx::PG::PGCell Also known as: unspecified_value_appearance

Returns current appearance of unspecified value cells.

Returns:

See Also:



448
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 448

def get_unspecified_value_appearance; end

#get_unspecified_value_text(argFlags = 0) ⇒ String Also known as: unspecified_value_text

Returns (visual) text representation of the unspecified property value.

Parameters:

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

    For internal use only.

Returns:

  • (String) 


454
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 454

def get_unspecified_value_text(argFlags=0) end

#get_vertical_spacing ⇒ Integer Also known as: vertical_spacing

Returns current vertical spacing.

Returns:

  • (Integer) 


459
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 459

def get_vertical_spacing; end

#hit_test(pt) ⇒ Wx::PG::PropertyGridHitTestResult

Returns information about arbitrary position in the grid.

Parameters:

  • pt (Array(Integer, Integer), Wx::Point) —

    Coordinates in the virtual grid space. You may need to use Wx::Scrolled<T>#calc_scrolled_position for translating Wx::PG::PropertyGrid client coordinates into something this member function can use.

Returns:



465
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 465

def hit_test(pt) end

#is_any_modified ⇒ Boolean Also known as: any_modified?

Returns true if any property has been modified by the user.

Returns:

  • (Boolean) 


469
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 469

def is_any_modified; end

#is_editor_focused ⇒ Boolean Also known as: editor_focused?

Returns true if a property editor control has focus.

Returns:

  • (Boolean) 


474
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 474

def is_editor_focused; end

#is_editors_value_modified ⇒ Boolean Also known as: editors_value_modified?

Returns true if editor’s value was marked modified.

Returns:

  • (Boolean) 


120
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 120

def is_editors_value_modified; end

#is_frozen ⇒ Boolean Also known as: frozen?

Returns true if updating is frozen (i.e.

Window#freeze called but not yet Window#thaw ).

Returns:

  • (Boolean) 


481
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 481

def is_frozen; end

#make_column_editable(column, editable = true) ⇒ void

This method returns an undefined value.

Makes given column editable by user.

Note that column must not be equal to 1, as the second column is always editable and can be made read-only only on cell-by-cell basis using

# see Wx::PG::PGProperty#change_flag
  property.change_flag(Wx::PG::PG_PROP_READONLY, true)

Parameters:

  • column (Integer) —

    The index of the column to make editable.

  • editable (Boolean) (defaults to: true) —

    Using false here will disable column from being editable.

See Also:



496
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 496

def make_column_editable(column, editable=true) end

#on_tlp_changing(newTLP) ⇒ void

This method returns an undefined value.

It is recommended that you call this function any time your code causes Wx::PG::PropertyGrid‘s top-level parent to change.

Wx::PG::PropertyGrid‘s OnIdle() handler should be able to detect most changes, but it is not perfect.

Remark:

This function is automatically called from Wx::PG::PropertyGrid:: Window#reparent and Wx::PG::PropertyGridManager#reparent. You only need to use it if you reparent Wx::PG::PropertyGrid indirectly.

Parameters:

  • newTLP (Wx::Window) —

    New top-level parent that is about to be set. Old top-level parent window should still exist as the current one.



509
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 509

def on_tlp_changing(newTLP) end

#refresh_editor ⇒ void

This method returns an undefined value.

Refreshes any active editor control.



513
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 513

def refresh_editor; end

#refresh_property(p) ⇒ void

This method returns an undefined value.

Redraws given property.

Parameters:



518
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 518

def refresh_property(p) end

#remove_from_selection(id) ⇒ Boolean

Removes given property from selection.

If property is not selected, an assertion failure will occur.

Parameters:

Returns:

  • (Boolean) 


537
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 537

def remove_from_selection(id) end

#reset_colours ⇒ void

This method returns an undefined value.

Resets all colours to the original system values.



522
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 522

def reset_colours; end

#reset_column_sizes(enableAutoResizing = false) ⇒ void

This method returns an undefined value.

Resets column sizes and splitter positions, based on proportions.

Parameters:

See Also:



530
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 530

def reset_column_sizes(enableAutoResizing=false) end

#select_property(id, focus = false) ⇒ Boolean

Selects a property.

Editor widget is automatically created, but not focused unless focus is true.

returns true if selection finished successfully. Usually only fails if current value in editor is not valid.

Remark:

In wxWidgets 2.9 and later, this function no longer sends EVT_PG_SELECTED.

Remark:

This clears any previous selection.

Parameters:

  • id (String, Wx::PG::PGProperty) —

    Property to select (name or pointer).

  • focus (Boolean) (defaults to: false) —

    If true, move keyboard focus to the created editor right away.

Returns:

  • (Boolean)

See Also:



560
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 560

def select_property(id, focus=false) end

#set_caption_background_colour(col) ⇒ void Also known as: caption_background_colour=

This method returns an undefined value.

Sets category caption background colour.

Parameters:



565
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 565

def set_caption_background_colour(col) end

#set_caption_text_colour(col) ⇒ void Also known as: caption_text_colour=

This method returns an undefined value.

Sets category caption text colour.

Parameters:



571
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 571

def set_caption_text_colour(col) end

#set_cell_background_colour(col) ⇒ void Also known as: cell_background_colour=

This method returns an undefined value.

Sets default cell background colour - applies to property cells.

Note that appearance of editor widgets may not be affected.

Parameters:



579
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 579

def set_cell_background_colour(col) end

#set_cell_disabled_text_colour(col) ⇒ void Also known as: cell_disabled_text_colour=

This method returns an undefined value.

Sets cell text colour for disabled properties.

Parameters:



585
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 585

def set_cell_disabled_text_colour(col) end

#set_cell_text_colour(col) ⇒ void Also known as: cell_text_colour=

This method returns an undefined value.

Sets default cell text colour - applies to property name and value text.

Note that appearance of editor widgets may not be affected.

Parameters:



593
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 593

def set_cell_text_colour(col) end

#set_column_count(colCount) ⇒ void Also known as: column_count=

This method returns an undefined value.

Set number of columns (2 or more).

Parameters:

  • colCount (Integer) 


599
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 599

def set_column_count(colCount) end

#set_current_category(id) ⇒ void Also known as: current_category=

This method returns an undefined value.

Sets the ‘current’ category - Append will add non-category properties under it.

Parameters:



605
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 605

def set_current_category(id) end

#set_empty_space_colour(col) ⇒ void Also known as: empty_space_colour=

This method returns an undefined value.

Sets colour of empty space below properties.

Parameters:



611
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 611

def set_empty_space_colour(col) end

#set_line_colour(col) ⇒ void Also known as: line_colour=

This method returns an undefined value.

Sets colour of lines between cells.

Parameters:



617
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 617

def set_line_colour(col) end

#set_margin_colour(col) ⇒ void Also known as: margin_colour=

This method returns an undefined value.

Sets background colour of margin.

Parameters:



623
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 623

def set_margin_colour(col) end

#set_selection(newSelection) ⇒ void Also known as: selection=

This method returns an undefined value.

Set entire new selection from given list of properties.

Parameters:



629
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 629

def set_selection(newSelection) end

#set_selection_background_colour(col) ⇒ void Also known as: selection_background_colour=

This method returns an undefined value.

Sets selection background colour - applies to selected property name background.

Parameters:



635
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 635

def set_selection_background_colour(col) end

#set_selection_text_colour(col) ⇒ void Also known as: selection_text_colour=

This method returns an undefined value.

Sets selection foreground colour - applies to selected property name text.

Parameters:



641
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 641

def set_selection_text_colour(col) end

#set_splitter_left(privateChildrenToo = false) ⇒ void Also known as: splitter_left=

This method returns an undefined value.

Moves splitter as left as possible, while still allowing all labels to be shown in full.

Parameters:

  • privateChildrenToo (Boolean) (defaults to: false) —

    If false, will still allow private children to be cropped.



660
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 660

def set_splitter_left(privateChildrenToo=false) end

#set_splitter_position(newxpos, col = 0) ⇒ void Also known as: splitter_position=

This method returns an undefined value.

Sets x coordinate of the splitter.

Remark:

Splitter position cannot exceed grid size, and therefore setting it during form creation may fail as initial grid size is often smaller than desired splitter position, especially when sizers are being used.

Parameters:

  • newxpos (Integer)
  • col (Integer) (defaults to: 0) 


654
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 654

def set_splitter_position(newxpos, col=0) end

#set_unspecified_value_appearance(cell) ⇒ void Also known as: unspecified_value_appearance=

This method returns an undefined value.

Sets appearance of value cells representing an unspecified property value.

Default appearance is blank.

Remark:

If you set the unspecified value to have any textual representation, then that will override "InlineHelp" attribute.

Parameters:

See Also:



676
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 676

def set_unspecified_value_appearance(cell) end

#set_vertical_spacing(vspacing) ⇒ void Also known as: vertical_spacing=

This method returns an undefined value.

Sets vertical spacing.

Can be 1, 2, or 3 - a value relative to font height. Value of 2 should be default on most platforms.

Parameters:

  • vspacing (Integer) 


684
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 684

def set_vertical_spacing(vspacing) end

#set_virtual_width(width) ⇒ void Also known as: virtual_width=

This method returns an undefined value.

Set virtual width for this particular page.

Width -1 indicates that the virtual width should be disabled.

Parameters:

  • width (Integer) 


692
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 692

def set_virtual_width(width) end

#setup_text_ctrl_value(text) ⇒ void

This method returns an undefined value.

Must be called in Wx::PG::PGEditor#create_controls if primary editor window is TextCtrl, just before textctrl is created.

Parameters:

  • text (String) —

    Initial text value of created TextCtrl.



698
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 698

def setup_text_ctrl_value(text) end

#show_property_error(id, msg) ⇒ void

This method returns an undefined value.

Shows a brief error message that is related to a property.

Parameters:



127
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 127

def show_property_error(id, msg) end

#unfocus_editor ⇒ Boolean

Unfocuses or closes editor if one was open, but does not deselect property.

Returns:

  • (Boolean) 


702
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 702

def unfocus_editor; end

#value_change_in_event(variant) ⇒ void

This method returns an undefined value.

Call this from Wx::PG::PGProperty#on_event to cause property value to be changed after the function returns (with true as return value).

#value_change_in_event must be used if you wish the application to be able to use EVT_PG_CHANGING to potentially veto the given value.

Parameters:

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


134
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 134

def value_change_in_event(variant) end

#was_value_changed_in_event ⇒ Boolean

You can use this member function, for instance, to detect in Wx::PG::PGProperty#on_event if Wx::PG::PGProperty#set_value_in_event was already called in Wx::PG::PGEditor#on_event.

It really only detects if was value was changed using Wx::PG::PGProperty#set_value_in_event, which is usually used when a ‘picker’ dialog is displayed. If value was written by “normal means” in Wx::PG::PGProperty#string_to_value or IntToValue(), then this function will return false (on the other hand, Wx::PG::PGProperty#on_event is not even called in those cases).

Returns:

  • (Boolean) 


140
 
# File 'lib/wx/doc/gen/pg/property_grid.rb', line 140

def was_value_changed_in_event; end