Class: Wx::SplitterWindow

Inherits:

Window

• Object
• Object
• EvtHandler
• Window
• Wx::SplitterWindow

Defined in:

lib/wx/doc/gen/splitter_window.rb

Overview

This class manages up to two subwindows.

The current view can be split into two programmatically (perhaps from a menu command), and unsplit either programmatically or via the SplitterWindow user interface.

Styles

This class supports the following styles:

• SP_3D: Draws a 3D effect border and sash.

• SP_THIN_SASH: Draws a thin sash.

• SP_3DSASH: Draws a 3D effect sash (part of default style).

• SP_3DBORDER: Synonym for SP_BORDER.

• SP_BORDER: Draws a standard border.

• SP_NOBORDER: No border (default).

• SP_NO_XP_THEME: Under Windows, switches off the attempt to draw the splitter using Windows theming, so the borders and sash will take on the pre-XP look.

• SP_PERMIT_UNSPLIT: Always allow to unsplit, even with the minimum pane size other than zero.

• SP_LIVE_UPDATE: Don't draw XOR line but resize the child windows immediately.

Events emitted by this class

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

• EvtHandler#evt_splitter_sash_pos_changing(id, meth = nil, &block): The sash position is in the process of being changed. May be used to modify the position of the tracking bar to properly reflect the position that would be set if the drag were to be completed at this point. Processes a EVT_SPLITTER_SASH_POS_CHANGING event.

• EvtHandler#evt_splitter_sash_pos_resize(id, meth = nil, &block): The sash position is in the process of being updated. May be used to modify the position of the tracking bar to properly reflect the position that would be set if the update were to be completed. This can happen e.g. when the window is resized and the sash is moved according to the gravity setting. This event is sent when the window is resized and allows the application to select the desired new sash position. If it doesn't process the event, the position is determined by the gravity setting. Processes a EVT_SPLITTER_SASH_POS_RESIZE event and is only available in wxWidgets 3.1.6 or newer.

• EvtHandler#evt_splitter_sash_pos_changed(id, meth = nil, &block): The sash position was changed. May be used to modify the sash position before it is set, or to prevent the change from taking place. Processes a EVT_SPLITTER_SASH_POS_CHANGED event.

• EvtHandler#evt_splitter_unsplit(id, meth = nil, &block): The splitter has been just unsplit. Processes a EVT_SPLITTER_UNSPLIT event.

• EvtHandler#evt_splitter_dclick(id, meth = nil, &block): The sash was double clicked. The default behaviour is to unsplit the window when this happens (unless the minimum pane size has been set to a value greater than zero). Processes a EVT_SPLITTER_DOUBLECLICKED event.

Category: Miscellaneous Windows

See Also:

• SplitterEvent
• Overview

Requires:

• USE_SPLITTER

Instance Method Summary

• #create(parent, id = Wx::StandardID::ID_ANY, point = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = wxSP_3D, name = ("SPLITTER")) ⇒ Boolean

  Creation function, for two-step construction.

• #get_default_sash_size ⇒ Integer (also: #default_sash_size)

  Returns the default sash size in pixels.

• #get_minimum_pane_size ⇒ Integer (also: #minimum_pane_size)

  Returns the current minimum pane size (defaults to zero).

• #get_sash_gravity ⇒ Float (also: #sash_gravity)

  Returns the current sash gravity.

• #get_sash_position ⇒ Integer (also: #sash_position)

  Returns the current sash position.

• #get_sash_size ⇒ Integer (also: #sash_size)

  Returns the default sash size in pixels or 0 if it is invisible.

• #get_split_mode ⇒ Wx::SplitMode (also: #split_mode)

  Gets the split mode.

• #get_window1 ⇒ Wx::Window (also: #window1)

  Returns the left/top or only pane.

• #get_window2 ⇒ Wx::Window (also: #window2)

  Returns the right/bottom pane.

• #init(window) ⇒ void

  Initializes the splitter window to have one pane.

• #initialize(*args) ⇒ SplitterWindow constructor

  A new instance of SplitterWindow.

• #is_sash_invisible ⇒ Boolean (also: #sash_invisible?)

  Returns true if the sash is invisible even when the window is split, false otherwise.

• #is_split ⇒ Boolean (also: #split?)

  Returns true if the window is split, false otherwise.

• #on_double_click_sash(x, y) ⇒ void

  Application-overridable function called when the sash is double-clicked with the left mouse button.

• #on_sash_position_change(newSashPosition) ⇒ Boolean

  Application-overridable function called when the sash position is changed by user.

• #on_unsplit(removed) ⇒ void

  Application-overridable function called when the window is unsplit, either programmatically or using the SplitterWindow user interface.

• #replace_window(winOld, winNew) ⇒ Boolean

  This function replaces one of the windows managed by the SplitterWindow with another one.

