Class: Wx::PG::PropertyGridManager

Inherits:
Wx::Panel show all
Includes:
PropertyGridInterface
Defined in:
lib/wx/doc/gen/pg/property_grid_manager.rb

Overview

PropertyGridManager is an efficient multi-page version of PropertyGrid, which can optionally have toolbar for mode and page selection, a help text box, and a header.

PropertyGridManager inherits from PropertyGridInterface, and as such it has most property manipulation functions. However, only some of them affect properties on all pages (e.g. Wx::PG::PropertyGridInterface#get_property_by_name and Wx::PG::PropertyGridInterface#expand_all), while some (e.g. Wx::PG::PropertyGridInterface#append) only apply to the currently selected page. To operate explicitly on properties on specific page, use #get_page to obtain pointer to page’s PropertyGridPage object. Visual methods, such as SetCellBackgroundColour() are only available in PropertyGrid. Use #get_grid to obtain pointer to it. Non-virtual iterators will not work in PropertyGridManager. Instead, you must acquire the internal grid (#get_grid) or PropertyGridPage object (#get_page). PropertyGridManager constructor has exact same format as PropertyGrid constructor, and basically accepts same extra window style flags (albeit also has some extra ones). Here’s some example code for creating and populating a PropertyGridManager:

pgMan = Wx::PG::PropertyGridManager.new(self, PGID,
      Wx::DEFAULT_POSITION, Wx::DEFAULT_SIZE,
      # These and other similar styles are automatically
      # passed to the embedded wxPropertyGrid.
      Wx::PG::PG_BOLD_MODIFIED|Wx::PG::PG_SPLITTER_AUTO_CENTER|
      # Include toolbar.
      Wx::PG::PG_TOOLBAR |
      # Include description box.
      Wx::PG::PG_DESCRIPTION |
      # Include compactor.
      Wx::PG::PG_COMPACTOR |
      # Plus defaults.
      wxPGMAN_DEFAULT_STYLE)
  
  page = pgMan.add_page("First Page")
  
  page.append(Wx::PG::PropertyCategory.new("Category A1"))
  
  page.append(Wx::PG::IntProperty.new("Number",Wx::PG::PG_LABEL,1))
  
  page.append(Wx::PG::ColourProperty.new("Colour",Wx::PG::PG_LABEL,Wx::WHITE))
  
  page = pgMan.add_page("Second Page")
  
  page.append(Wx::PG::StringProperty.new("Text", Wx::PG::PG_LABEL, "(no text)"))
  
  page.append(Wx::PG::FontProperty.new("Font",Wx::PG::PG_LABEL))
  
  # Display a header above the grid
  pgMan.show_header

Window Styles

See wxPropertyGrid Window Styles.

Event Handling

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_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_shown, #is_property_value_unspecified, #limit_property_editing, #refresh_grid, #refresh_property, 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 Wx::Panel

#accepts_focus, #init_dialog, #layout, #on_sys_colour_changed, #set_focus, #set_focus_ignoring_children

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_prepare_update_window_ui, #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_cursor_bundle, #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, #hit_test, #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_frozen, #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, #msw_disable_composited, #navigate, #navigate_in, new_control_id, #on_internal_idle, #page_down, #page_up, #paint, #paint_buffered, #pop_event_handler, #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_cursor_bundle, #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_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_label_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_label_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_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_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, #try_after, #try_before, #unlink

Methods inherited from Object

#clone, #dup, #is_same_as, #un_share

Constructor Details

#initialize ⇒ Wx::PG::PropertyGridManager #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::PG::PGMAN_DEFAULT_STYLE, name = Wx::PROPERTY_GRID_MANAGER_NAME_STR) ⇒ Wx::PG::PropertyGridManager #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::PG::PGMAN_DEFAULT_STYLE, name = Wx::PROPERTY_GRID_MANAGER_NAME_STR) {|win| ... } ⇒ Wx::PG::PropertyGridManager

Returns a new instance of PropertyGridManager.

Overloads:

  • #initialize ⇒ Wx::PG::PropertyGridManager

    Two step constructor.

    Call Create when this constructor is called to build up the Wx::PG::PropertyGridManager.

  • #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::PG::PGMAN_DEFAULT_STYLE, name = Wx::PROPERTY_GRID_MANAGER_NAME_STR) ⇒ Wx::PG::PropertyGridManager

    The default 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::PGMAN_DEFAULT_STYLE)
    • name (String) (defaults to: Wx::PROPERTY_GRID_MANAGER_NAME_STR)

    See Also:

    • Window Styles
  • #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::PG::PGMAN_DEFAULT_STYLE, name = Wx::PROPERTY_GRID_MANAGER_NAME_STR) {|win| ... } ⇒ Wx::PG::PropertyGridManager

    The default 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::PGMAN_DEFAULT_STYLE)
    • name (String) (defaults to: Wx::PROPERTY_GRID_MANAGER_NAME_STR)

    Yield Parameters:

    See Also:

    • Window Styles


