Class: Wx::TopLevelWindow

Inherits:

NonOwnedWindow

• Object
• Object
• EvtHandler
• Window
• NonOwnedWindow
• Wx::TopLevelWindow

Defined in:

lib/wx/doc/gen/top_level_window.rb,
lib/wx/doc/top_level_window.rb

Overview

TopLevelWindow is a common base class for Dialog and Frame.

It is an abstract base class meaning that you never work with objects of this class directly, but all of its methods are also applicable for the two classes above. Note that the instances of TopLevelWindow are managed by wxWidgets in the internal top level window list.

Events emitted by this class

Event handler methods for events emitted by this class:

• EvtHandler#EVT_MAXIMIZE(meth = nil, &block): Process a EVT_MAXIMIZE event. See MaximizeEvent.

• EvtHandler#evt_move(meth = nil, &block): Process a EVT_MOVE event, which is generated when a window is moved. See MoveEvent.

• EvtHandler#evt_move_start(meth = nil, &block): Process a EVT_MOVE_START event, which is generated when the user starts to move or size a window. WXMSW only. See MoveEvent.

• EvtHandler#evt_move_end(meth = nil, &block): Process a EVT_MOVE_END event, which is generated when the user stops moving or sizing a window. WXMSW only. See MoveEvent.

• EvtHandler#evt_show(meth = nil, &block): Process a EVT_SHOW event. See ShowEvent.

• EvtHandler#EVT_FULLSCREEN(meth = nil, &block): Process a EVT_FULLSCREEN event. See FullScreenEvent.

Category: Managed Windows

See Also:

• Dialog
• Frame

Direct Known Subclasses

Dialog, Frame

Class Method Summary

• .get_default_size ⇒ Wx::Size

  Get the default size for a new top level window.

Instance Method Summary

• #can_set_transparent ⇒ Boolean (also: #can_set_transparent?)

  Returns true if the platform supports making the window translucent.

• #center_on_screen(direction = Wx::Orientation::BOTH) ⇒ void

  A synonym for #centre_on_screen.

• #centre_on_screen(direction = Wx::Orientation::BOTH) ⇒ void

  Centres the window on screen.

• #create(parent, id, title, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::DEFAULT_FRAME_STYLE, name = Wx::FRAME_NAME_STR) ⇒ Boolean

  Creates the top level window.

• #create_persistent_object ⇒ Wx::PersistentTLW

  Creates PersistentObject for this toplevel window instance (incl. Dialog and Frame).

• #enable_close_button(enable = true) ⇒ Boolean

  Enables or disables the Close button (most often in the right upper corner of a dialog) and the Close entry of the system menu (most often in the left upper corner of the dialog).

• #enable_full_screen_view(enable = true, style = Wx::FULLSCREEN_ALL) ⇒ Boolean

  Enables the zoom button to toggle full screen mode.

• #enable_maximize_button(enable = true) ⇒ Boolean

  Enables or disables the Maximize button (in the right or left upper corner of a frame or dialog).

• #enable_minimize_button(enable = true) ⇒ Boolean

  Enables or disables the Minimize button (in the right or left upper corner of a frame or dialog).

• #get_content_protection ⇒ Wx::ContentProtection (also: #content_protection)

  Get the current content protection of the window.

• #get_default_item ⇒ Wx::Window (also: #default_item)

  Returns a pointer to the button which is the default for this window, or NULL.

• #get_icon ⇒ Wx::Icon (also: #icon)

  Returns the standard icon of the window.

• #get_icons ⇒ Wx::IconBundle (also: #icons)

  Returns all icons associated with the window, there will be none of them if neither #set_icon nor #set_icons had been called before.

• #get_title ⇒ String (also: #title)

  Gets a string containing the window title.

• #get_tmp_default_item ⇒ Wx::Window (also: #tmp_default_item)
• #iconize(iconize = true) ⇒ void

  Iconizes or restores the window.

• #initialize(*args) ⇒ TopLevelWindow constructor

  A new instance of TopLevelWindow.