• #set_minimum_pane_size(paneSize) ⇒ void (also: #minimum_pane_size=)

  Sets the minimum pane size.

• #set_sash_gravity(gravity) ⇒ void (also: #sash_gravity=)

  Sets the sash gravity.

• #set_sash_invisible(invisible = true) ⇒ void (also: #sash_invisible=)

  Sets whether the sash should be invisible, even when the window is split.

• #set_sash_position(position, redraw = true) ⇒ void (also: #sash_position=)

  Sets the sash position.

• #set_split_mode(mode) ⇒ void (also: #split_mode=)

  Sets the split mode.

• #split_horizontally(window1, window2, sashPosition = 0) ⇒ Boolean

  Initializes the top and bottom panes of the splitter window.

• #split_vertically(window1, window2, sashPosition = 0) ⇒ Boolean

  Initializes the left and right panes of the splitter window.

• #unsplit(toRemove = nil) ⇒ Boolean

  Unsplits the window.

• #update_size ⇒ void

  Causes any pending sizing of the sash and child panes to take place immediately.

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::SplitterWindow #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = wxSP_3D, name = ("SPLITTER_WINDOW")) ⇒ Wx::SplitterWindow

Returns a new instance of SplitterWindow.

Overloads:

• #initialize ⇒ Wx::SplitterWindow

  Default constructor.
• #initialize(parent, id = Wx::StandardID::ID_ANY, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = wxSP_3D, name = ("SPLITTER_WINDOW")) ⇒ Wx::SplitterWindow

  Constructor for creating the window.

  Remark:

  After using this constructor, you must create either one or two subwindows with the splitter window as parent, and then call one of #initialize, #split_vertically and #split_horizontally in order to set the pane(s). You can create two windows, with one hidden when not being shown; or you can create and delete the second pane on demand.

  Parameters:

  • parent (Wx::Window) —

    The parent of the splitter window.

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

    The window identifier.

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

    The window position.

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

    The window size.

  • style (Integer) (defaults to: wxSP_3D) —

    The window style. See Wx::SplitterWindow.

  • name (String) (defaults to: ("SPLITTER_WINDOW")) —

    The window name.

  See Also:

  • #initialize
  • #split_vertically
  • #split_horizontally
  • #create

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

def initialize(*args) end

Instance Method Details

#create(parent, id = Wx::StandardID::ID_ANY, point = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = wxSP_3D, name = ("SPLITTER")) ⇒ Boolean

Creation function, for two-step construction.

See splitter_window for details.

Parameters:

• parent (Wx::Window)
• id (Integer) (defaults to: Wx::StandardID::ID_ANY)
• point (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: wxSP_3D)
• name (String) (defaults to: ("SPLITTER"))

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/splitter_window.rb', line 170

def create(parent, id=Wx::StandardID::ID_ANY, point=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=wxSP_3D, name=("SPLITTER")) end

#get_default_sash_size ⇒ Integer Also known as: default_sash_size

Returns the default sash size in pixels.

The size of the sash is its width for a vertically split window and its height for a horizontally split one. Its other direction is the same as the client size of the window in the corresponding direction. The default sash size is platform-dependent because it conforms to the current platform look-and-feel and cannot be changed.

Returns:

• (Integer)

# File 'lib/wx/doc/gen/splitter_window.rb', line 210

def get_default_sash_size; end

#get_minimum_pane_size ⇒ Integer Also known as: minimum_pane_size

Returns the current minimum pane size (defaults to zero).

Returns:

• (Integer)

See Also:

• #set_minimum_pane_size

# File 'lib/wx/doc/gen/splitter_window.rb', line 177

def get_minimum_pane_size; end

#get_sash_gravity ⇒ Float Also known as: sash_gravity

Returns the current sash gravity.

Returns:

• (Float)

See Also:

• #set_sash_gravity

# File 'lib/wx/doc/gen/splitter_window.rb', line 185

def get_sash_gravity; end

#get_sash_position ⇒ Integer Also known as: sash_position

Returns the current sash position.

Returns:

• (Integer)

See Also:

• #set_sash_position

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

def get_sash_position; end

#get_sash_size ⇒ Integer Also known as: sash_size

Returns the default sash size in pixels or 0 if it is invisible.

Returns:

• (Integer)

See Also:

• #get_default_sash_size
• #is_sash_invisible

# File 'lib/wx/doc/gen/splitter_window.rb', line 202

def get_sash_size; end

#get_split_mode ⇒ Wx::SplitMode Also known as: split_mode

Gets the split mode.

Returns:

• (Wx::SplitMode)

See Also:

• #set_split_mode
• #split_vertically
• #split_horizontally

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

def get_split_mode; end

#get_window1 ⇒ Wx::Window Also known as: window1

Returns the left/top or only pane.

Returns:

• (Wx::Window)

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

def get_window1; end