98
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 98

def initialize(*args) end

Instance Method Details

#add_page(label = (''), bmp = (Wx::BitmapBundle.new()), pageObj = nil) ⇒ Wx::PG::PropertyGridPage

Creates new property page.

Note that the first page is not created automatically.

Returns pointer to created property grid page.

Remark:

If toolbar is used, it is highly recommended that the pages are added when the toolbar is not turned off using window style flag switching. Otherwise toolbar buttons might not be added properly.

Parameters:

  • label (String) (defaults to: ('')) —

    A label for the page. This may be shown as a toolbar tooltip etc.

  • bmp (Wx::BitmapBundle, Wx::Bitmap, Wx::Icon, Wx::Image) (defaults to: (Wx::BitmapBundle.new())) —

    Bitmap bundle for toolbar image. If the bundle is empty, then a built-in default bitmap bundle is used.

  • pageObj (Wx::PG::PropertyGridPage) (defaults to: nil) —

    Wx::PG::PropertyGridPage instance. Manager will take ownership of this object. nil indicates that a default page instance should be created.

Returns:



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

def add_page(label=(''), bmp=(Wx::BitmapBundle.new()), pageObj=nil) end

#clear ⇒ void

This method returns an undefined value.

Deletes all properties and all pages.



119
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 119

def clear; end

#clear_page(page) ⇒ void

This method returns an undefined value.

Deletes all properties on given page.

Parameters:

  • page (Integer) 


124
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 124

def clear_page(page) end

#commit_changes_from_editor(flags = PGSelectPropertyFlags::Null) ⇒ Boolean

Forces updating the value of property from the editor control.

Returns true if value was actually updated.

Parameters:

  • flags (Wx::PGSelectPropertyFlags) (defaults to: PGSelectPropertyFlags::Null)

Returns:

  • (Boolean) 


131
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 131

def commit_changes_from_editor(flags=PGSelectPropertyFlags::Null) end

#create(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::PG::PGMAN_DEFAULT_STYLE, name = Wx::PROPERTY_GRID_MANAGER_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::PGMAN_DEFAULT_STYLE)
  • name (String) (defaults to: Wx::PROPERTY_GRID_MANAGER_NAME_STR)

Returns:

  • (Boolean)

See Also:

  • Window Styles


144
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 144

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

#enable_categories(enable) ⇒ Boolean

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

Remark:

Calling this may not properly update toolbar buttons.

Parameters:

  • enable (Boolean)

Returns:

  • (Boolean) 


155
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 155

def enable_categories(enable) end

#ensure_visible(id) ⇒ Boolean

Selects page, scrolls and/or expands items to ensure that the given item is visible.

Returns true if something was actually done.

Parameters:

Returns:

  • (Boolean) 


162
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 162

def ensure_visible(id) end

#get_column_count(page = -1)) ⇒ Integer Also known as: column_count

Returns number of columns on given page.

By the default, returns number of columns on current page.

Parameters:

  • page (Integer) (defaults to: -1))

Returns:

  • (Integer) 


169
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 169

def get_column_count(page=-1) end

#get_current_page ⇒ Wx::PG::PropertyGridPage Also known as: current_page

Returns currently selected page.

Returns:



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

def get_current_page; end

