Class: Wx::HeaderCtrl

Inherits:

Control

• Object
• Object
• EvtHandler
• Window
• Control
• Wx::HeaderCtrl

Defined in:

lib/wx/doc/gen/header_ctrl.rb

Overview

HeaderCtrl is the control containing the column headings which is usually used for display of tabular data.

It is used as part of GRID::Grid, in generic version DataViewCtrl and report view of ListCtrl but can be also used independently. In general this class is meant to be used as part of another control which already stores the column information somewhere as it can’t be used directly: instead you need to inherit from it and implement the #get_column method to provide column information. See HeaderCtrlSimple for a concrete control class which can be used directly. In addition to labeling the columns, the control has the following features:

• Column reordering support, either by explicitly configuring the columns order and calling #set_columns_order or by dragging the columns interactively (if enabled).

• Display of the icons in the header: this is often used to display a sort or reverse sort indicator when the column header is clicked.

Notice that this control itself doesn’t do anything other than displaying the column headers. In particular column reordering and sorting must still be supported by the associated control displaying the real data under the header. Also remember to call Window#scroll_window method of the control if the associated data display window has a horizontal scrollbar, otherwise the headers wouldn’t align with the data when the window is scrolled. This control is implemented using the native header control under MSW systems and a generic implementation elsewhere.

Future Improvements

Some features are supported by the native MSW control and so could be easily implemented in this version of HeaderCtrl but need to be implemented in the generic version as well to be really useful. Please let us know if you need or, better, plan to work on implementing, any of them:

• Displaying bitmaps instead of or together with the text

• Custom drawn headers

• Filters associated with a column.

  Styles

This class supports the following styles:

• HD_ALLOW_REORDER: If this style is specified (it is by default), the user can reorder the control columns by dragging them.

• HD_ALLOW_HIDE: If this style is specified, the control shows a popup menu allowing the user to change the columns visibility on right mouse click. Notice that the program can always hide or show the columns, this style only affects the users capability to do it.

• HD_BITMAP_ON_RIGHT: The column image, if any, will be shown on the right side if this style is used. Note that this style is only implemented in WXMSW currently and doesn't do anything under the other platforms. It is available since wxWidgets 3.1.1.

• HD_DEFAULT_STYLE: Symbolic name for the default control style, currently equal to HD_ALLOW_REORDER.

Events emitted by this class

The following event-handler methods redirect the events to member method or handler blocks for HeaderCtrlEvent events. Event handler methods for events emitted by this class:

• EvtHandler#evt_header_click(id, meth = nil, &block): A column heading was clicked.

• EvtHandler#evt_header_right_click(id, meth = nil, &block): A column heading was right clicked.

• EvtHandler#evt_header_middle_click(id, meth = nil, &block): A column heading was clicked with the middle mouse button.

• EvtHandler#evt_header_dclick(id, meth = nil, &block): A column heading was double clicked.

• EvtHandler#evt_header_right_dclick(id, meth = nil, &block): A column heading was right double clicked.

• EvtHandler#evt_header_middle_dclick(id, meth = nil, &block): A column heading was double clicked with the middle mouse button.

• EvtHandler#evt_header_separator_dclick(id, meth = nil, &block): Separator to the right of the specified column was double clicked (this action is commonly used to resize the column to fit its contents width and the control provides #update_column_width_to_fit method to make implementing this easier).

• EvtHandler#evt_header_begin_resize(id, meth = nil, &block): The user started to drag the separator to the right of the column with the specified index (this can only happen for the columns for which Wx::HeaderColumn#is_resizeable returns true). The event can be vetoed to prevent the column from being resized. If it isn't, the resizing and end resize (or dragging cancelled) events will be generated later.

• EvtHandler#evt_header_resizing(id, meth = nil, &block): The user is dragging the column with the specified index resizing it and its current width is Wx::HeaderCtrlEvent#get_width. The event can be vetoed to stop the dragging operation completely at any time.

• EvtHandler#evt_header_end_resize(id, meth = nil, &block): The user stopped dragging the column by releasing the mouse. The column should normally be resized to the value of Wx::HeaderCtrlEvent#get_width.