• #is_active ⇒ Boolean (also: #active?)

  Returns true if this window is currently active, i.e.

• #is_always_maximized ⇒ Boolean (also: #always_maximized?)

  Returns true if this window is expected to be always maximized, either due to platform policy or due to local policy regarding particular class.

• #is_full_screen ⇒ Boolean (also: #full_screen?)

  Returns true if the window is in fullscreen mode.

• #is_iconized ⇒ Boolean (also: #iconized?)

  Returns true if the window is iconized.

• #is_maximized ⇒ Boolean (also: #maximized?)

  Returns true if the window is maximized.

• #layout ⇒ Boolean

  Lays out the children using the window sizer or resizes the only child of the window to cover its entire area.

• #maximize(maximize = true) ⇒ void

  Maximizes or restores the window.

• #msw_get_system_menu ⇒ Wx::Menu

  MSW-specific function for accessing the system menu.

• #osx_is_modified ⇒ Boolean

  Returns the current modified state of the TopLevelWindow on macOS.

• #osx_set_modified(modified) ⇒ void

  This function sets the TopLevelWindow‘s modified state on macOS, which currently draws a black dot in the TopLevelWindow’s close button.

• #request_user_attention(flags = Wx::USER_ATTENTION_INFO) ⇒ void

  Use a system-dependent way to attract users attention to the window when it is in background.

• #restore ⇒ void

  Restore a previously iconized or maximized window to its normal state.

• #set_content_protection(contentProtection) ⇒ Boolean

  Set content protection for the window.

• #set_default_item(win) ⇒ Wx::Window (also: #default_item=)

  Changes the default item for the panel, usually win is a button.

• #set_icon(icon) ⇒ void (also: #icon=)

  Sets the icon for this window.

• #set_icons(icons) ⇒ void (also: #icons=)

  Sets several icons of different sizes for this window: this allows using different icons for different situations (e.g.

• #set_max_size(size) ⇒ void (also: #max_size=)

  A simpler interface for setting the size hints than #set_size_hints.

• #set_min_size(size) ⇒ void (also: #min_size=)

  A simpler interface for setting the size hints than #set_size_hints.

• #set_represented_filename(filename) ⇒ void (also: #represented_filename=)

  Sets the file name represented by this TopLevelWindow.

• #set_size_hints(*args) ⇒ Object (also: #size_hints=)
• #set_title(title) ⇒ void (also: #title=)

  Sets the window title.

• #set_tmp_default_item(win) ⇒ Wx::Window (also: #tmp_default_item=)
• #set_transparent(alpha) ⇒ Boolean (also: #transparent=)

  If the platform supports it will set the window to be translucent.

• #should_prevent_app_exit ⇒ Boolean

  This virtual function is not meant to be called directly but can be overridden to return false (it returns true by default) to allow the application to close even if this, presumably not very important, window is still opened.

• #show_full_screen(show, style = Wx::FULLSCREEN_ALL) ⇒ Boolean

  Depending on the value of show parameter the window is either shown full screen or restored to its normal state.

• #show_without_activating ⇒ void

  Show the TopLevelWindow, but do not give it keyboard focus.

Methods inherited from NonOwnedWindow

#set_shape

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, #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, #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_min_client_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_sizer, #set_sizer_and_fit, #set_theme_enabled, #set_tool_tip, #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::TopLevelWindow #initialize(parent, id, title, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::DEFAULT_FRAME_STYLE, name = Wx::FRAME_NAME_STR) ⇒ Wx::TopLevelWindow

Returns a new instance of TopLevelWindow.

Overloads:

• #initialize ⇒ Wx::TopLevelWindow

  Default ctor.
• #initialize(parent, id, title, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::DEFAULT_FRAME_STYLE, name = Wx::FRAME_NAME_STR) ⇒ Wx::TopLevelWindow

  Constructor creating the top level window.

  Parameters:

  • parent (Wx::Window)
  • id (Integer)
  • title (String)
  • 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::DEFAULT_FRAME_STYLE)
  • name (String) (defaults to: Wx::FRAME_NAME_STR)

