wxruby3 1.8.0 → 1.8.1

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

@@ -1,516 +0,0 @@
-# :stopdoc:
-# This file is automatically generated by the WXRuby3 documentation 
-# generator. Do not alter this file.
-# :startdoc:
-
-
-module Wx
-
-  # 
-  DEFAULT_FRAME_STYLE = 541072960
-  
-  # Requests user attention,.
-  # 
-  USER_ATTENTION_INFO = 1
-  
-  # Results in a more drastic action.
-  # 
-  USER_ATTENTION_ERROR = 2
-  
-  # 
-  # 
-  # 
-  # 
-  class ContentProtection < Wx::Enum
-  
-    # Window contents are visible in screen captures.
-    # 
-    CONTENT_PROTECTION_NONE = Wx::ContentProtection.new(0)
-    
-    # Window contents are not visible in screen captures.
-    # 
-    CONTENT_PROTECTION_ENABLED = Wx::ContentProtection.new(1)
-    
-  end # ContentProtection
-  
-  # Don't display the menu bar.
-  # 
-  FULLSCREEN_NOMENUBAR = 1
-  
-  # Don't display toolbar bars.
-  # 
-  FULLSCREEN_NOTOOLBAR = 2
-  
-  # Don't display the status bar.
-  # 
-  FULLSCREEN_NOSTATUSBAR = 4
-  
-  # Don't display any border.
-  # 
-  FULLSCREEN_NOBORDER = 8
-  
-  # Don't display a caption.
-  # 
-  FULLSCREEN_NOCAPTION = 16
-  
-  # Combination of all above, will display the least possible.
-  # 
-  FULLSCREEN_ALL = 31
-  
-  # Possible parameters for {Wx::Frame#set_window_modality}.
-  # 
-  # 
-  # 
-  class WindowMode < Wx::Enum
-  
-    # Show the frame non-modally, and this is the default.
-    # 
-    Normal = Wx::WindowMode.new(0)
-    
-    # Disable only the parent window while the frame is shown.
-    # 
-    WindowModal = Wx::WindowMode.new(1)
-    
-    # Disable all the other TLWs while the frame is shown.
-    # 
-    AppModal = Wx::WindowMode.new(2)
-    
-  end # WindowMode
-  
-  # {Wx::TopLevelWindow} is a common base class for {Wx::Dialog} and {Wx::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 {Wx::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:
-  # 
-  # - {Wx::EvtHandler#evt_maximize}(meth = nil, &block): Process a {Wx::EVT_MAXIMIZE} event. See {Wx::MaximizeEvent}. 
-  # 
-  # - {Wx::EvtHandler#evt_move}(meth = nil, &block): Process a {Wx::EVT_MOVE} event, which is generated when a window is moved. See {Wx::MoveEvent}. 
-  # 
-  # - {Wx::EvtHandler#evt_move_start}(meth = nil, &block): Process a {Wx::EVT_MOVE_START} event, which is generated when the user starts to move or size a window. WXMSW only. See {Wx::MoveEvent}. 
-  # 
-  # - {Wx::EvtHandler#evt_move_end}(meth = nil, &block): Process a {Wx::EVT_MOVE_END} event, which is generated when the user stops moving or sizing a window. WXMSW only. See {Wx::MoveEvent}. 
-  # 
-  # - {Wx::EvtHandler#evt_show}(meth = nil, &block): Process a {Wx::EVT_SHOW} event. See {Wx::ShowEvent}. 
-  # 
-  # - {Wx::EvtHandler#evt_fullscreen}(meth = nil, &block): Process a {Wx::EVT_FULLSCREEN} event. See {Wx::FullScreenEvent}. 
-  # 
-  # Category:  Managed Windows
-  # @see Wx::Dialog
-  # @see  Wx::Frame 
-  # 
-  # 
-  class TopLevelWindow < NonOwnedWindow
-  
-    # @overload initialize()
-    #   Default ctor.
-    #   @return [Wx::TopLevelWindow]
-    # @overload initialize(parent, id, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_FRAME_STYLE, name=Wx::FRAME_NAME_STR)
-    #   Constructor creating the top level window.
-    #   @param parent [Wx::Window] 
-    #   @param id [Integer] 
-    #   @param title [String] 
-    #   @param pos [Array(Integer, Integer), Wx::Point] 
-    #   @param size [Array(Integer, Integer), Wx::Size] 
-    #   @param style [Integer] 
-    #   @param name [String] 
-    #   @return [Wx::TopLevelWindow]
-    def initialize(*args) end
-    
-    # Creates the top level window.
-    # @param parent [Wx::Window] 
-    # @param id [Integer] 
-    # @param title [String] 
-    # @param pos [Array(Integer, Integer), Wx::Point] 
-    # @param size [Array(Integer, Integer), Wx::Size] 
-    # @param style [Integer] 
-    # @param name [String] 
-    # @return [Boolean]
-    def create(parent, id, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_FRAME_STYLE, name=Wx::FRAME_NAME_STR) end
-    
-    # Returns true if the platform supports making the window translucent.
-    # 
-    # 
-    # @see Wx::TopLevelWindow#set_transparent 
-    # @return [Boolean]
-    def can_set_transparent; end
-    alias_method :can_set_transparent?, :can_set_transparent
-    
-    # A synonym for {Wx::TopLevelWindow#centre_on_screen}.
-    # @param direction [Integer] 
-    # @return [void]
-    def center_on_screen(direction=Wx::Orientation::BOTH) end
-    
-    # Centres the window on screen.
-    # 
-    # 
-    # @see Wx::Window#centre_on_parent 
-    # @param direction [Integer]  Specifies the direction for the centering. May be {Wx::Orientation::HORIZONTAL}, {Wx::Orientation::VERTICAL} or {Wx::Orientation::BOTH}.
-    # @return [void]
-    def centre_on_screen(direction=Wx::Orientation::BOTH) end
-    
-    # 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.
-    # @param enable [Boolean] 
-    # @return [Boolean]
-    def enable_close_button(enable=true) end
-    
-    # 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 {Wx::MAXIMIZE_BOX}.
-    # Returns true if operation was successful. Note that a successful operation does not change the window style flags.
-    # @param enable [Boolean] 
-    # @return [Boolean]
-    def enable_maximize_button(enable=true) end
-    
-    # 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 {Wx::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.
-    # @param enable [Boolean] 
-    # @return [Boolean]
-    def enable_minimize_button(enable=true) end
-    
-    # Returns a pointer to the button which is the default for this window, or nil.
-    # 
-    # The default button is the one activated by pressing the Enter key.
-    # @return [Wx::Window]
-    def get_default_item; end
-    alias_method :default_item, :get_default_item
-    
-    # Returns the standard icon of the window.
-    # 
-    # The icon will be invalid if it hadn't been previously set by {Wx::TopLevelWindow#set_icon}.
-    # @see Wx::TopLevelWindow#get_icons 
-    # @return [Wx::Icon]
-    def get_icon; end
-    alias_method :icon, :get_icon
-    
-    # Returns all icons associated with the window, there will be none of them if neither {Wx::TopLevelWindow#set_icon} nor {Wx::TopLevelWindow#set_icons} had been called before.
-    # 
-    # Use {Wx::TopLevelWindow#get_icon} to get the main icon of the window.
-    # @see Wx::IconBundle 
-    # @return [Wx::IconBundle]
-    def get_icons; end
-    alias_method :icons, :get_icons
-    
-    # Get the window title.
-    # 
-    # This base class function is overridden in this class to behave as {Wx::TopLevelWindow#get_title} and is useful when having only a <code>wxWindow*</code> pointer.
-    # Please call {Wx::TopLevelWindow#get_title} directly instead of this function for clarity if possible.
-    # @return [String]
-    def get_label; end
-    alias_method :label, :get_label
-    
-    # Gets a string containing the window title.
-    # 
-    # 
-    # @see Wx::TopLevelWindow#set_title 
-    # @return [String]
-    def get_title; end
-    alias_method :title, :get_title
-    
-    # Iconizes or restores the window.
-    # 
-    # Note that in WXGTK the change to the window state is not immediate, i.e. {Wx::TopLevelWindow#is_iconized} will typically return false right after a call to {Wx::TopLevelWindow#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.
-    # @see Wx::TopLevelWindow#is_iconized
-    # @see  Wx::TopLevelWindow#restore
-    # @see  Wx::IconizeEvent. 
-    # @param iconize [Boolean]  If true, iconizes the window; if false, shows and restores it.
-    # @return [void]
-    def iconize(iconize=true) end
-    
-    # Returns true if this window is currently active, i.e. if the user is currently working with it.
-    # @return [Boolean]
-    def is_active; end
-    alias_method :active?, :is_active
-    
-    # Returns true if this window is expected to be always maximized, either due to platform policy or due to local policy regarding particular class.
-    # @return [Boolean]
-    def is_always_maximized; end
-    alias_method :always_maximized?, :is_always_maximized
-    
-    # Returns true if the window is in fullscreen mode.
-    # 
-    # 
-    # @see Wx::TopLevelWindow#show_full_screen 
-    # @return [Boolean]
-    def is_full_screen; end
-    alias_method :full_screen?, :is_full_screen
-    
-    # Returns true if the window is iconized.
-    # @return [Boolean]
-    def is_iconized; end
-    alias_method :iconized?, :is_iconized
-    
-    # Returns true if the window is maximized.
-    # @return [Boolean]
-    def is_maximized; end
-    alias_method :maximized?, :is_maximized
-    
-    # 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 {Wx::TopLevelWindow#layout} method to check if this window contains exactly one child  which is commonly the case, with {Wx::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.
-    # @return [Boolean]
-    def layout; end
-    
-    # Maximizes or restores the window.
-    # 
-    # Note that, just as with {Wx::TopLevelWindow#iconize}, the change to the window state is not immediate in at least WXGTK port.
-    # @see Wx::TopLevelWindow#restore
-    # @see  Wx::TopLevelWindow#iconize 
-    # @param maximize [Boolean]  If true, maximizes the window, otherwise it restores it.
-    # @return [void]
-    def maximize(maximize=true) end
-    
-    # Use a system-dependent way to attract users attention to the window when it is in background.
-    # 
-    # flags may have the value of either {Wx::USER_ATTENTION_INFO} (default) or {Wx::USER_ATTENTION_ERROR} which results in a more drastic action. When in doubt, use the default value.
-    # 
-    # <div class="wxrb-note">
-    # <b>Note:</b>
-    # <p>This function should normally be only used when the application is not already in foreground.
-    # </p>
-    # </div>
-    # 
-    # This function is currently implemented for Win32 where it flashes the window icon in the taskbar, and for WXGTK with task bars supporting it.
-    # @param flags [Integer] 
-    # @return [void]
-    def request_user_attention(flags=Wx::USER_ATTENTION_INFO) end
-    
-    # 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 {Wx::TopLevelWindow#maximize} with false argument explicitly for this. In the other ports, it both unmaximizes the maximized windows and uniconizes the iconized ones.
-    # @see Wx::TopLevelWindow#iconize
-    # @see  Wx::TopLevelWindow#maximize 
-    # @return [void]
-    def restore; end
-    
-    # Changes the default item for the panel, usually win is a button.
-    # 
-    # 
-    # @see Wx::TopLevelWindow#get_default_item 
-    # @param win [Wx::Window] 
-    # @return [Wx::Window]
-    def set_default_item(win) end
-    alias_method :default_item=, :set_default_item
-    
-    # @param win [Wx::Window] 
-    # @return [Wx::Window]
-    def set_tmp_default_item(win) end
-    alias_method :tmp_default_item=, :set_tmp_default_item
-    
-    # @return [Wx::Window]
-    def get_tmp_default_item; end
-    alias_method :tmp_default_item, :get_tmp_default_item
-    
-    # Sets the icon for this window.
-    # 
-    # <div class="wxrb-remark">
-    # <b>Remark:</b>
-    # <p>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.
-    # </p>
-    # </div>
-    # 
-    # <div class="wxrb-note">
-    # <b>Note:</b>
-    # <p>In WXMSW, icon must be either 16x16 or 32x32 icon.
-    # </p>
-    # </div>
-    # 
-    # <div class="wxrb-note">
-    # <b>Note:</b>
-    # <p>In WXGTK this function currently doesn't do anything when using Wayland, which doesn't allow setting the icon for a window. Please create a .desktop file for your application to set the icon for its windows.
-    # </p>
-    # </div>
-    # @see Wx::Icon
-    # @see  Wx::TopLevelWindow#set_icons 
-    # @param icon [Wx::Icon]  The {Wx::Icon} to associate with this window.
-    # @return [void]
-    def set_icon(icon) end
-    alias_method :icon=, :set_icon
-    
-    # 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 {Wx::TopLevelWindow#set_icon}.
-    # 
-    # <div class="wxrb-note">
-    # <b>Note:</b>
-    # <p>In WXMSW, icons must contain a 16x16 or 32x32 icon, preferably both.
-    # </p>
-    # </div>
-    # 
-    # <div class="wxrb-note">
-    # <b>Note:</b>
-    # <p>In WXGTK this function currently doesn't do anything when using Wayland, which doesn't allow setting the icon for a window. Please create a .desktop file for your application to set the icon for its windows.
-    # </p>
-    # </div>
-    # @see Wx::IconBundle 
-    # @param icons [Wx::IconBundle]  The icons to associate with this window.
-    # @return [void]
-    def set_icons(icons) end
-    alias_method :icons=, :set_icons
-    
-    # A simpler interface for setting the size hints than {Wx::TopLevelWindow#set_size_hints}.
-    # @param size [Array(Integer, Integer), Wx::Size] 
-    # @return [void]
-    def set_max_size(size) end
-    alias_method :max_size=, :set_max_size
-    
-    # A simpler interface for setting the size hints than {Wx::TopLevelWindow#set_size_hints}.
-    # @param size [Array(Integer, Integer), Wx::Size] 
-    # @return [void]
-    def set_min_size(size) end
-    alias_method :min_size=, :set_min_size
-    
-    # @overload set_size_hints(minW, minH, maxW=-1, maxH=-1, incW=-1, incH=-1)
-    #   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.
-    #   
-    #   <div class="wxrb-remark">
-    #   <b>Remark:</b>
-    #   <p>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 {Wx::Window#set_size}. 
-    #   </p>
-    #   </div>
-    #   @param minW [Integer]  The minimum width.
-    #   @param minH [Integer]  The minimum height.
-    #   @param maxW [Integer]  The maximum width.
-    #   @param maxH [Integer]  The maximum height.
-    #   @param incW [Integer]  Specifies the increment for sizing the width (GTK/X11 only).
-    #   @param incH [Integer]  Specifies the increment for sizing the height (GTK/X11 only).
-    #   @return [void]
-    # @overload set_size_hints(minSize, maxSize=Wx::DEFAULT_SIZE, incSize=Wx::DEFAULT_SIZE)
-    #   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.
-    #   
-    #   <div class="wxrb-remark">
-    #   <b>Remark:</b>
-    #   <p>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 {Wx::Window#set_size}. 
-    #   </p>
-    #   </div>
-    #   @param minSize [Array(Integer, Integer), Wx::Size]  The minimum size of the window.
-    #   @param maxSize [Array(Integer, Integer), Wx::Size]  The maximum size of the window.
-    #   @param incSize [Array(Integer, Integer), Wx::Size]  Increment size (only taken into account under X11-based ports such as WXGTK and WXX11).
-    #   @return [void]
-    def set_size_hints(*args) end
-    alias_method :size_hints=, :set_size_hints
-    
-    # Sets the window title.
-    # 
-    # This base class function is overridden in this class to behave as {Wx::TopLevelWindow#set_title} and is useful when having only a <code>wxWindow*</code> pointer.
-    # Please call {Wx::TopLevelWindow#set_title} directly instead of this function for clarity if possible.
-    # @param title [String]  The window title.
-    # @return [void]
-    def set_label(title) end
-    alias_method :label=, :set_label
-    
-    # Sets the window title.
-    # 
-    # 
-    # @see Wx::TopLevelWindow#get_title 
-    # @param title [String]  The window title.
-    # @return [void]
-    def set_title(title) end
-    alias_method :title=, :set_title
-    
-    # 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.
-    # @param 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.
-    # @return [Boolean]
-    def set_transparent(alpha) end
-    alias_method :transparent=, :set_transparent
-    
-    # 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.
-    # @return [Boolean]
-    def should_prevent_app_exit; end
-    
-    # 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.
-    # @param filename [String] 
-    # @return [void]
-    def set_represented_filename(filename) end
-    alias_method :represented_filename=, :set_represented_filename
-    
-    # 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.
-    # @return [void]
-    def show_without_activating; end
-    
-    # Enables the zoom button to toggle full screen mode.
-    # 
-    # This function is currently only implemented in WXOSX and simply returns false in the other ports.
-    # A {Wx::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 unsupported OS.
-    # 
-    # <div class="wxrb-note">
-    # <b>Note:</b>
-    # <p>Having the button is also required to let {Wx::TopLevelWindow#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 {Wx::FULLSCREEN_NOTOOLBAR} and {Wx::FULLSCREEN_NOMENUBAR} will be used when using the fullscreen API (other values are ignored).
-    # </p>
-    # </div>
-    # @see Wx::TopLevelWindow#show_full_screen
-    # @see  Wx::FullScreenEvent
-    # @param enable [Boolean]  If true (default) make the zoom button toggle full screen; if false the button does only toggle zoom.
-    # @param style [Integer]  This parameter sets which elements will be hidden when the user presses the full screen button. See {Wx::TopLevelWindow#show_full_screen} for possible values. It is available since wxWidgets 3.1.6.
-    # @return [Boolean]
-    def enable_full_screen_view(enable=true, style=Wx::FULLSCREEN_ALL) end
-    
-    # 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:
-    # 
-    # - {Wx::FULLSCREEN_NOMENUBAR} 
-    # - {Wx::FULLSCREEN_NOTOOLBAR} 
-    # - {Wx::FULLSCREEN_NOSTATUSBAR} 
-    # - {Wx::FULLSCREEN_NOBORDER} 
-    # - {Wx::FULLSCREEN_NOCAPTION} 
-    # - {Wx::FULLSCREEN_ALL} (all of the above)
-    # 
-    # This function has not been tested with MDI frames.
-    # 
-    # <div class="wxrb-note">
-    # <b>Note:</b>
-    # <p>Showing a window full screen also actually {Wx::TopLevelWindow#show}s the window if it isn't shown.
-    # </p>
-    # </div>
-    # @see Wx::TopLevelWindow#enable_full_screen_view
-    # @see  Wx::TopLevelWindow#is_full_screen 
-    # @param show [Boolean] 
-    # @param style [Integer] 
-    # @return [Boolean]
-    def show_full_screen(show, style=Wx::FULLSCREEN_ALL) end
-    
-    # Get the current content protection of the window.
-    # 
-    # 
-    # @see Wx::TopLevelWindow#set_content_protection
-    # @return [Wx::ContentProtection]
-    def get_content_protection; end
-    alias_method :content_protection, :get_content_protection
-    
-    # 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 {Wx::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.
-    # @return [Wx::Size]
-    def self.get_default_size; end
-    
-  end # TopLevelWindow
-  
-
-end