#get_window2 ⇒ Wx::Window Also known as: window2

Returns the right/bottom pane.

Returns:

• (Wx::Window)

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

def get_window2; end

#init(window) ⇒ void

This method returns an undefined value.

Initializes the splitter window to have one pane.

The child window is shown if it is currently hidden.

Remark:

This should be called if you wish to initially view only a single pane in the splitter window.

Parameters:

• window (Wx::Window) —

  The pane for the unsplit window.

See Also:

• #split_vertically
• #split_horizontally

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

def init(window) end

#is_sash_invisible ⇒ Boolean Also known as: sash_invisible?

Returns true if the sash is invisible even when the window is split, false otherwise.

Remark:

This is a shortcut for HasFlag(Wx::SP_NOSASH)

Returns:

• (Boolean)

See Also:

• #set_sash_invisible

# File 'lib/wx/doc/gen/splitter_window.rb', line 257

def is_sash_invisible; end

#is_split ⇒ Boolean Also known as: split?

Returns true if the window is split, false otherwise.

Returns:

• (Boolean)

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

def is_split; end

#on_double_click_sash(x, y) ⇒ void

This method returns an undefined value.

Application-overridable function called when the sash is double-clicked with the left mouse button.

Remark:

The default implementation of this function calls Unsplit if the minimum pane size is zero.

Parameters:

• x (Integer) —

  The x position of the mouse cursor.

• y (Integer) —

  The y position of the mouse cursor.

See Also:

• #unsplit

# File 'lib/wx/doc/gen/splitter_window.rb', line 276

def on_double_click_sash(x, y) end

#on_sash_position_change(newSashPosition) ⇒ Boolean

Application-overridable function called when the sash position is changed by user.

It may return false to prevent the change or true to allow it.

Remark:

The default implementation of this function verifies that the sizes of both panes of the splitter are greater than minimum pane size.

Parameters:

• newSashPosition (Integer) —

  The new sash position (always positive or zero)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/splitter_window.rb', line 289

def on_sash_position_change(newSashPosition) end

#on_unsplit(removed) ⇒ void

This method returns an undefined value.

Application-overridable function called when the window is unsplit, either programmatically or using the Wx::SplitterWindow user interface.

Remark:

The default implementation of this function simply hides removed. You may wish to delete the window.

Parameters:

• removed (Wx::Window) —

  The window being removed.

# File 'lib/wx/doc/gen/splitter_window.rb', line 300

def on_unsplit(removed) end

#replace_window(winOld, winNew) ⇒ Boolean

This function replaces one of the windows managed by the Wx::SplitterWindow with another one.

It is in general better to use it instead of calling #unsplit and then resplitting the window back because it will provoke much less flicker (if any). It is valid to call this function whether the splitter has two windows or only one. Both parameters should be non-NULL and winOld must specify one of the windows managed by the splitter. If the parameters are incorrect or the window couldn’t be replaced, false is returned. Otherwise the function will return true, but please notice that it will not delete the replaced window and you may wish to do it yourself.

Parameters:

• winOld (Wx::Window)
• winNew (Wx::Window)

Returns:

• (Boolean)

See Also:

• #get_minimum_pane_size

# File 'lib/wx/doc/gen/splitter_window.rb', line 310

def replace_window(winOld, winNew) end

#set_minimum_pane_size(paneSize) ⇒ void Also known as: minimum_pane_size=

This method returns an undefined value.

Sets the minimum pane size.

Remark:

The default minimum pane size is zero, which means that either pane can be reduced to zero by dragging the sash, thus removing one of the panes. To prevent this behaviour (and veto out-of-range sash dragging), set a minimum size, for example 20 pixels. If the Wx::SP_PERMIT_UNSPLIT style is used when a splitter window is created, the window may be unsplit even if minimum size is non-zero.

Parameters:

• paneSize (Integer) —

  Minimum pane size in pixels.

See Also:

• #get_minimum_pane_size

# File 'lib/wx/doc/gen/splitter_window.rb', line 322

def set_minimum_pane_size(paneSize) end

#set_sash_gravity(gravity) ⇒ void Also known as: sash_gravity=

This method returns an undefined value.

Sets the sash gravity.

Remark:

Gravity is real factor which controls position of sash while resizing Wx::SplitterWindow. Gravity tells Wx::SplitterWindow how much will left/top window grow while resizing. Example values: - 0.0: only the bottom/right window is automatically resized - 0.5: both windows grow by equal size - 1.0: only left/top window grows Gravity should be a real value between 0.0 and 1.0. Default value of sash gravity is 0.0. That value is compatible with previous (before gravity was introduced) behaviour of Wx::SplitterWindow.