#get_desc_box_height ⇒ Integer Also known as: desc_box_height

Returns height of the description text box.

Returns:

  • (Integer) 


174
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 174

def get_desc_box_height; end

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

Returns pointer to the contained Wx::PG::PropertyGrid.

This does not change after Wx::PG::PropertyGridManager has been created, so you can safely obtain pointer once and use it for the entire lifetime of the manager instance.

Returns:



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

def get_grid; end

#get_page(ind) ⇒ Wx::PG::PropertyGridPage #get_page(name) ⇒ Wx::PG::PropertyGridPage Also known as: page

Overloads:



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

def get_page(*args) end

#get_page_by_name(name) ⇒ Integer Also known as: page_by_name

Returns index for a page name.

If no match is found, NOT_FOUND is returned.

Parameters:

  • name (String)

Returns:

  • (Integer) 


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

def get_page_by_name(name) end

#get_page_by_state(pstate) ⇒ Integer Also known as: page_by_state

Returns index for a relevant property grid state.

If no match is found, NOT_FOUND is returned.

Parameters:

Returns:

  • (Integer) 


213
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 213

def get_page_by_state(pstate) end

#get_page_count ⇒ Integer Also known as: page_count

Returns number of managed pages.

Returns:

  • (Integer) 


218
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 218

def get_page_count; end

#get_page_name(index) ⇒ Wx::String Also known as: page_name

Returns name of given page.

Parameters:

  • index (Integer)

Returns:

  • (Wx::String) 


224
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 224

def get_page_name(index) end

#get_page_root(index) ⇒ Wx::PG::PGProperty Also known as: page_root

Returns “root property” of the given page.

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

Parameters:

  • index (Integer)

Returns:



232
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 232

def get_page_root(index) end

#get_selected_page ⇒ Integer Also known as: selected_page

Returns index to currently selected page.

Returns:

  • (Integer) 


237
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 237

def get_selected_page; end

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

Alias for #get_selection.

Returns:



242
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 242

def get_selected_property; end

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

Shortcut for #get_grid->#get_selection.

Returns:



247
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 247

def get_selection; end

#get_tool_bar ⇒ Wx::ToolBar Also known as: tool_bar

Returns a pointer to the toolbar currently associated with the Wx::PG::PropertyGridManager (if any).

Returns:



252
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 252

def get_tool_bar; end

#insert_page(index, label, bmp = (Wx::BitmapBundle.new()), pageObj = nil) ⇒ Wx::PG::PropertyGridPage

Creates new property page.

Note that the first page is not created automatically.

Returns pointer to created page.

Parameters:

  • index (Integer) —

    Add to this position. -1 will add as the last item.

  • label (String) —

    A label for the page. This may be shown as a toolbar tooltip etc.

  • bmp (Wx::BitmapBundle, Wx::Bitmap, Wx::Icon, Wx::Image) (defaults to: (Wx::BitmapBundle.new())) —

    Bitmap bundle for toolbar image. If the bundle is empty, then a built-in default bitmap bundle is used.

  • pageObj (Wx::PG::PropertyGridPage) (defaults to: nil) —

    Wx::PG::PropertyGridPage instance. Manager will take ownership of this object. If nil, default page object is constructed.

Returns:



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

def insert_page(index, label, bmp=(Wx::BitmapBundle.new()), pageObj=nil) end

#is_any_modified ⇒ Boolean Also known as: any_modified?

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

Returns:

  • (Boolean) 


269
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 269

def is_any_modified; end

#is_page_modified(index) ⇒ Boolean Also known as: page_modified?

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

Parameters:

  • index (Integer)

Returns:

  • (Boolean) 


275
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 275

def is_page_modified(index) end

#is_property_selected(id) ⇒ Boolean Also known as: property_selected?

Returns true if property is selected.

Since selection is page based, this function checks every page in the manager.

Parameters:

Returns:

  • (Boolean) 


283
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 283

def is_property_selected(id) end

#remove_page(page) ⇒ Boolean

Removes a page.

Returns false if it was not possible to remove page in question.

Parameters:

  • page (Integer)

Returns:

  • (Boolean) 


291
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 291