• EvtHandler#evt_header_begin_reorder(id, meth = nil, &block): The user started to drag the column with the specified index (this can only happen for the controls with HD_ALLOW_REORDER style). This event can be vetoed to prevent the column from being reordered, otherwise the end reorder message will be generated later.

• EvtHandler#evt_header_end_reorder(id, meth = nil, &block): The user dropped the column in its new location. The event can be vetoed to prevent the column from being placed at the new position or handled to update the display of the data in the associated control to match the new column location (available from Wx::HeaderCtrlEvent#get_new_order).

• EvtHandler#evt_header_dragging_cancelled(id, meth = nil, &block): The resizing or reordering operation currently in progress was cancelled. This can happen if the user pressed Esc key while dragging the mouse or the mouse capture was lost for some other reason. You only need to handle this event if your application entered into some modal mode when resizing or reordering began, in which case it should handle this event in addition to the matching end resizing or reordering ones.

Category: Controls

See Also:

• GRID::Grid
• ListCtrl
• DataViewCtrl

Direct Known Subclasses

HeaderCtrlSimple

Class Method Summary

• .move_column_in_order_array(order, idx, pos) ⇒ void

  Helper function to manipulate the array of column indices.

Instance Method Summary

• #add_columns_items(menu, idColumnsBase = 0) ⇒ void

  Helper function appending the checkable items corresponding to all the columns to the given menu.

• #create(parent, winid = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::HD_DEFAULT_STYLE, name = Wx::HEADER_CTRL_NAME_STR) ⇒ Boolean

  Create the header control window.

• #get_column(idx) ⇒ Wx::HeaderColumn (also: #column) protected

  Method to be implemented by the derived classes to return the information for the given column.

• #get_column_at(pos) ⇒ Integer (also: #column_at)

  Return the index of the column displayed at the given position.

• #get_column_count ⇒ Integer (also: #column_count)

  Return the number of columns in the control.

• #get_column_pos(idx) ⇒ Integer (also: #column_pos)

  Get the position at which this column is currently displayed.

• #get_column_title_width(*args) ⇒ Object (also: #column_title_width)
• #get_columns_order ⇒ Array<Integer> (also: #columns_order)

  Return the array describing the columns display order.

• #initialize(*args) ⇒ HeaderCtrl constructor

  A new instance of HeaderCtrl.

• #is_empty ⇒ Boolean (also: #empty?)

  Return whether the control has any columns.

• #on_column_count_changing(count) ⇒ void protected

  Can be overridden in the derived class to update internal data structures when the number of the columns in the control changes.

• #reset_columns_order ⇒ void

  Reset the columns order to the natural one.

• #set_column_count(count) ⇒ void (also: #column_count=)

  Set the number of columns in the control.

• #set_columns_order(order) ⇒ void (also: #columns_order=)

  Change the columns display order.

• #show_columns_menu(pt, title = ('')) ⇒ Boolean

  Show the popup menu allowing the user to show or hide the columns.

• #show_customize_dialog ⇒ Boolean

  Show the column customization dialog.

• #update_column(idx) ⇒ void

  Update the column with the given index.

• #update_column_visibility(idx, show) ⇒ void protected

  Method called when the column visibility is changed by the user.

• #update_column_width_to_fit(idx, widthTitle) ⇒ Boolean protected

  Method which may be implemented by the derived classes to allow double clicking the column separator to resize the column to fit its contents.

• #update_columns_order(order) ⇒ void protected

  Method called when the columns order is changed in the customization dialog.

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, #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, #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::HeaderCtrl #initialize(parent, winid = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::HD_DEFAULT_STYLE, name = Wx::HEADER_CTRL_NAME_STR) ⇒ Wx::HeaderCtrl

Returns a new instance of HeaderCtrl.

Overloads:

• #initialize ⇒ Wx::HeaderCtrl

  Default constructor not creating the underlying window.

  You must use #create after creating the object using this constructor.
• #initialize(parent, winid = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::HD_DEFAULT_STYLE, name = Wx::HEADER_CTRL_NAME_STR) ⇒ Wx::HeaderCtrl

  Constructor creating the window.

  Please see #create for the parameters documentation.

  Parameters:

  • parent (Wx::Window)
  • winid (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::HD_DEFAULT_STYLE)
  • name (String) (defaults to: Wx::HEADER_CTRL_NAME_STR)