Notice that when sash gravity for a newly created splitter window, it is often necessary to explicitly set the splitter size using Window#set_size to ensure that is big enough for its initial sash position. Otherwise, i.e. if the window is created with the default tiny size and only resized to its correct size later, the initial sash position will be affected by the gravity and typically result in sash being at the rightmost position for the gravity of 1. See the example code creating Wx::SplitterWindow in the splitter sample for more details.

Parameters:

• gravity (Float) —

  The sash gravity. Value between 0.0 and 1.0.

See Also:

• #get_sash_gravity

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

def set_sash_gravity(gravity) end

#set_sash_invisible(invisible = true) ⇒ void Also known as: sash_invisible=

This method returns an undefined value.

Sets whether the sash should be invisible, even when the window is split.

When the sash is invisible, it doesn’t appear on the screen at all and, in particular, doesn’t allow the user to resize the windows.

Remark:

Only sets the internal variable; does not update the display.

Parameters:

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

  If true, the sash is always invisible, else it is shown when the window is split.

See Also:

• #is_sash_invisible

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

def set_sash_invisible(invisible=true) end

#set_sash_position(position, redraw = true) ⇒ void Also known as: sash_position=

This method returns an undefined value.

Sets the sash position.

Remark:

Does not currently check for an out-of-range value.

Parameters:

• position (Integer) —

  The sash position in pixels.

  Note that a position of 0 will set the sash to the middle of the window.

  A negative value will “wrap around” the sash’s position. For example, -10 will place the sash at 10 units from right of the splitter window.

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

  If true, resizes the panes and redraws the sash and border.

See Also:

• #get_sash_position

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

def set_sash_position(position, redraw=true) end

#set_split_mode(mode) ⇒ void Also known as: split_mode=

This method returns an undefined value.

Sets the split mode.

Remark:

Only sets the internal variable; does not update the display.

Parameters:

• mode (Integer) —

  Can be Wx::SplitMode::SPLIT_VERTICAL or Wx::SplitMode::SPLIT_HORIZONTAL.

See Also:

• #get_split_mode
• #split_vertically
• #split_horizontally

# File 'lib/wx/doc/gen/splitter_window.rb', line 375

def set_split_mode(mode) end

#split_horizontally(window1, window2, sashPosition = 0) ⇒ Boolean

Initializes the top and bottom panes of the splitter window.

The child windows are shown if they are currently hidden.

true if successful, false otherwise (the window was already split).

Remark:

This should be called if you wish to initially view two panes. It can also be called at any subsequent time, but the application should check that the window is not currently split using #is_split.

Parameters:

• window1 (Wx::Window) —

  The top pane.

• window2 (Wx::Window) —

  The bottom pane.

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

  The initial position of the sash. If this value is positive, it specifies the size of the upper pane. If it is negative, its absolute value gives the size of the lower pane. Finally, specify 0 (default) to choose the default position (half of the total window height).

Returns:

• (Boolean)

See Also:

• #split_vertically
• #is_split
• #unsplit

# File 'lib/wx/doc/gen/splitter_window.rb', line 411

def split_horizontally(window1, window2, sashPosition=0) end

#split_vertically(window1, window2, sashPosition = 0) ⇒ Boolean

Initializes the left and right panes of the splitter window.

The child windows are shown if they are currently hidden.

true if successful, false otherwise (the window was already split).

Remark:

This should be called if you wish to initially view two panes. It can also be called at any subsequent time, but the application should check that the window is not currently split using #is_split.

Parameters:

• window1 (Wx::Window) —

  The left pane.

• window2 (Wx::Window) —

  The right pane.

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

  The initial position of the sash. If this value is positive, it specifies the size of the left pane. If it is negative, it is absolute value gives the size of the right pane. Finally, specify 0 (default) to choose the default position (half of the total window width).

Returns:

• (Boolean)

See Also:

• #split_horizontally
• #is_split
• #unsplit

# File 'lib/wx/doc/gen/splitter_window.rb', line 431

def split_vertically(window1, window2, sashPosition=0) end

#unsplit(toRemove = nil) ⇒ Boolean

Unsplits the window.

true if successful, false otherwise (the window was not split).

Remark:

This call will not actually delete the pane being removed; it calls #on_unsplit which can be overridden for the desired behaviour. By default, the pane being removed is hidden.

Parameters:

• toRemove (Wx::Window) (defaults to: nil) —

  The pane to remove, or NULL to remove the right or bottom pane.

Returns:

• (Boolean)

See Also:

• #split_horizontally
• #split_vertically
• #is_split
• #on_unsplit

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

def unsplit(toRemove=nil) end

#update_size ⇒ void

This method returns an undefined value.

Causes any pending sizing of the sash and child panes to take place immediately.

Such resizing normally takes place in idle time, in order to wait for layout to be completed. However, this can cause unacceptable flicker as the panes are resized after the window has been shown. To work around this, you can perform window layout (for example by sending a size event to the parent window), and then call this function, before showing the top-level window.

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

def update_size; end