# File 'lib/wx/doc/gen/top_level_window.rb', line 100

def initialize(*args) end

Class Method Details

.get_default_size ⇒ Wx::Size

Get the default size for a new top level window.

This is used internally by wxWidgets on some platforms to determine the default size for a window created using DEFAULT_SIZE so it is not necessary to use it when creating a Wx::TopLevelWindow, however it may be useful if a rough estimation of the window size is needed for some other reason.

Returns:

• (Wx::Size)

# File 'lib/wx/doc/gen/top_level_window.rb', line 514

def self.get_default_size; end

Instance Method Details

#can_set_transparent ⇒ Boolean Also known as: can_set_transparent?

Returns true if the platform supports making the window translucent.

Returns:

• (Boolean)

See Also:

• #set_transparent

# File 'lib/wx/doc/gen/top_level_window.rb', line 118

def can_set_transparent; end

#center_on_screen(direction = Wx::Orientation::BOTH) ⇒ void

This method returns an undefined value.

A synonym for #centre_on_screen.

Parameters:

• direction (Integer) (defaults to: Wx::Orientation::BOTH)

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

def center_on_screen(direction=Wx::Orientation::BOTH) end

#centre_on_screen(direction = Wx::Orientation::BOTH) ⇒ void

This method returns an undefined value.

Centres the window on screen.

Parameters:

• direction (Integer) (defaults to: Wx::Orientation::BOTH) —

  Specifies the direction for the centering. May be Orientation::HORIZONTAL, Orientation::VERTICAL or Orientation::BOTH.

See Also:

• Window#centre_on_parent

# File 'lib/wx/doc/gen/top_level_window.rb', line 132

def centre_on_screen(direction=Wx::Orientation::BOTH) end

#create(parent, id, title, pos = Wx::DEFAULT_POSITION, size = Wx::DEFAULT_SIZE, style = Wx::DEFAULT_FRAME_STYLE, name = Wx::FRAME_NAME_STR) ⇒ Boolean

Creates the top level window.

Parameters:

• parent (Wx::Window)
• id (Integer)
• title (String)
• 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::DEFAULT_FRAME_STYLE)
• name (String) (defaults to: Wx::FRAME_NAME_STR)

Returns:

• (Boolean)

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

def create(parent, id, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_FRAME_STYLE, name=Wx::FRAME_NAME_STR) end

#create_persistent_object ⇒ Wx::PersistentTLW

Creates PersistentObject for this toplevel window instance (incl. Dialog and Frame).

Returns:

• (Wx::PersistentTLW)

See Also:

• Wx.create_persistent_object

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

def create_persistent_object; end

#enable_close_button(enable = true) ⇒ Boolean

Enables or disables the Close button (most often in the right upper corner of a dialog) and the Close entry of the system menu (most often in the left upper corner of the dialog).

Returns true if operation was successful. This may be wrong on X11 (including GTK+) where the window manager may not support this operation and there is no way to find out.

Parameters:

• enable (Boolean) (defaults to: true)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/top_level_window.rb', line 139

def enable_close_button(enable=true) end

#enable_full_screen_view(enable = true, style = Wx::FULLSCREEN_ALL) ⇒ Boolean

Enables the zoom button to toggle full screen mode.

A FullScreenEvent is generated when the users enters or exits full screen via the enter/exit full screen button.

true if the button behaviour has been changed, false if running under another OS.

Note:

Having the button is also required to let #show_full_screen make use of the full screen API: a full screen window gets its own space and entering and exiting the mode is animated. If the button is not present the old way of switching to full screen is used. Only FULLSCREEN_NOTOOLBAR and FULLSCREEN_NOMENUBAR will be used when using the fullscreen API (other values are ignored).

Availability: only available for the WXOSX/Cocoa port.

Parameters:

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

  If true (default) make the zoom button toggle full screen; if false the button does only toggle zoom.

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

  This parameter sets which elements will be hidden when the user presses the full screen button. See #show_full_screen for possible values. It is available since wxWidgets 3.1.6.