def remove_page(page) end

#select_page(index) ⇒ void #select_page(label) ⇒ void #select_page(page) ⇒ void

Overloads:

  • #select_page(index) ⇒ void

    This method returns an undefined value.

    Select and displays a given page.

    Parameters:

    • index (Integer) —

      Index of page being selected. Can be -1 to select nothing.

  • #select_page(label) ⇒ void

    This method returns an undefined value.

    Select and displays a given page (by label).

    Parameters:

    • label (String)
  • #select_page(page) ⇒ void

    This method returns an undefined value.

    Select and displays a given page.

    Parameters:



305
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 305

def select_page(*args) end

#select_property(id, focus = false) ⇒ Boolean

Select a property.

Parameters:

Returns:

  • (Boolean)

See Also:



315
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 315

def select_property(id, focus=false) end

#set_column_count(colCount, page = -1)) ⇒ void Also known as: column_count=

This method returns an undefined value.

Sets number of columns on given page (default is current page).

Remark:

If you use header, then you should always use this member function to set the column count, instead of ones present in Wx::PG::PropertyGrid or Wx::PG::PropertyGridPage.

Parameters:

  • colCount (Integer)
  • page (Integer) (defaults to: -1)) 


327
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 327

def set_column_count(colCount, page=-1) end

#set_column_title(idx, title) ⇒ void

This method returns an undefined value.

Sets a column title.

Default title for column 0 is “Property”, and “Value” for column 1.

Remark:

If header is not shown yet, then calling this member function will make it visible.

Parameters:

  • idx (Integer)
  • title (String) 


342
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 342

def set_column_title(idx, title) end

#set_desc_box_height(ht, refresh = true) ⇒ void Also known as: desc_box_height=

This method returns an undefined value.

Sets y coordinate of the description box splitter.

Parameters:

  • ht (Integer)
  • refresh (Boolean) (defaults to: true) 


354
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 354

def set_desc_box_height(ht, refresh=true) end

#set_description(label, content) ⇒ void

This method returns an undefined value.

Sets label and text in description box.

Parameters:

  • label (String)
  • content (String) 


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

def set_description(label, content) end

#set_page_splitter_left(page, subProps = false) ⇒ void Also known as: page_splitter_left=

This method returns an undefined value.

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

Parameters:

  • page (Integer)
  • subProps (Boolean) (defaults to: false) 


368
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 368

def set_page_splitter_left(page, subProps=false) end

#set_page_splitter_position(page, pos, column = 0) ⇒ void

This method returns an undefined value.

Sets splitter position on individual page.

Remark:

If you use header, then you should always use this member function to set the splitter position, instead of ones present in Wx::PG::PropertyGrid or Wx::PG::PropertyGridPage.

Parameters:

  • page (Integer)
  • pos (Integer)
  • column (Integer) (defaults to: 0) 


382
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 382

def set_page_splitter_position(page, pos, column=0) end

#set_splitter_left(subProps = false, allPages = true) ⇒ 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:

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

    If false, will still allow sub-properties (i.e. properties which parent is not root or category) to be cropped.

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

    If true, takes labels on all pages into account.



361
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 361

def set_splitter_left(subProps=false, allPages=true) end

#set_splitter_position(pos, column = 0) ⇒ void Also known as: splitter_position=

This method returns an undefined value.

Sets splitter position for all pages.

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.

If you use header, then you should always use this member function to set the splitter position, instead of ones present in Wx::PG::PropertyGrid or Wx::PG::PropertyGridPage.

Parameters:

  • pos (Integer)
  • column (Integer) (defaults to: 0) 


396
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 396

def set_splitter_position(pos, column=0) end

#show_header(show = true) ⇒ void

This method returns an undefined value.

Show or hide the property grid header control.

It is hidden by the default.

Remark:

Grid may look better if you use Wx::PG::PG_WINDOW_STYLES::PG_NO_INTERNAL_BORDER window style when showing a header.

Parameters:

  • show (Boolean) (defaults to: true) 


410
 
# File 'lib/wx/doc/gen/pg/property_grid_manager.rb', line 410

def show_header(show=true) end