wxruby3 0.9.0.pre.beta.8-x64-mingw-ucrt

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

@@ -0,0 +1,132 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This class holds a variety of information related to font dialogs.
+  # === 
+  # 
+  # Category:  Common Dialogs, Data Structures
+  # @see wxFontDialog Overview
+  # @see  Wx::Font
+  # @see  Wx::FontDialog 
+  # 
+  # 
+  class FontData < Object
+  
+    # Constructor.
+    # Initializes fontColour to black, showHelp to false, allowSymbols to true, enableEffects to true, minSize to 0 and maxSize to 0.
+    # @return [FontData]
+    def initialize; end
+    
+    # Enables or disables "effects" under Windows or generic only.
+    # This refers to the controls for manipulating colour, strikeout and underline properties.
+    # The default value is true.
+    # @param enable [true,false] 
+    # @return [void]
+    def enable_effects(enable) end
+    
+    # Under Windows, returns a flag determining whether symbol fonts can be selected.
+    # Has no effect on other platforms.
+    # The default value is true.
+    # @return [true,false]
+    def get_allow_symbols; end
+    alias_method :allow_symbols, :get_allow_symbols
+    
+    # Gets the font chosen by the user if the user pressed OK ({Wx::FontDialog#show_modal} returned {Wx::StandardID::ID_OK}).
+    # @return [Wx::Font]
+    def get_chosen_font; end
+    alias_method :chosen_font, :get_chosen_font
+    
+    # Gets the colour associated with the font dialog.
+    # The default value is black.
+    # @return [Wx::Colour,String,Symbol]
+    def get_colour; end
+    alias_method :colour, :get_colour
+    
+    # Determines whether "effects" are enabled under Windows.
+    # This refers to the controls for manipulating colour, strikeout and underline properties.
+    # The default value is true.
+    # @return [true,false]
+    def get_enable_effects; end
+    
+    # Returns the state of the flags restricting the selection.
+    # Note that currently these flags are only effectively used in {Wx::MSW}.
+    # 
+    # - {Wx::FONTRESTRICT_NONE} If no restriction applies, or a combination of the following flags:- {Wx::FONTRESTRICT_SCALABLE} To show only scalable fonts - no raster fonts.- {Wx::FONTRESTRICT_FIXEDPITCH} To show only monospaced fonts.
+    # 
+    # The default value is {Wx::FONTRESTRICT_NONE}.
+    # @return [Integer]
+    def get_restrict_selection; end
+    
+    # Gets the font that will be initially used by the font dialog.
+    # This should have previously been set by the application.
+    # @return [Wx::Font]
+    def get_initial_font; end
+    alias_method :initial_font, :get_initial_font
+    
+    # Returns true if the Help button will be shown (Windows only).
+    # The default value is false.
+    # @return [true,false]
+    def get_show_help; end
+    alias_method :show_help, :get_show_help
+    
+    # Restricts the selection to a subset of the available fonts.
+    # Note that currently these flags are only effectively used in {Wx::MSW} and are ignored in the other ports.
+    # Possible values are:
+    # 
+    # - {Wx::FONTRESTRICT_NONE} No restriction, show all fonts in the dialog.- {Wx::FONTRESTRICT_SCALABLE} To show only scalable fonts - no raster fonts.- {Wx::FONTRESTRICT_FIXEDPITCH} To show only monospaced fonts.
+    # 
+    # The default value is {Wx::FONTRESTRICT_NONE}.
+    # @param flags [Integer] 
+    # @return [void]
+    def restrict_selection(flags) end
+    
+    # Under Windows, determines whether symbol fonts can be selected.
+    # Has no effect on other platforms.
+    # The default value is true.
+    # @param allowSymbols [true,false] 
+    # @return [void]
+    def set_allow_symbols(allowSymbols) end
+    alias_method :allow_symbols=, :set_allow_symbols
+    
+    # Sets the font that will be returned to the user (for internal use only).
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_chosen_font(font) end
+    alias_method :chosen_font=, :set_chosen_font
+    
+    # Sets the colour that will be used for the font foreground colour.
+    # The default colour is black.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_colour(colour) end
+    alias_method :colour=, :set_colour
+    
+    # Sets the font that will be initially used by the font dialog.
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_initial_font(font) end
+    alias_method :initial_font=, :set_initial_font
+    
+    # Sets the valid range for the font point size (Windows only).
+    # The default is 0, 0 (unrestricted range).
+    # @param min [Integer] 
+    # @param max [Integer] 
+    # @return [void]
+    def set_range(min, max) end
+    
+    # Determines whether the Help button will be displayed in the font dialog (Windows only).
+    # The default value is false.
+    # @param showHelp [true,false] 
+    # @return [void]
+    def set_show_help(showHelp) end
+    alias_method :show_help=, :set_show_help
+    
+  end # FontData
+  
+
+end

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