Returns:

• (Boolean)

See Also:

• #show_full_screen
• FullScreenEvent

Requires:

• WXOSX

# File 'lib/wx/doc/gen/top_level_window.rb', line 456

def enable_full_screen_view(enable=true, style=Wx::FULLSCREEN_ALL) end

#enable_maximize_button(enable = true) ⇒ Boolean

Enables or disables the Maximize button (in the right or left upper corner of a frame or dialog).

Currently only implemented for WXMSW and WXOSX. The window style must contain MAXIMIZE_BOX. Returns true if operation was successful. Note that a successful operation does not change the window style flags.

Parameters:

• enable (Boolean) (defaults to: true)

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/top_level_window.rb', line 148

def enable_maximize_button(enable=true) end

#enable_minimize_button(enable = true) ⇒ Boolean

Enables or disables the Minimize button (in the right or left upper corner of a frame or dialog).

Currently only implemented for WXMSW and WXOSX. The window style must contain MINIMIZE_BOX. Note that in WXMSW a successful operation will change the window style flags. Returns true if operation was successful. Note that a successful operation does not change the window style flags.

Parameters:

• enable (Boolean) (defaults to: true)

Returns:

• (Boolean)

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

def enable_minimize_button(enable=true) end

#get_content_protection ⇒ Wx::ContentProtection Also known as: content_protection

Get the current content protection of the window.

Returns:

• (Wx::ContentProtection)

See Also:

• #set_content_protection

# File 'lib/wx/doc/gen/top_level_window.rb', line 488

def get_content_protection; end

#get_default_item ⇒ Wx::Window Also known as: default_item

Returns a pointer to the button which is the default for this window, or NULL.

The default button is the one activated by pressing the Enter key.

Returns:

• (Wx::Window)

# File 'lib/wx/doc/gen/top_level_window.rb', line 164

def get_default_item; end

#get_icon ⇒ Wx::Icon Also known as: icon

Returns the standard icon of the window.

The icon will be invalid if it hadn’t been previously set by #set_icon.

Returns:

• (Wx::Icon)

See Also:

• #get_icons

# File 'lib/wx/doc/gen/top_level_window.rb', line 172

def get_icon; end

#get_icons ⇒ Wx::IconBundle Also known as: icons

Returns all icons associated with the window, there will be none of them if neither #set_icon nor #set_icons had been called before.

Use #get_icon to get the main icon of the window.

Returns:

• (Wx::IconBundle)

See Also:

• IconBundle

# File 'lib/wx/doc/gen/top_level_window.rb', line 180

def get_icons; end

#get_title ⇒ String Also known as: title

Gets a string containing the window title.

Returns:

• (String)

See Also:

• #set_title

# File 'lib/wx/doc/gen/top_level_window.rb', line 188

def get_title; end

#get_tmp_default_item ⇒ Wx::Window Also known as: tmp_default_item

Returns:

• (Wx::Window)

# File 'lib/wx/doc/gen/top_level_window.rb', line 298

def get_tmp_default_item; end

#iconize(iconize = true) ⇒ void

This method returns an undefined value.

Iconizes or restores the window.

Note that in WXGTK the change to the window state is not immediate, i.e. #is_iconized will typically return false right after a call to #iconize and its return value will only change after the control flow returns to the event loop and the notification about the window being really iconized is received.

Parameters:

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

  If true, iconizes the window; if false, shows and restores it.

See Also:

• #is_iconized
• #restore
• IconizeEvent

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

def iconize(iconize=true) end

#is_active ⇒ Boolean Also known as: active?

Returns true if this window is currently active, i.e. if the user is currently working with it.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/top_level_window.rb', line 203

def is_active; end

#is_always_maximized ⇒ Boolean Also known as: always_maximized?

Returns true if this window is expected to be always maximized, either due to platform policy or due to local policy regarding particular class.

Returns:

• (Boolean)

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

def is_always_maximized; end

#is_full_screen ⇒ Boolean Also known as: full_screen?

Returns true if the window is in fullscreen mode.

