Class: Wx::PG::PropertyGridPage

Inherits:
EvtHandler show all
Includes:
PropertyGridInterface
Defined in:
lib/wx/doc/gen/pg/property_grid_page.rb

Overview

Holder of property grid page information.

You can subclass this and give instance in Wx::PG::PropertyGridManager#add_page. It inherits from EvtHandler and can be used to process events specific to this page (id of events will still be same as manager’s). If you don’t want to use it to process all events of the page, you need to return false in the derived #is_handling_all_events. Please note that PropertyGridPage lacks many non-const property manipulation functions found in PropertyGridManager. Please use parent manager (m_manager member variable) when needed. 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.

Event Handling

PropertyGridPage receives events emitted by its PropertyGridManager, but only those events that are specific to that page. If PropertyGridPage:: IsHandlingAllEvents returns false, then unhandled events are sent to the manager’s parent, as usual. See wxPropertyGrid Event Handling for more information.

Category: PropertyGrid

Requires:

  • USE_PROPGRID

Instance Method Summary collapse

Methods included from PropertyGridInterface

#append, #append_in, #begin_add_children, #change_property_value, #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_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 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

#initializeWx::PG::PropertyGridPage



93
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 93

def initialize; end

Instance Method Details

#check_column_widths(widthChange = 0) ⇒ void

This method returns an undefined value.

Makes sure all columns have minimum width.

Parameters:

  • widthChange (Integer) (defaults to: 0)


181
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 181

def check_column_widths(widthChange=0) end

#clearvoid

This method returns an undefined value.

Deletes all properties on page.



97
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 97

def clear; end

#do_delete(item) ⇒ void

This method returns an undefined value.

Override this member function to add custom behaviour on property deletion.

Parameters:



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

def do_delete(item) end

#do_insert(parent, index, property) ⇒ Wx::PG::PGProperty

Override this member function to add custom behaviour on property insertion.

Parameters:

Returns:



193
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 193

def do_insert(parent, index, property) end

#enable_categories(enable) ⇒ Boolean

Parameters:

  • enable (Boolean)

Returns:

  • (Boolean)


197
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 197

def enable_categories(enable) end

#ensure_virtual_heightvoid

This method returns an undefined value.

Make sure virtual height is up-to-date.



201
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 201

def ensure_virtual_height; end

#fit_columnsWx::Size

Reduces column sizes to minimum possible that contents are still visibly (naturally some margin space will be applied as well).

Returns minimum size for the page to still display everything.

Remark:

This function only works properly if size of containing grid was already fairly large.

Note that you can also get calculated column widths by calling #get_column_width immediately after this function returns.

Returns:



111
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 111

def fit_columns; end

#get_actual_virtual_heightInteger Also known as: actual_virtual_height

Returns actual height of contained visible properties.

Remark:

Mostly used for internal diagnostic purposes.

Returns:

  • (Integer)


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

def get_actual_virtual_height; end

#get_column_countInteger Also known as: column_count

Returns:

  • (Integer)


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

def get_column_count; end

#get_column_full_width(p, col) ⇒ Integer Also known as: column_full_width

Parameters:

Returns:

  • (Integer)


260
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 260

def get_column_full_width(p, col) end

#get_column_min_width(column) ⇒ Integer Also known as: column_min_width

Parameters:

  • column (Integer)

Returns:

  • (Integer)


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

def get_column_min_width(column) end

#get_column_width(column) ⇒ Integer Also known as: column_width

Parameters:

  • column (Integer)

Returns:

  • (Integer)


230
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 230

def get_column_width(column) end

#get_gridWx::PG::PropertyGrid Also known as: grid



234
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 234

def get_grid; end

#get_indexInteger Also known as: index

Returns page index in manager;.

Returns:

  • (Integer)


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

def get_index; end

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

Parameters:

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

Returns:



239
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 239

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

#get_property_category(p) ⇒ Wx::PG::PropertyCategory Also known as: property_category

Parameters:

Returns:



249
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 249

def get_property_category(p) end

#get_rootWx::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:



122
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 122

def get_root; end

#get_selectionWx::PG::PGProperty Also known as: selection

Returns currently selected property.

Returns:



244
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 244

def get_selection; end

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

Returns x-coordinate position of splitter on a page.

Parameters:

  • col (Integer) (defaults to: 0)

Returns:

  • (Integer)


128
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 128

def get_splitter_position(col=0) end

#get_tool_idInteger Also known as: tool_id

Returns id of the tool bar item that represents this page on Wx::PG::PropertyGridManager‘s ToolBar.

Returns:

  • (Integer)


133
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 133

def get_tool_id; end

#get_virtual_heightInteger Also known as: virtual_height

Returns (precalculated) height of contained visible properties.

Returns:

  • (Integer)


205
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 205

def get_virtual_height; end

#get_virtual_widthInteger Also known as: virtual_width

Returns combined width of margin and all the columns.

Returns:

  • (Integer)


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

def get_virtual_width; end

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

Returns information about arbitrary position in the grid.

Parameters:

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

    Logical coordinates in the virtual grid space. Use Wx::Scrolled<T>#calc_unscrolled_position if you need to translate a scrolled position into a logical one.

Returns:



266
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 266

def hit_test(pt) end

#initvoid

This method returns an undefined value.

Do any member initialization in this method.

Remark:

- Called every time the page is added into a manager. - You can add properties to the page here.



147
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 147

def init; end

#is_displayedBoolean Also known as: displayed?

Returns true if page is visibly displayed.

Returns:

  • (Boolean)


270
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 270

def is_displayed; end

#is_handling_all_eventsBoolean Also known as: handling_all_events?

Return false here to indicate unhandled events should be propagated to manager’s parent, as normal.

Returns:

  • (Boolean)


151
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 151

def is_handling_all_events; end

#is_in_non_cat_modeBoolean Also known as: in_non_cat_mode?

Returns:

  • (Boolean)


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

def is_in_non_cat_mode; end

#on_showvoid

This method returns an undefined value.

Called every time page is about to be shown.

Useful, for instance, creating properties just-in-time.



158
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 158

def on_show; end

#refresh_property(p) ⇒ void

This method returns an undefined value.

Refreshes given property on page.

Parameters:



163
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 163

def refresh_property(p) end

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

This method returns an undefined value.

Sets splitter position on page.

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:

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


175
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 175

def set_splitter_position(splitterPos, col=0) end

#virtual_height_changedvoid

This method returns an undefined value.

Called after virtual height needs to be recalculated.



279
# File 'lib/wx/doc/gen/pg/property_grid_page.rb', line 279

def virtual_height_changed; end