wxruby3 0.9.1-x64-mingw-ucrt → 0.9.3-x64-mingw-ucrt

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

@@ -58,9 +58,10 @@ module Wx
   FULLSCREEN_ALL = 31
   
   # {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
+  # ### Events emitted by this class
   # 
   # Event handler methods for events emitted by this class:
   # 
@@ -68,16 +69,14 @@ module Wx
   # 
   # - {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_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_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 
@@ -113,6 +112,7 @@ module Wx
     
     # Returns true if the platform supports making the window translucent.
     # 
+    # 
     # @see Wx::TopLevelWindow#set_transparent 
     # @return [Boolean]
     def can_set_transparent; end
@@ -125,19 +125,22 @@ module Wx
     
     # 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.
+    # 
+    # 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] 
@@ -145,21 +148,24 @@ module Wx
     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.
+    # 
+    # 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.
+    # 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 NULL.
+    # 
     # 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]
@@ -167,6 +173,7 @@ module Wx
     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]
@@ -175,13 +182,15 @@ module Wx
     
     # 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.
+    # 
+    # 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. 
@@ -201,6 +210,7 @@ module Wx
     
     # Returns true if the window is in fullscreen mode.
     # 
+    # 
     # @see Wx::TopLevelWindow#show_full_screen 
     # @return [Boolean]
     def is_full_screen; end
@@ -217,6 +227,7 @@ module Wx
     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.
@@ -224,24 +235,46 @@ module Wx
     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.
+    # 
+    # 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
     
+    # MSW-specific function for accessing the system menu.
+    # 
+    # Returns a {Wx::Menu} pointer representing the system menu of the window under MSW. The returned {Wx::Menu} may be used, if non-NULL, to add extra items to the system menu. The usual {Wx::EVT_MENU} events (that can be processed using EVT_MENU event table macro) will then be generated for them. All the other {Wx::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 
+    # ```ruby
+    #   if Wx::PLATFORM == 'WXMSW'
+    # ```
+    #  preprocessor guards.
+    # @return [Wx::Menu]
+    # @wxrb_require WXMSW
+    def msw_get_system_menu; 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.
-    # 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.
+    # <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.
+    # 
+    # 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]
@@ -249,6 +282,7 @@ module Wx
     
     # 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]
@@ -265,9 +299,18 @@ module Wx
     alias_method :tmp_default_item, :get_tmp_default_item
     
     # Sets the icon for this window.
-    # 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.
     # 
-    # In wxMSW, icon must be either 16x16 or 32x32 icon.
+    # <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>
     # @see Wx::Icon
     # @see  Wx::TopLevelWindow#set_icons 
     # @param icon [Wx::Icon]  The {Wx::Icon} to associate with this window.
@@ -276,9 +319,14 @@ module Wx
     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}.
     # 
-    # In wxMSW, icons must contain a 16x16 or 32x32 icon, preferably both.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>In WXMSW, icons must contain a 16x16 or 32x32 icon, preferably both.
+    # </p>
+    # </div>
     # @see Wx::IconBundle 
     # @param icons [Wx::IconBundle]  The icons to associate with this window.
     # @return [void]
@@ -299,9 +347,14 @@ module Wx
     
     # @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.
     #   
-    #   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}.
+    #   <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.
@@ -311,18 +364,24 @@ module Wx
     #   @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.
     #   
-    #   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}.
+    #   <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/{Wx::Motif}/wxX11).
+    #   @param incSize [Array(Integer, Integer), Wx::Size]  Increment size (only taken into account under X11-based ports such as WXGTK/{Wx::Motif}/WXX11).
     #   @return [void]
     def set_size_hints(*args) end
     alias_method :size_hints=, :set_size_hints
     
     # Sets the window title.
     # 
+    # 
     # @see Wx::TopLevelWindow#get_title 
     # @param title [String]  The window title.
     # @return [void]
@@ -330,7 +389,8 @@ module Wx
     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).
+    # 
+    # 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]
@@ -338,11 +398,13 @@ module Wx
     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]
@@ -350,11 +412,13 @@ module Wx
     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
     
     # 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} 
@@ -365,7 +429,12 @@ module Wx
     # - {Wx::FULLSCREEN_ALL} (all of the above)
     # 
     # This function has not been tested with MDI frames.
-    # Showing a window full screen also actually {Wx::TopLevelWindow#show}s the window if it isn't shown.
+    # 
+    # <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] 
@@ -375,26 +444,34 @@ module Wx
     
     # 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
     
     # 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.
     # 
-    # Windows 7 or newer is required but any macOS version is supported.
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>Windows 7 or newer is required but any macOS version is supported.
+    # </p>
+    # </div>
     # 
-    # Availability:  only available for the wxMSW, wxOSX/Cocoa ports.  {Wx::msw},{Wx::osx}
+    # Availability:  only available for the WXMSW, WXOSX/Cocoa ports.
     # @see Wx::TopLevelWindow#get_content_protection
     # @param contentProtection [Wx::ContentProtection] 
     # @return [Boolean]
+    # @wxrb_require WXMSW|WXOSX
     def set_content_protection(contentProtection) end
     alias_method :content_protection=, :set_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