# File 'lib/wx/doc/gen/header_ctrl.rb', line 138

def initialize(*args) end

Class Method Details

.move_column_in_order_array(order, idx, pos) ⇒ void

This method returns an undefined value.

Helper function to manipulate the array of column indices.

This function reshuffles the array of column indices indexed by positions (i.e. using the same convention as for #set_columns_order) so that the column with the given index is found at the specified position.

Parameters:

• order (Array<Integer>) —

  Array containing the indices of columns in order of their positions.

• idx (Integer) —

  The index of the column to move.

• pos (Integer) —

  The new position for the column idx.

# File 'lib/wx/doc/gen/header_ctrl.rb', line 284

def self.move_column_in_order_array(order, idx, pos) end

Instance Method Details

#add_columns_items(menu, idColumnsBase = 0) ⇒ void

This method returns an undefined value.

Helper function appending the checkable items corresponding to all the columns to the given menu.

This function is used by #show_columns_menu but can also be used if you show your own custom columns menu and still want all the columns shown in it. It appends menu items with column labels as their text and consecutive ids starting from idColumnsBase to the menu and checks the items corresponding to the currently visible columns. Example of use:

menu = Wx::Menu.new
  menu.append(100, 'Some custom command')
  menu.append_separator
  add_columns_items(menu, 200)
  rc = get_popup_menu_selection_from_user(menu, pt)
  if rc >= 200
    # ... toggle visibility of the column rc-200 ...
  end

Parameters:

• menu (Wx::Menu) —

  The menu to append the items to. It may be currently empty or not.

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

  The id for the menu item corresponding to the first column, the other ones are consecutive starting from it. It should be positive.

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

def add_columns_items(menu, idColumnsBase=0) end

#create(parent, winid = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::HD_DEFAULT_STYLE, name = Wx::HEADER_CTRL_NAME_STR) ⇒ Boolean

Create the header control window.

Parameters:

• parent (Wx::Window) —

  The parent window. The header control should be typically positioned along the top edge of this window.

• winid (Integer) (defaults to: Wx::StandardID::ID_ANY) —

  Id of the control or StandardID::ID_ANY if you don’t care.

• pos (Array(Integer, Integer), Wx::Point) (defaults to: Wx::DEFAULT_POSITION) —

  The initial position of the control.

• size (Array(Integer, Integer), Wx::Size) (defaults to: Wx::DEFAULT_SIZE) —

  The initial size of the control (usually not very useful as this control will typically be resized to have the same width as the associated data display control).

• style (Integer) (defaults to: Wx::HD_DEFAULT_STYLE) —

  The control style, Wx::HD_DEFAULT_STYLE by default. Notice that the default style allows the user to reorder the columns by dragging them and you need to explicitly turn this feature off by using

  wxHD_DEFAULT_STYLE & ~wxHD_ALLOW_REORDER
  

  if this is undesirable.

• name (String) (defaults to: Wx::HEADER_CTRL_NAME_STR) —

  The name of the control.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/header_ctrl.rb', line 152

def create(parent, winid=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::HD_DEFAULT_STYLE, name=Wx::HEADER_CTRL_NAME_STR) end

#get_column(idx) ⇒ Wx::HeaderColumn (protected) Also known as: column

Method to be implemented by the derived classes to return the information for the given column.

Parameters:

• idx (Integer) —

  The column index, between 0 and the value last passed to #set_column_count.

Returns:

• (Wx::HeaderColumn)

# File 'lib/wx/doc/gen/header_ctrl.rb', line 292

def get_column(idx) end

#get_column_at(pos) ⇒ Integer Also known as: column_at

Return the index of the column displayed at the given position.

Parameters:

• pos (Integer) —

  The display position, e.g. 0 for the left-most column, 1 for the next one and so on until #get_column_count - 1.

Returns:

• (Integer)

See Also:

• #get_column_pos

# File 'lib/wx/doc/gen/header_ctrl.rb', line 208

def get_column_at(pos) end

#get_column_count ⇒ Integer Also known as: column_count

Return the number of columns in the control.

Number of columns as previously set by #set_column_count.

Returns:

• (Integer)

See Also:

• #is_empty

# File 'lib/wx/doc/gen/header_ctrl.rb', line 167

def get_column_count; end

#get_column_pos(idx) ⇒ Integer Also known as: column_pos

Get the position at which this column is currently displayed.

Notice that a valid position is returned even for the hidden columns currently.

Parameters:

• idx (Integer) —

  The column index, must be less than #get_column_count.

Returns:

• (Integer)

See Also:

• #get_column_at

# File 'lib/wx/doc/gen/header_ctrl.rb', line 217

def get_column_pos(idx) end

#get_column_title_width(col) ⇒ Integer #get_column_title_width(idx) ⇒ Integer Also known as: column_title_width

Overloads:

• #get_column_title_width(col) ⇒ Integer

  Returns width needed for given column’s title.

  Parameters:

  • col (Wx::HeaderColumn)

  Returns:

  • (Integer)
• #get_column_title_width(idx) ⇒ Integer

  Returns width needed for the column with the given index.

  This is just a convenient wrapper for the overload taking Wx::HeaderColumn.

  Parameters:

  • idx (Integer)

  Returns:

  • (Integer)

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

def get_column_title_width(*args) end

#get_columns_order ⇒ Array<Integer> Also known as: columns_order

Return the array describing the columns display order.

For the controls without Wx::HD_ALLOW_REORDER style the returned array will be the same as was passed to #set_columns_order previously or define the default order (with n-th element being n) if it hadn’t been called. But for the controls with Wx::HD_ALLOW_REORDER style, the columns can be also reordered by user.

Returns:

• (Array<Integer>)

# File 'lib/wx/doc/gen/header_ctrl.rb', line 199

def get_columns_order; end

#is_empty ⇒ Boolean Also known as: empty?

Return whether the control has any columns.

Returns:

• (Boolean)

See Also:

• #get_column_count

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

def is_empty; end

#on_column_count_changing(count) ⇒ void (protected)

This method returns an undefined value.

Can be overridden in the derived class to update internal data structures when the number of the columns in the control changes.

This method is called by #set_column_count before effectively changing the number of columns. The base class version does nothing but it is good practice to still call it from the overridden version in the derived class.

Parameters:

• count (Integer)

# File 'lib/wx/doc/gen/header_ctrl.rb', line 363

def on_column_count_changing(count) end

#reset_columns_order ⇒ void

This method returns an undefined value.

Reset the columns order to the natural one.

After calling this function, the column with index idx appears at position idx in the control.

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

def reset_columns_order; end

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

This method returns an undefined value.

Set the number of columns in the control.

The control will use #get_column to get information about all the new columns and refresh itself, i.e. this method also has the same effect as calling #update_column for all columns but it should only be used if the number of columns really changed.

Parameters:

• count (Integer)

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

def set_column_count(count) end

#set_columns_order(order) ⇒ void Also known as: columns_order=

This method returns an undefined value.

Change the columns display order.

The display order defines the order in which the columns appear on the screen and does not affect the interpretation of indices by all the other class methods. The order array specifies the column indices corresponding to the display positions.

Parameters:

• order (Array<Integer>) —

  A permutation of all column indices, i.e. an array of size #get_columns_order containing all column indices exactly once. The n-th element of this array defines the index of the column shown at the n-th position from left (for the default left-to-right writing direction).

See Also:

• ListCtrl#set_columns_order

# File 'lib/wx/doc/gen/header_ctrl.rb', line 192

def set_columns_order(order) end

#show_columns_menu(pt, title = ('')) ⇒ Boolean

Show the popup menu allowing the user to show or hide the columns.

This functions shows the popup menu containing all columns with check marks for the ones which are currently shown and allows the user to check or uncheck them to toggle their visibility. It is called from the default EVT_HEADER_RIGHT_CLICK handler for the controls which have Wx::HD_ALLOW_HIDE style. And if the column has Wx::HD_ALLOW_REORDER style as well, the menu also contains an item to customize the columns shown using which results in #show_customize_dialog being called, please see its description for more details. If a column was toggled, #update_column_visibility virtual function is called so it must be implemented for the controls with Wx::HD_ALLOW_HIDE style or if you call this function explicitly.

true if a column was shown or hidden or false if nothing was done, e.g. because the menu was cancelled.

Parameters:

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

  The position of the menu, in the header window coordinates.

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

  The title for the menu if not empty.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/header_ctrl.rb', line 235

def show_columns_menu(pt, title=('')) end

#show_customize_dialog ⇒ Boolean

Show the column customization dialog.

This function displays a modal dialog containing the list of all columns which the user can use to reorder them as well as show or hide individual columns. If the user accepts the changes done in the dialog, the virtual methods #update_column_visibility and #update_columns_order will be called so they must be overridden in the derived class if this method is ever called. Please notice that the user will be able to invoke it interactively from the header popup menu if the control has both Wx::HD_ALLOW_HIDE and Wx::HD_ALLOW_REORDER styles.

Returns:

• (Boolean)

See Also:

• RearrangeDialog

# File 'lib/wx/doc/gen/header_ctrl.rb', line 262

def show_customize_dialog; end

#update_column(idx) ⇒ void

This method returns an undefined value.

Update the column with the given index.

When the value returned by #get_column changes, this method must be called to notify the control about the change and update the visual display to match the new column data.

Parameters:

• idx (Integer) —

  The column index, must be less than #get_column_count.

# File 'lib/wx/doc/gen/header_ctrl.rb', line 183

def update_column(idx) end

#update_column_visibility(idx, show) ⇒ void (protected)

This method returns an undefined value.

Method called when the column visibility is changed by the user.

This method is called from #show_columns_menu or #show_customize_dialog when the user interactively hides or shows a column. A typical implementation will simply update the internally stored column state. Notice that there is no need to call #update_column from this method as it is already done by Wx::HeaderCtrl itself. The base class version doesn’t do anything and must be overridden if this method is called.

Parameters:

• idx (Integer) —

  The index of the column whose visibility was toggled.

• show (Boolean) —

  The new visibility value, true if the column is now shown or false if it is not hidden.

# File 'lib/wx/doc/gen/header_ctrl.rb', line 302

def update_column_visibility(idx, show) end

#update_column_width_to_fit(idx, widthTitle) ⇒ Boolean (protected)

Method which may be implemented by the derived classes to allow double clicking the column separator to resize the column to fit its contents.

When a separator is double clicked, the default handler of EVT_HEADER_SEPARATOR_DCLICK event calls this function and refreshes the column if it returns true so to implement the resizing of the column to fit its width on header double click you need to implement this method using logic similar to this example:

class MyHeaderColumn < Wx::HeaderColumn
    # ...

    def set_width(width) 
      @width = width
    end

    def get_width 
      @width
    end

  end
  
  class MyHeaderCtrl < Wx::HeaderCtrl
    # ...

    protected

    def get_column(idx)
      # @cols = Array<MyHeaderColumn>
      @cols[idx]
    end
  
    def update_column_width_to_fit(idx, widthTitle)
      widthContents = # ... compute minimal width for column idx ...
      @cols[idx].set_width([widthContents, widthTitle].max)
      true
    end

  end

Base class version simply returns false.

true to indicate that the column was resized, i.e. #get_column now returns the new width value, and so must be refreshed or false meaning that the control didn’t reach to the separator double click.

Parameters:

• idx (Integer) —

  The zero-based index of the column to update.

• widthTitle (Integer) —

  Contains minimal width needed to display the column header itself and will usually be used as a starting point for the fitting width calculation.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/header_ctrl.rb', line 355

def update_column_width_to_fit(idx, widthTitle) end

#update_columns_order(order) ⇒ void (protected)

This method returns an undefined value.

Method called when the columns order is changed in the customization dialog.

This method is only called from #show_customize_dialog when the user changes the order of columns. In particular it is not called if a single column changes place because the user dragged it to the new location, the EVT_HEADER_END_REORDER event handler should be used to react to this. A typical implementation in a derived class will update the display order of the columns in the associated control, if any. Notice that there is no need to call #set_columns_order from it as Wx::HeaderCtrl does it itself. The base class version doesn’t do anything and must be overridden if this method is called.

Parameters:

• order (Array<Integer>) —

  The new column order. This array uses the same convention as #set_columns_order.

# File 'lib/wx/doc/gen/header_ctrl.rb', line 311

def update_columns_order(order) end