Returns:

• (Boolean)

See Also:

• #show_full_screen

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

def is_full_screen; end

#is_iconized ⇒ Boolean Also known as: iconized?

Returns true if the window is iconized.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/top_level_window.rb', line 221

def is_iconized; end

#is_maximized ⇒ Boolean Also known as: maximized?

Returns true if the window is maximized.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/top_level_window.rb', line 226

def is_maximized; end

#layout ⇒ Boolean

Lays out the children using the window sizer or resizes the only child of the window to cover its entire area.

This class overrides the base class #layout method to check if this window contains exactly one child which is commonly the case, with Panel being often created as the only child of Wx::TopLevelWindow and, if this is the case, resizes this child window to cover the entire client area. Note that if you associate a sizer with this window, the sizer takes precedence and the only-child-resizing is only used as fallback. false if nothing was done because the window has neither a sizer nor a single child, true otherwise.

Returns:

• (Boolean)

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

def layout; end

#maximize(maximize = true) ⇒ void

This method returns an undefined value.

Maximizes or restores the window.

Note that, just as with #iconize, the change to the window state is not immediate in at least WXGTK port.

Parameters:

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

  If true, maximizes the window, otherwise it restores it.

See Also:

• #restore
• #iconize

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

def maximize(maximize=true) end

#msw_get_system_menu ⇒ Wx::Menu

MSW-specific function for accessing the system menu.

Returns a Menu pointer representing the system menu of the window under MSW. The returned Menu may be used, if non-NULL, to add extra items to the system menu. The usual EVT_MENU events (that can be processed using EVT_MENU event table macro) will then be generated for them. All the other Menu methods may be used as well but notice that they won’t allow you to access any standard system menu items (e.g. they can’t be deleted or modified in any way currently). Notice that because of the native system limitations the identifiers of the items added to the system menu must be multiples of 16, otherwise no events will be generated for them. The returned pointer must not be deleted, it is owned by the window and will be only deleted when the window itself is destroyed. This function is not available in the other ports by design, any occurrences of it in the portable code must be guarded by

if Wx::PLATFORM == 'WXMSW'

preprocessor guards.

Returns:

• (Wx::Menu)

Requires:

• WXMSW

# File 'lib/wx/doc/gen/top_level_window.rb', line 258

def msw_get_system_menu; end

#osx_is_modified ⇒ Boolean

Returns the current modified state of the Wx::TopLevelWindow on macOS.

On other platforms, this method does nothing.

Returns:

• (Boolean)

See Also:

• #osx_set_modified

Requires:

• WXOSX

# File 'lib/wx/doc/gen/top_level_window.rb', line 421

def osx_is_modified; end

#osx_set_modified(modified) ⇒ void

This method returns an undefined value.

This function sets the Wx::TopLevelWindow‘s modified state on macOS, which currently draws a black dot in the Wx::TopLevelWindow’s close button.

On other platforms, this method does nothing.

Parameters:

• modified (Boolean)

See Also:

• #osx_is_modified

Requires:

• WXOSX

# File 'lib/wx/doc/gen/top_level_window.rb', line 413

def osx_set_modified(modified) end

#request_user_attention(flags = Wx::USER_ATTENTION_INFO) ⇒ void

This method returns an undefined value.

Use a system-dependent way to attract users attention to the window when it is in background.

flags may have the value of either USER_ATTENTION_INFO (default) or USER_ATTENTION_ERROR which results in a more drastic action. When in doubt, use the default value.

Note:

This function should normally be only used when the application is not already in foreground.

This function is currently implemented for Win32 where it flashes the window icon in the taskbar, and for WXGTK with task bars supporting it.

Parameters:

• flags (Integer) (defaults to: Wx::USER_ATTENTION_INFO)

# File 'lib/wx/doc/gen/top_level_window.rb', line 273

def request_user_attention(flags=Wx::USER_ATTENTION_INFO) end

#restore ⇒ void

This method returns an undefined value.

Restore a previously iconized or maximized window to its normal state.