@@ -0,0 +1,71 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Shows the font selection dialog and returns the font selected by user or invalid font (use {Wx::Font#is_ok} to test whether a font is valid) if the dialog was cancelled.
+  # Include file: #include <wx/fontdlg.h>
+  # @param parent [Wx::Window]  The parent window for the font selection dialog.
+  # @param fontInit [Wx::Font,Wx::FontInfo]  If given, this will be the font initially selected in the dialog.
+  # @param caption [String]  If given, this will be used for the dialog caption.
+  # @return [Wx::Font]
+  def self.get_font_from_user(parent, fontInit, caption=Wx::EMPTY_STRING) end
+  
+  # This class represents the font chooser dialog.
+  # === 
+  # 
+  # Category:  Common Dialogs
+  # @see wxFontDialog Overview
+  # @see  Wx::FontData
+  # @see  get_font_from_user 
+  # 
+  # 
+  class FontDialog < Dialog
+  
+    # Returns the font data associated with the font dialog.
+    # @return [void]
+    def get_font_data; end
+    alias_method :font_data, :get_font_data
+    
+    # @overload initialize()
+    #   Default ctor.
+    #   {Wx::FontDialog#create} must be called before the dialog can be shown.
+    #   @return [FontDialog]
+    # @overload initialize(parent)
+    #   Constructor with parent window.
+    #   @param parent [Wx::Window] 
+    #   @return [FontDialog]
+    # @overload initialize(parent, data)
+    #   Constructor.
+    #   Pass a parent window, and the font data object to be used to initialize the dialog controls.
+    #   @param parent [Wx::Window] 
+    #   @param data [Wx::FontData] 
+    #   @return [FontDialog]
+    def initialize(*args) end
+    
+    # @overload create(parent)
+    #   Creates the dialog if the {Wx::FontDialog} object had been initialized using the default constructor.
+    #   true on success and false if an error occurred.
+    #   @param parent [Wx::Window] 
+    #   @return [true,false]
+    # @overload create(parent, data)
+    #   Creates the dialog if the {Wx::FontDialog} object had been initialized using the default constructor.
+    #   true on success and false if an error occurred.
+    #   @param parent [Wx::Window] 
+    #   @param data [Wx::FontData] 
+    #   @return [true,false]
+    def create(*args) end
+    
+    # Shows the dialog, returning {Wx::StandardID::ID_OK} if the user pressed Ok, and {Wx::StandardID::ID_CANCEL} otherwise.
+    # If the user cancels the dialog (ShowModal returns {Wx::StandardID::ID_CANCEL}), no font will be created. If the user presses OK, a new {Wx::Font} will be created and stored in the font dialog's {Wx::FontData} structure.
+    # @see Wx::FontDialog#get_font_data 
+    # @return [Integer]
+    def show_modal; end
+    
+  end # FontDialog
+  
+
+end

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

@@ -0,0 +1,120 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This control allows the user to select a font.
+  # The generic implementation is a button which brings up a {Wx::FontDialog} when clicked. Native implementation may differ but this is usually a (small) widget which give access to the font-chooser dialog. It is only available if {Wx::Setup::USE_FONTPICKERCTRL} is set to 1 (the default).
+  # === Styles
+  # 
+  # This class supports the following styles:
+  #  
+  # - {Wx::FNTP_DEFAULT_STYLE}: The default style: {Wx::FNTP_FONTDESC_AS_LABEL} | {Wx::FNTP_USEFONT_FOR_LABEL}. 
+  # - {Wx::FNTP_USE_TEXTCTRL}: Creates a text control to the left of the picker button which is completely managed by the {Wx::FontPickerCtrl} and which can be used by the user to specify a font (see SetSelectedFont). The text control is automatically synchronized with button's value. Use functions defined in {Wx::PickerBase} to modify the text control. 
+  # - {Wx::FNTP_FONTDESC_AS_LABEL}: Keeps the label of the button updated with the fontface name and the font size. E.g. choosing "Times New Roman bold, italic with
+  # size 10" from the fontdialog, will update the label (overwriting any previous label) with the "Times New Roman, 10" text. 
+  # - {Wx::FNTP_USEFONT_FOR_LABEL}: Uses the currently selected font to draw the label of the button. 
+  # 
+  # === Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::FontPickerEvent} events.
+  # Event handler methods for events emitted by this class:
+  # - {Wx::EvtHandler#evt_fontpicker_changed}(id, meth = nil, &block): The user changed the font selected in the control either using the button or using text control (see {Wx::FNTP_USE_TEXTCTRL}; note that in this case the event is fired only if the user's input is valid, i.e. recognizable). 
+  # 
+  # === 
+  # 
+  # Category:  Picker Controls  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> {Wx::MSW} Appearance
+  #   </td><td> {Wx::GTK} Appearance
+  #   </td><td> {Wx::OSX} Appearance
+  #   </td></tr></table></div>
+  # @see Wx::FontDialog
+  # @see  Wx::FontPickerEvent 
+  # 
+  # 
+  class FontPickerCtrl < PickerBase
+  
+    # @overload initialize()
+    #   @return [FontPickerCtrl]
+    # @overload initialize(parent, id, font=Wx::NULL_FONT, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::FNTP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::FONT_PICKER_CTRL_NAME_STR)
+    #   Initializes the object and calls {Wx::FontPickerCtrl#create} with all the parameters.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param font [Wx::Font,Wx::FontInfo] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param validator [Wx::Validator] 
+    #   @param name [String] 
+    #   @return [FontPickerCtrl]
+    def initialize(*args) end
+    
+    # Creates this widget with given parameters.
+    # true if the control was successfully created or false if creation failed.
+    # @param parent [Wx::Window]  Parent window, must not be non-NULL.
+    # @param id [Integer]  The identifier for the control.
+    # @param font [Wx::Font,Wx::FontInfo]  The initial font shown in the control. If {Wx::NULL_FONT} is given, the default font is used.
+    # @param pos [Array(Integer, Integer), Wx::Point]  Initial position.
+    # @param size [Array(Integer, Integer), Wx::Size]  Initial size.
+    # @param style [Integer]  The window style, see {Wx::FNTP_}* flags.
+    # @param validator [Wx::Validator]  Validator which can be used for additional data checks.
+    # @param name [String]  Control name.
+    # @return [true,false]
+    def create(parent, id, font=Wx::NULL_FONT, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::FNTP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::FONT_PICKER_CTRL_NAME_STR) end
+    
+    # Returns the maximum point size value allowed for the user-chosen font.
+    # @return [Integer]
+    def get_max_point_size; end
+    alias_method :max_point_size, :get_max_point_size
+    
+    # Returns the minimum point size value allowed for the user-chosen font.
+    # @return [Integer]
+    def get_min_point_size; end
+    alias_method :min_point_size, :get_min_point_size
+    
+    # Returns the currently selected colour.
+    # Note that the colour of the font can only be set by the user under Windows currently, elsewhere this method simply returns the colour previously set by {Wx::FontPickerCtrl#set_selected_colour} or black if it hadn't been called.
+    # @return [Wx::Colour]
+    def get_selected_colour; end
+    alias_method :selected_colour, :get_selected_colour
+    
+    # Returns the currently selected font.
+    # Note that this function is completely different from {Wx::Window#get_font}.
+    # @return [Wx::Font]
+    def get_selected_font; end
+    alias_method :selected_font, :get_selected_font
+    
+    # Sets the maximum point size value allowed for the user-chosen font.
+    # The default value is 100. Note that big fonts can require a lot of memory and CPU time both for creation and for rendering; thus, specially because the user has the option to specify the fontsize through a text control (see {Wx::FNTP_USE_TEXTCTRL}), it's a good idea to put a limit to the maximum font size when huge fonts do not make much sense.
+    # @param max [Integer] 
+    # @return [void]
+    def set_max_point_size(max) end
+    alias_method :max_point_size=, :set_max_point_size
+    
+    # Sets the minimum point size value allowed for the user-chosen font.
+    # The default value is 0.
+    # @param min [Integer] 
+    # @return [void]
+    def set_min_point_size(min) end
+    alias_method :min_point_size=, :set_min_point_size
+    
+    # Sets the font colour.
+    # The font colour is actually only used under Windows currently, but this function is available under all platforms for consistency.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_selected_colour(colour) end
+    alias_method :selected_colour=, :set_selected_colour
+    
+    # Sets the currently selected font.
+    # Note that this function is completely different from {Wx::Window#set_font}.
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_selected_font(font) end
+    alias_method :selected_font=, :set_selected_font
+    
+  end # FontPickerCtrl
+  
+
+end

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

@@ -0,0 +1,64 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  FNTP_FONTDESC_AS_LABEL = 8
+  
+  # 
+  FNTP_USEFONT_FOR_LABEL = 16
+  
+  # 
+  FONTBTN_DEFAULT_STYLE = 24
+  
+  # 
+  FNTP_USE_TEXTCTRL = 2
+  
+  # 
+  FNTP_DEFAULT_STYLE = 24
+  
+  # 
+  # 
+  EVT_FONTPICKER_CHANGED = 10170
+  
+  # This event class is used for the events generated by {Wx::FontPickerCtrl}.
+  # === Events using this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::FontPickerEvent} events.
+  # Event handler methods:
+  # - {Wx::EvtHandler#evt_fontpicker_changed}(id, meth = nil, &block): Generated whenever the selected font changes. 
+  # 
+  # === 
+  # 
+  # Category:  {Wx::Events}
+  # @see Wx::FontPickerCtrl 
+  # 
+  # 
+  class FontPickerEvent < CommandEvent
+  
+    # The constructor is not normally used by the user code.
+    # @param generator [Wx::Object] 
+    # @param id [Integer] 
+    # @param font [Wx::Font,Wx::FontInfo] 
+    # @return [FontPickerEvent]
+    def initialize(generator, id, font) end
+    
+    # Retrieve the font the user has just selected.
+    # @return [Wx::Font]
+    def get_font; end
+    alias_method :font, :get_font
+    
+    # Set the font associated with the event.
+    # @param f [Wx::Font,Wx::FontInfo] 
+    # @return [void]
+    def set_font(f) end
+    alias_method :font=, :set_font
+    
+  end # FontPickerEvent
+  
+
+end

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

@@ -0,0 +1,276 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  FRAME_NO_TASKBAR = 2
+  
+  # 
+  FRAME_TOOL_WINDOW = 4
+  
+  # 
+  FRAME_FLOAT_ON_PARENT = 8
+  
+  # A frame is a window whose size and position can (usually) be changed by the user.
+  # It usually has thick borders and a title bar, and can optionally contain a menu bar, toolbar and status bar. A frame can contain any window that is not a frame or dialog.
+  # A frame that has a status bar and toolbar, created via the {Wx::Frame#create_status_bar} and {Wx::Frame#create_tool_bar} functions, manages these windows and adjusts the value returned by {Wx::Frame#get_client_size} to reflect the remaining size available to application windows.
+  # If a frame is to be used as an input form, the controls should not be created as its children. Instead, a {Wx::Panel} should be created as the sole child of the frame, serving as the parent of the actual controls (the frame will size the panel so it always fills its client area). Doing this will ensure that tabbing between the controls works and the frame background has the expected colour. Moreover, as a frame is by default resizable, it could be better to use {Wx::ScrolledWindow} instead of {Wx::Panel}, to make sure the controls are easily accessible regardless of the frame size. However, please consider whether it would not be better to use {Wx::Dialog} instead of {Wx::Frame}, where using a panel like this is not needed and {Wx::Dialog} also offers other benefits such as creating specialized sizers (e.g., for buttons, with their platform-correct order).
+  # An application should normally define a {Wx::CloseEvent} handler for the frame to respond to system close events, for example so that related data and subwindows can be cleaned up.
+  # 
+  # == Default event processing
+  # 
+  # {Wx::Frame} processes the following events:
+  # 
+  # - {Wx::EVT_SIZE}: if the frame has exactly one child window, not counting the status and toolbar, this child is resized to take the entire frame client area. If two or more windows are present, they should be laid out explicitly either by manually handling {Wx::EVT_SIZE} or using sizers; 
+  # - {Wx::EVT_MENU_HIGHLIGHT}: the default implementation displays the help string associated with the selected item in the first pane of the status bar, if there is one.
+  # 
+  # === Styles
+  # 
+  # This class supports the following styles:
+  #  
+  # - {Wx::DEFAULT_FRAME_STYLE}: Defined as {Wx::MINIMIZE_BOX} | {Wx::MAXIMIZE_BOX} | {Wx::RESIZE_BORDER} | {Wx::SYSTEM_MENU} | {Wx::CAPTION} | {Wx::CLOSE_BOX} | {Wx::CLIP_CHILDREN}. 
+  # - {Wx::ICONIZE}: Display the frame iconized (minimized). Windows only. 
+  # - {Wx::CAPTION}: Puts a caption on the frame. Notice that this flag is required by {Wx::MINIMIZE_BOX}, {Wx::MAXIMIZE_BOX} and {Wx::CLOSE_BOX} on most systems as the corresponding buttons cannot be shown if the window has no title bar at all. I.e. if {Wx::CAPTION} is not specified those styles would be simply ignored. 
+  # - {Wx::MINIMIZE}: Identical to {Wx::ICONIZE}. Windows only. 
+  # - {Wx::MINIMIZE_BOX}: Displays a minimize box on the frame. 
+  # - {Wx::MAXIMIZE}: Displays the frame maximized. Windows and GTK+ only. 
+  # - {Wx::MAXIMIZE_BOX}: Displays a maximize box on the frame. Notice that under {Wx::GTK} {Wx::RESIZE_BORDER} must be used as well or this style is ignored. 
+  # - {Wx::CLOSE_BOX}: Displays a close box on the frame. 
+  # - {Wx::STAY_ON_TOP}: Stay on top of all other windows, see also {Wx::FRAME_FLOAT_ON_PARENT}. 
+  # - {Wx::SYSTEM_MENU}: Displays a system menu containing the list of various windows commands in the window title bar. Unlike {Wx::MINIMIZE_BOX}, {Wx::MAXIMIZE_BOX} and {Wx::CLOSE_BOX} styles this style can be used without {Wx::CAPTION}, at least under Windows, and makes the system menu available without showing it on screen in this case. However it is recommended to only use it together with {Wx::CAPTION} for consistent behaviour under all platforms. 
+  # - {Wx::RESIZE_BORDER}: Displays a resizable border around the window. 
+  # - {Wx::FRAME_TOOL_WINDOW}: Causes a frame with a small title bar to be created; the frame does not appear in the taskbar under Windows or GTK+. 
+  # - {Wx::FRAME_NO_TASKBAR}: Creates an otherwise normal frame but it does not appear in the taskbar under Windows or GTK+ (note that it will minimize to the desktop window under Windows which may seem strange to the users and thus it might be better to use this style only without {Wx::MINIMIZE_BOX} style). In {Wx::GTK}, the flag is respected only if the window manager supports _NET_WM_STATE_SKIP_TASKBAR hint. 
+  # - {Wx::FRAME_FLOAT_ON_PARENT}: The frame will always be on top of its parent (unlike {Wx::STAY_ON_TOP}). A frame created with this style must have a non-NULL parent. 
+  # - {Wx::FRAME_SHAPED}: Windows with this style are allowed to have their shape changed with the {Wx::Frame#set_shape} method. 
+  # 
+  # The default frame style is for normal, resizable frames. To create a frame which cannot be resized by user, you may use the following combination of styles:
+  # 
+  #   wxDEFAULT_FRAME_STYLE & ~(wxRESIZE_BORDER | wxMAXIMIZE_BOX)
+  # 
+  # See also the Window Styles.
+  # 
+  # === Extra Styles
+  # 
+  # This class supports the following extra styles:
+  #  
+  # - {Wx::FRAME_EX_CONTEXTHELP}: Under Windows, puts a query button on the caption. When pressed, Windows will go into a context-sensitive help mode and wxWidgets will send a {Wx::EVT_HELP} event if the user clicked on an application window. Note that this is an extended style and must be set by calling SetExtraStyle before Create is called (two-step construction). You cannot use this style together with {Wx::MAXIMIZE_BOX} or {Wx::MINIMIZE_BOX}, so you should use {Wx::DEFAULT_FRAME_STYLE} ~ ({Wx::MINIMIZE_BOX} | {Wx::MAXIMIZE_BOX}) for the frames having this style (the dialogs don't have a minimize or a maximize box by default) 
+  # - {Wx::FRAME_EX_METAL}: On macOS, frames with this style will be shown with a metallic look. This is an extra style. 
+  # 
+  # === Events emitted by this class
+  # 
+  # Event handler methods for events emitted by this class:
+  #  
+  # - {Wx::EvtHandler#evt_close}(meth = nil, &block): Process a {Wx::EVT_CLOSE_WINDOW} event when the frame is being closed by the user or programmatically (see {Wx::Window#close}). The user may generate this event clicking the close button (typically the 'X' on the top-right of the title bar) if it's present (see the {Wx::CLOSE_BOX} style). See {Wx::CloseEvent}. 
+  # - {Wx::EvtHandler#evt_iconize}(meth = nil, &block): Process a {Wx::EVT_ICONIZE} event. See {Wx::IconizeEvent}. 
+  # - {Wx::EvtHandler#evt_menu_open}(meth = nil, &block): A menu is about to be opened. See {Wx::MenuEvent}. 
+  # - {Wx::EvtHandler#evt_menu_close}(meth = nil, &block): A menu has been just closed. See {Wx::MenuEvent}. 
+  # - {Wx::EvtHandler#evt_menu_highlight}(id, meth = nil, &block): The menu item with the specified id has been highlighted: used to show help prompts in the status bar by {Wx::Frame}. See {Wx::MenuEvent}. 
+  # - {Wx::EvtHandler#evt_menu_highlight_all}(meth = nil, &block): A menu item has been highlighted, i.e. the currently selected menu item has changed. See {Wx::MenuEvent}. 
+  # 
+  # === 
+  # 
+  # Category:  Managed Windows
+  # @see Wx::MDIParentFrame
+  # @see  Wx::MDIChildFrame
+  # @see  Wx::MiniFrame
+  # @see  Wx::Dialog 
+  # 
+  # 
+  class Frame < TopLevelWindow
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Frame]
+    # @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 window.
+    #   For Motif, MWM (the Motif Window Manager) should be running for any window styles to work (otherwise all styles take effect).
+    #   @see Wx::Frame#create 
+    #   @param parent [Wx::Window]  The window parent. This may be, and often is, NULL. If it is non-NULL, the frame will be minimized when its parent is minimized and restored when it is restored (although it will still be possible to minimize and restore just this frame itself).
+    #   @param id [Integer]  The window identifier. It may take a value of -1 to indicate a default value.
+    #   @param title [String]  The caption to be displayed on the frame's title bar.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  The window position. The value {Wx::DEFAULT_POSITION} indicates a default position, chosen by either the windowing system or wxWidgets, depending on platform.
+    #   @param size [Array(Integer, Integer), Wx::Size]  The window size. The value {Wx::DEFAULT_SIZE} indicates a default size, chosen by either the windowing system or wxWidgets, depending on platform.
+    #   @param style [Integer]  The window style. See {Wx::Frame} class description.
+    #   @param name [String]  The name of the window. This parameter is used to associate a name with the item, allowing the application user to set Motif resource values for individual windows.
+    #   @return [Frame]
+    def initialize(*args) end
+    
+    # Centres the frame on the display.
+    # @param direction [Integer]  The parameter may be {Wx::Orientation::HORIZONTAL}, {Wx::Orientation::VERTICAL} or {Wx::Orientation::BOTH}.
+    # @return [void]
+    def centre(direction=Wx::BOTH) end
+    
+    # Used in two-step frame construction.
+    # See {Wx::Frame#frame} for further details.
+    # @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 [true,false]
+    def create(parent, id, title, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::DEFAULT_FRAME_STYLE, name=Wx::FRAME_NAME_STR) end
+    
+    # Creates a status bar at the bottom of the frame.
+    # A pointer to the status bar if it was created successfully, NULL otherwise.
+    # 
+    # The width of the status bar is the whole width of the frame (adjusted automatically when resizing), and the height and text size are chosen by the host windowing system.
+    # @see Wx::Frame#set_status_text
+    # @see  Wx::Frame#on_create_status_bar
+    # @see  Wx::Frame#get_status_bar 
+    # @param number [Integer]  The number of fields to create. Specify a value greater than 1 to create a multi-field status bar.
+    # @param style [Integer]  The status bar style. See {Wx::StatusBar} for a list of valid styles.
+    # @param id [Integer]  The status bar window identifier. If -1, an identifier will be chosen by wxWidgets.
+    # @param name [String]  The status bar window name.
+    # @return [Wx::StatusBar]
+    def create_status_bar(number=1, style=Wx::STB_DEFAULT_STYLE, id=0, name=Wx::STATUS_BAR_NAME_STR) end
+    
+    # Creates a toolbar at the top or left of the frame.
+    # A pointer to the toolbar if it was created successfully, NULL otherwise.
+    # 
+    # By default, the toolbar is an instance of {Wx::ToolBar}. To use a different class, override {Wx::Frame#on_create_tool_bar}. When a toolbar has been created with this function, or made known to the frame with {Wx::Frame#set_tool_bar}, the frame will manage the toolbar position and adjust the return value from {Wx::Window#get_client_size} to reflect the available space for application windows. Under Pocket PC, you should always use this function for creating the toolbar to be managed by the frame, so that wxWidgets can use a combined menubar and toolbar. Where you manage your own toolbars, create a {Wx::ToolBar} as usual.
+    # @see Wx::Frame#create_status_bar
+    # @see  Wx::Frame#on_create_tool_bar
+    # @see  Wx::Frame#set_tool_bar
+    # @see  Wx::Frame#get_tool_bar 
+    # @param style [Integer]  The toolbar style. See {Wx::ToolBar} for a list of valid styles.
+    # @param id [Integer]  The toolbar window identifier. If -1, an identifier will be chosen by wxWidgets.
+    # @param name [String]  The toolbar window name.
+    # @return [Wx::ToolBar]
+    def create_tool_bar(style=Wx::TB_DEFAULT_STYLE, id=Wx::ID_ANY, name=Wx::TOOL_BAR_NAME_STR) end
+    
+    # Method used to show help string of the selected menu toolbar item.
+    # This method is called by the default {Wx::EVT_MENU_HIGHLIGHT} event handler and also by {Wx::ToolBar} to show the optional help string associated with the selected menu or toolbar item. It can be overridden if the default behaviour of showing this string in the frame status bar is not appropriate.
+    # @see Wx::Frame#set_status_bar_pane 
+    # @param text [String]  The help string to show, may be empty. The default implementation simply shows this string in the frame status bar (after remembering its previous text to restore it later).
+    # @param show [true,false]  Whether the help should be shown or hidden. The default implementation restores the previously saved status bar text when it is false.
+    # @return [void]
+    def do_give_help(text, show) end
+    
+    # Returns the origin of the frame client area (in client coordinates).
+    # It may be different from (0, 0) if the frame has a toolbar.
+    # @return [Wx::Point]
+    def get_client_area_origin; end
+    alias_method :client_area_origin, :get_client_area_origin
+    
+    # Returns a pointer to the menubar currently associated with the frame (if any).
+    # 
+    # @see Wx::Frame#set_menu_bar
+    # @see  Wx::MenuBar
+    # @see  Wx::Menu 
+    # @return [Wx::MenuBar]
+    def get_menu_bar; end
+    alias_method :menu_bar, :get_menu_bar
+    
+    # Returns a pointer to the status bar currently associated with the frame (if any).
+    # 
+    # @see Wx::Frame#create_status_bar
+    # @see  Wx::StatusBar 
+    # @return [Wx::StatusBar]
+    def get_status_bar; end
+    alias_method :status_bar, :get_status_bar
+    
+    # Returns the status bar pane used to display menu and toolbar help.
+    # 
+    # @see Wx::Frame#set_status_bar_pane 
+    # @return [Integer]
+    def get_status_bar_pane; end
+    alias_method :status_bar_pane, :get_status_bar_pane
+    
+    # Returns a pointer to the toolbar currently associated with the frame (if any).
+    # 
+    # @see Wx::Frame#create_tool_bar
+    # @see  Wx::ToolBar
+    # @see  Wx::Frame#set_tool_bar 
+    # @return [Wx::ToolBar]
+    def get_tool_bar; end
+    alias_method :tool_bar, :get_tool_bar
+    
+    # Simulate a menu command.
+    # @param id [Integer]  The identifier for a menu item.
+    # @return [true,false]
+    def process_command(id) end
+    
+    # Tells the frame to show the given menu bar.
+    # If the frame is destroyed, the menu bar and its menus will be destroyed also, so do not delete the menu bar explicitly (except by resetting the frame's menu bar to another frame or NULL). Under Windows, a size event is generated, so be sure to initialize data members properly before calling {Wx::Frame#set_menu_bar}. Note that on some platforms, it is not possible to call this function twice for the same frame object.
+    # @see Wx::Frame#get_menu_bar
+    # @see  Wx::MenuBar
+    # @see  Wx::Menu. 
+    # @param menuBar [Wx::MenuBar]  The menu bar to associate with the frame.
+    # @return [void]
+    def set_menu_bar(menuBar) end
+    alias_method :menu_bar=, :set_menu_bar
+    
+    # Associates a status bar with the frame.
+    # If statusBar is NULL, then the status bar, if present, is detached from the frame, but not deleted.
+    # @see Wx::Frame#create_status_bar
+    # @see  Wx::StatusBar
+    # @see  Wx::Frame#get_status_bar 
+    # @param statusBar [Wx::StatusBar] 
+    # @return [void]
+    def set_status_bar(statusBar) end
+    alias_method :status_bar=, :set_status_bar
+    
+    # Set the status bar pane used to display menu and toolbar help.
+    # Using -1 disables help display.
+    # @param n [Integer] 
+    # @return [void]
+    def set_status_bar_pane(n) end
+    alias_method :status_bar_pane=, :set_status_bar_pane
+    
+    # Sets the status bar text and updates the status bar display.
+    # This is a simple wrapper for {Wx::StatusBar#set_status_text} which doesn't do anything if the frame has no status bar, i.e. {Wx::Frame#get_status_bar} returns NULL.
+    # 
+    # Use an empty string to clear the status bar.
+    # @see Wx::Frame#create_status_bar
+    # @see  Wx::StatusBar 
+    # @param text [String]  The text for the status field.
+    # @param number [Integer]  The status field (starting from zero).
+    # @return [void]
+    def set_status_text(text, number=0) end
+    alias_method :status_text=, :set_status_text
+    
+    # Sets the widths of the fields in the status bar.
+    # The widths of the variable fields are calculated from the total width of all fields, minus the sum of widths of the non-variable fields, divided by the number of variable fields.
+    # 
+    # <b>{Wx::Perl} Note:</b> In {Wx::Perl} this method takes the field widths as parameters.
+    # @param n [Integer]  The number of fields in the status bar. It must be the same used in CreateStatusBar.
+    # @param widths_field [int]  Must contain an array of n integers, each of which is a status field width in pixels. A value of -1 indicates that the field is variable width; at least one field must be -1. You should delete this array after calling {Wx::Frame#set_status_widths}.
+    # @return [void]
+    def set_status_widths(n, widths_field) end
+    
+    # Associates a toolbar with the frame.
+    # @param toolBar [Wx::ToolBar] 
+    # @return [void]
+    def set_tool_bar(toolBar) end
+    alias_method :tool_bar=, :set_tool_bar
+    
+    # MSW-specific function for accessing the taskbar button under Windows 7 or later.
+    # Returns a {Wx::TaskBarButton} pointer representing the taskbar button of the window under Windows 7 or later. The returned {Wx::TaskBarButton} may be used, if non-NULL, to access the functionality including thumbnail representations, thumbnail toolbars, notification and status overlays, and progress indicators.
+    # The returned pointer must not be deleted, it is owned by the frame and will be only deleted when the frame 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 
+    # 
+    #   #ifdef __WXMSW__ 
+    #  preprocessor guards.
+    # @return [Wx::TaskBarButton]
+    def msw_get_task_bar_button; end
+    
+    # @param text [String] 
+    # @param number [Integer] 
+    # @return [void]
+    def push_status_text(text, number=0) end
+    
+    # @param number [Integer] 
+    # @return [void]
+    def pop_status_text(number=0) end
+    
+  end # Frame
+  
+
+end