In WXGTK this method currently doesn’t return the maximized window to its normal state and you must use #maximize with false argument explicitly for this. In the other ports, it both unmaximizes the maximized windows and uniconizes the iconized ones.

See Also:

• #iconize
• #maximize

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

def restore; end

#set_content_protection(contentProtection) ⇒ Boolean

Set content protection for the window.

When content protection is enabled contents of this window will not be included in screen captures. Obviously this can’t provide absolute security as there might be workarounds and tools that bypass this protection. Additionally a screen could always be photographed. true if the content protection was changed, false if running under an unsupported OS.

Note:

Windows 7 or newer is required but any macOS version is supported.

Availability: only available for the WXMSW, WXOSX/Cocoa ports.

Parameters:

• contentProtection (Wx::ContentProtection)

Returns:

• (Boolean)

See Also:

• #get_content_protection

Requires:

• WXMSW or WXOSX

# File 'lib/wx/doc/gen/top_level_window.rb', line 508

def set_content_protection(contentProtection) end

#set_default_item(win) ⇒ Wx::Window Also known as: default_item=

Changes the default item for the panel, usually win is a button.

Parameters:

• win (Wx::Window)

Returns:

• (Wx::Window)

See Also:

• #get_default_item

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

def set_default_item(win) end

#set_icon(icon) ⇒ void Also known as: icon=

This method returns an undefined value.

Sets the icon for this window.

Remark:

The window takes a 'copy' of icon, but since it uses reference counting, the copy is very quick. It is safe to delete icon after calling this function.

Note:

In WXMSW, icon must be either 16x16 or 32x32 icon.

Parameters:

• icon (Wx::Icon) —

  The Icon to associate with this window.

See Also:

• Icon
• #set_icons

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

def set_icon(icon) end

#set_icons(icons) ⇒ void Also known as: icons=

This method returns an undefined value.

Sets several icons of different sizes for this window: this allows using different icons for different situations (e.g.

task switching bar, taskbar, window title bar) instead of scaling, with possibly bad looking results, the only icon set by #set_icon.

Note:

In WXMSW, icons must contain a 16x16 or 32x32 icon, preferably both.

Parameters:

• icons (Wx::IconBundle) —

  The icons to associate with this window.

See Also:

• IconBundle

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

def set_icons(icons) end

#set_max_size(size) ⇒ void Also known as: max_size=

This method returns an undefined value.

A simpler interface for setting the size hints than #set_size_hints.

Parameters:

• size (Array(Integer, Integer), Wx::Size)

# File 'lib/wx/doc/gen/top_level_window.rb', line 339

def set_max_size(size) end

#set_min_size(size) ⇒ void Also known as: min_size=

This method returns an undefined value.

A simpler interface for setting the size hints than #set_size_hints.

Parameters:

• size (Array(Integer, Integer), Wx::Size)

# File 'lib/wx/doc/gen/top_level_window.rb', line 345

def set_min_size(size) end

#set_represented_filename(filename) ⇒ void Also known as: represented_filename=

This method returns an undefined value.

Sets the file name represented by this Wx::TopLevelWindow.

Under macOS, this file name is used to set the “proxy icon”, which appears in the window title bar near its title, corresponding to this file name. Under other platforms it currently doesn’t do anything but it is harmless to call it now and it might be implemented to do something useful in the future so you’re encouraged to use it for any window representing a file-based document.

Parameters:

• filename (String)

# File 'lib/wx/doc/gen/top_level_window.rb', line 428

def set_represented_filename(filename) end

#set_size_hints(minW, minH, maxW = -1, maxH = -1, incW = -1, incH = -1) ⇒ void #set_size_hints(minSize, maxSize = Wx::DEFAULT_SIZE, incSize = Wx::DEFAULT_SIZE) ⇒ void Also known as: size_hints=

Overloads:

• #set_size_hints(minW, minH, maxW = -1, maxH = -1, incW = -1, incH = -1) ⇒ void

  This method returns an undefined value.

  Allows specification of minimum and maximum window sizes, and window size increments.

  If a pair of values is not set (or set to -1), no constraints will be used.

  Remark:

  Notice that this function not only prevents the user from resizing the window outside the given bounds but it also prevents the program itself from doing it using Window#set_size.

  Parameters:

  • minW (Integer) —

    The minimum width.

  • minH (Integer) —

    The minimum height.

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

    The maximum width.

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

    The maximum height.

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

    Specifies the increment for sizing the width (GTK/Motif/Xt only).

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

    Specifies the increment for sizing the height (GTK/Motif/Xt only).

• #set_size_hints(minSize, maxSize = Wx::DEFAULT_SIZE, incSize = Wx::DEFAULT_SIZE) ⇒ void

  This method returns an undefined value.

  Allows specification of minimum and maximum window sizes, and window size increments.

  If a pair of values is not set (or set to -1), no constraints will be used.

  Remark:

  Notice that this function not only prevents the user from resizing the window outside the given bounds but it also prevents the program itself from doing it using Window#set_size.

  Parameters:

  • minSize (Array(Integer, Integer), Wx::Size) —

    The minimum size of the window.

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

    The maximum size of the window.

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

    Increment size (only taken into account under X11-based ports such as WXGTK/Motif/WXX11).

# File 'lib/wx/doc/gen/top_level_window.rb', line 379

def set_size_hints(*args) end

#set_title(title) ⇒ void Also known as: title=

This method returns an undefined value.

Sets the window title.

Parameters:

• title (String) —

  The window title.

See Also:

• #get_title

# File 'lib/wx/doc/gen/top_level_window.rb', line 388

def set_title(title) end

#set_tmp_default_item(win) ⇒ Wx::Window Also known as: tmp_default_item=

Parameters:

• win (Wx::Window)

Returns:

• (Wx::Window)

# File 'lib/wx/doc/gen/top_level_window.rb', line 294

def set_tmp_default_item(win) end

#set_transparent(alpha) ⇒ Boolean Also known as: transparent=

If the platform supports it will set the window to be translucent.

Note that in WXGTK this function must be called before the window is shown the first time it’s called (but it can be called again after showing the window too). See the shaped sample for an example of using this function.

Parameters:

• alpha (Integer) —

  Determines how opaque or transparent the window will be, if the platform supports the operation. A value of 0 sets the window to be fully transparent, and a value of 255 sets the window to be fully opaque.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/top_level_window.rb', line 397

def set_transparent(alpha) end

#should_prevent_app_exit ⇒ Boolean

This virtual function is not meant to be called directly but can be overridden to return false (it returns true by default) to allow the application to close even if this, presumably not very important, window is still opened.

By default, the application stays alive as long as there are any open top level windows.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/top_level_window.rb', line 404

def should_prevent_app_exit; end

#show_full_screen(show, style = Wx::FULLSCREEN_ALL) ⇒ Boolean

Depending on the value of show parameter the window is either shown full screen or restored to its normal state.

style is a bit list containing some or all of the following values, which indicate what elements of the window to hide in full-screen mode:

• FULLSCREEN_NOMENUBAR

• FULLSCREEN_NOTOOLBAR

• FULLSCREEN_NOSTATUSBAR

• FULLSCREEN_NOBORDER

• FULLSCREEN_NOCAPTION

• FULLSCREEN_ALL (all of the above)

This function has not been tested with MDI frames.

Note:

Showing a window full screen also actually Window#shows the window if it isn't shown.

Parameters:

• show (Boolean)
• style (Integer) (defaults to: Wx::FULLSCREEN_ALL)

Returns:

• (Boolean)

See Also:

• #enable_full_screen_view
• #is_full_screen

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

def show_full_screen(show, style=Wx::FULLSCREEN_ALL) end

#show_without_activating ⇒ void

This method returns an undefined value.

Show the Wx::TopLevelWindow, but do not give it keyboard focus.

This can be used for pop up or notification windows that should not steal the current focus.

# File 'lib/wx/doc/gen/top_level_window.rb', line 435

def show_without_activating; end