wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,85 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # The basic idea behind a box sizer is that windows will most often be laid out in rather simple basic geometry, typically in a row or a column or several hierarchies of either.
+  # 
+  # For more information, please see {Wx::BoxSizer}.
+  # 
+  # Category:  Window Layout
+  # @see Wx::Sizer
+  # @see  Sizers Overview 
+  # 
+  # 
+  class BoxSizer < Sizer
+  
+    # @overload initialize(orient)
+    #   Constructor for a {Wx::BoxSizer}.
+    #   
+    #   orient may be either of {Wx::Orientation::VERTICAL} or {Wx::Orientation::HORIZONTAL} for creating either a column sizer or a row sizer.
+    #   @param orient [Integer] 
+    #   @return [Wx::BoxSizer]
+    # @overload initialize(orient, &block)
+    #   Constructor for a {Wx::BoxSizer}.
+    #   
+    #   orient may be either of {Wx::Orientation::VERTICAL} or {Wx::Orientation::HORIZONTAL} for creating either a column sizer or a row sizer.
+    #   @param orient [Integer] 
+    #   @yieldparam [Wx::BoxSizer] sizer new Sizer instance
+    #   @return [Wx::BoxSizer]
+    def initialize(*args) end
+    
+    # Adds non-stretchable space to the main orientation of the sizer only.
+    # 
+    # More readable way of calling: 
+    # ```ruby
+    #   if box_sizer.vertical?
+    #     box_sizer.add(0, size, 0)
+    #   else
+    #     box_size.add(size, 0, 0)
+    #   end
+    # ```
+    # @param size [Integer] 
+    # @return [Wx::SizerItem]
+    def add_spacer(size) end
+    
+    # Implements the calculation of a box sizer's minimal.
+    # 
+    # It is used internally only and must not be called by the user. Documented for information.
+    # @return [Wx::Size]
+    def calc_min; end
+    
+    # Returns the orientation of the box sizer, either {Wx::Orientation::VERTICAL} or {Wx::Orientation::HORIZONTAL}.
+    # @return [Integer]
+    def get_orientation; end
+    alias_method :orientation, :get_orientation
+    
+    # Sets the orientation of the box sizer, either {Wx::Orientation::VERTICAL} or {Wx::Orientation::HORIZONTAL}.
+    # @param orient [Integer] 
+    # @return [void]
+    def set_orientation(orient) end
+    alias_method :orientation=, :set_orientation
+    
+    # Method which must be overridden in the derived sizer classes.
+    # 
+    # The implementation should reposition the children using the current total size available to the sizer (m_size) and the size computed by the last call to {Wx::BoxSizer#calc_min}.
+    # @param minSize [Array(Integer, Integer), Wx::Size] 
+    # @return [void]
+    def reposition_children(minSize) end
+    
+    # Inform sizer about the first direction that has been decided (by parent item).
+    # 
+    # Returns true if it made use of the information (and recalculated min size).
+    # @param direction [Integer] 
+    # @param size [Integer] 
+    # @param availableOtherDir [Integer] 
+    # @return [Boolean]
+    def inform_first_direction(direction, size, availableOtherDir) end
+    
+  end # BoxSizer
+  
+
+end

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

@@ -0,0 +1,251 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # The possible brush styles.
+  # 
+  # 
+  # 
+  class BrushStyle < Wx::Enum
+  
+    # 
+    # 
+    BRUSHSTYLE_INVALID = Wx::BrushStyle.new(-1)
+    
+    # Solid.
+    # 
+    BRUSHSTYLE_SOLID = Wx::BrushStyle.new(100)
+    
+    # Transparent (no fill).
+    # 
+    BRUSHSTYLE_TRANSPARENT = Wx::BrushStyle.new(106)
+    
+    # Uses a bitmap as a stipple; the mask is used for blitting monochrome using text foreground and background colors.
+    # 
+    BRUSHSTYLE_STIPPLE_MASK_OPAQUE = Wx::BrushStyle.new(107)
+    
+    # Uses a bitmap as a stipple; mask is used for masking areas in the stipple bitmap.
+    # 
+    BRUSHSTYLE_STIPPLE_MASK = Wx::BrushStyle.new(108)
+    
+    # Uses a bitmap as a stipple.
+    # 
+    BRUSHSTYLE_STIPPLE = Wx::BrushStyle.new(110)
+    
+    # Backward diagonal hatch.
+    # 
+    BRUSHSTYLE_BDIAGONAL_HATCH = Wx::BrushStyle.new(111)
+    
+    # Cross-diagonal hatch.
+    # 
+    BRUSHSTYLE_CROSSDIAG_HATCH = Wx::BrushStyle.new(112)
+    
+    # Forward diagonal hatch.
+    # 
+    BRUSHSTYLE_FDIAGONAL_HATCH = Wx::BrushStyle.new(113)
+    
+    # Cross hatch.
+    # 
+    BRUSHSTYLE_CROSS_HATCH = Wx::BrushStyle.new(114)
+    
+    # Horizontal hatch.
+    # 
+    BRUSHSTYLE_HORIZONTAL_HATCH = Wx::BrushStyle.new(115)
+    
+    # Vertical hatch.
+    # 
+    BRUSHSTYLE_VERTICAL_HATCH = Wx::BrushStyle.new(116)
+    
+    # First of the hatch styles (inclusive).
+    # 
+    BRUSHSTYLE_FIRST_HATCH = Wx::BrushStyle.new(111)
+    
+    # Last of the hatch styles (inclusive).
+    # 
+    BRUSHSTYLE_LAST_HATCH = Wx::BrushStyle.new(116)
+    
+  end # BrushStyle
+  
+  # An empty brush.
+  # 
+  NULL_BRUSH = nil
+  
+  # A brush is a drawing tool for filling in areas.
+  # 
+  # It is used for painting the background of rectangles, ellipses, etc. It has a colour and a style.
+  # On a monochrome display, wxWidgets shows all brushes as white unless the colour is really black.
+  # Do not initialize objects on the stack before the program commences, since other required structures may not have been set up yet. Instead, define global pointers to objects and create them in {Wx::App::OnInit} or when required.
+  # An application may wish to create brushes with different characteristics dynamically, and there is the consequent danger that a large number of duplicate brushes will be created. Therefore an application may wish to get a pointer to a brush by using the global list of brushes {Wx::TheBrushList}, and calling the member function Wx::BrushList#find_or_create_brush.
+  # This class uses reference counting and copy-on-write internally so that assignments between two instances of this class are very cheap. You can therefore use actual objects instead of pointers without efficiency problems. If an instance of this class is changed it will create its own data internally so that other instances, which previously shared the data using the reference counting, are not affected.
+  # 
+  # Category:  Graphics Device Interface (GDI)
+  # Predefined objects/pointers: 
+  # 
+  # - {Wx::NULL_BRUSH} 
+  # 
+  # - {Wx::BLACK_BRUSH} 
+  # 
+  # - {Wx::BLUE_BRUSH} 
+  # 
+  # - {Wx::CYAN_BRUSH} 
+  # 
+  # - {Wx::GREEN_BRUSH} 
+  # 
+  # - {Wx::YELLOW_BRUSH} 
+  # 
+  # - {Wx::GREY_BRUSH} 
+  # 
+  # - {Wx::LIGHT_GREY_BRUSH} 
+  # 
+  # - {Wx::MEDIUM_GREY_BRUSH} 
+  # 
+  # - {Wx::RED_BRUSH} 
+  # 
+  # - {Wx::TRANSPARENT_BRUSH} 
+  # 
+  # - {Wx::WHITE_BRUSH}
+  # @see Wx::BrushList
+  # @see  Wx::DC
+  # @see  Wx::DC#set_brush 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class Brush < GDIObject
+  
+    # @overload set_colour(colour)
+    #   Sets the brush colour using red, green and blue values.
+    #   
+    #   
+    #   @see Wx::Brush#get_colour 
+    #   @param colour [Wx::Colour,String,Symbol] 
+    #   @return [void]
+    # @overload set_colour(red, green, blue)
+    #   Sets the brush colour using red, green and blue values.
+    #   
+    #   
+    #   @see Wx::Brush#get_colour 
+    #   @param red [Integer] 
+    #   @param green [Integer] 
+    #   @param blue [Integer] 
+    #   @return [void]
+    def set_colour(*args) end
+    alias_method :colour=, :set_colour
+    
+    # @overload initialize()
+    #   Default constructor.
+    #   
+    #   The brush will be uninitialised, and {Wx::Brush}:{Wx::Brush#is_ok} will return false.
+    #   @return [Wx::Brush]
+    # @overload initialize(colour, style=Wx::BrushStyle::BRUSHSTYLE_SOLID)
+    #   Constructs a brush from a colour object and style.
+    #   @param colour [Wx::Colour,String,Symbol]  Colour object.
+    #   @param style [Wx::BrushStyle]  One of the {Wx::BrushStyle} enumeration values.
+    #   @return [Wx::Brush]
+    # @overload initialize(stippleBitmap)
+    #   Constructs a stippled brush using a bitmap.
+    #   
+    #   The brush style will be set to {Wx::BrushStyle::BRUSHSTYLE_STIPPLE}.
+    #   @param stippleBitmap [Wx::Bitmap] 
+    #   @return [Wx::Brush]
+    # @overload initialize(brush)
+    #   Copy constructor, uses reference counting.
+    #   @param brush [Wx::Brush] 
+    #   @return [Wx::Brush]
+    def initialize(*args) end
+    
+    # Returns a reference to the brush colour.
+    # 
+    # 
+    # @see Wx::Brush#set_colour 
+    # @return [Wx::Colour]
+    def get_colour; end
+    alias_method :colour, :get_colour
+    
+    # Gets a pointer to the stipple bitmap.
+    # 
+    # If the brush does not have a {Wx::BrushStyle::BRUSHSTYLE_STIPPLE} style, this bitmap may be non-null but uninitialised (i.e. {Wx::Bitmap}:{Wx::Brush#is_ok} returns false).
+    # @see Wx::Brush#set_stipple 
+    # @return [Wx::Bitmap]
+    def get_stipple; end
+    alias_method :stipple, :get_stipple
+    
+    # Returns the brush style, one of the {Wx::BrushStyle} values.
+    # 
+    # 
+    # @see Wx::Brush#set_style
+    # @see  Wx::Brush#set_colour
+    # @see  Wx::Brush#set_stipple 
+    # @return [Wx::BrushStyle]
+    def get_style; end
+    alias_method :style, :get_style
+    
+    # Returns true if the style of the brush is any of hatched fills.
+    # 
+    # 
+    # @see Wx::Brush#get_style 
+    # @return [Boolean]
+    def is_hatch; end
+    alias_method :hatch?, :is_hatch
+    
+    # Returns true if the brush is initialised.
+    # 
+    # Notice that an uninitialized brush object can't be queried for any brush properties and all calls to the accessor methods on it will result in an assert failure.
+    # @return [Boolean]
+    def is_ok; end
+    alias_method :ok?, :is_ok
+    
+    # Returns true if the brush is a valid non-transparent brush.
+    # 
+    # This method returns true if the brush object is initialized and has a non-transparent style. Notice that this should be used instead of simply testing whether {Wx::Brush#get_style} returns a style different from {Wx::BrushStyle::BRUSHSTYLE_TRANSPARENT} if the brush may be invalid as {Wx::Brush#get_style} would assert in this case.
+    # @see Wx::Brush#is_transparent
+    # @return [Boolean]
+    def is_non_transparent; end
+    alias_method :non_transparent?, :is_non_transparent
+    
+    # Returns true if the brush is transparent.
+    # 
+    # A transparent brush is simply a brush with {Wx::BrushStyle::BRUSHSTYLE_TRANSPARENT} style.
+    # Notice that this function works even for non-initialized brushes (for which it returns false) unlike tests of the form <code>Wx::Brush#get_style == wxBRUSHSTYLE_TRANSPARENT</code> which would assert if the brush is invalid.
+    # @see Wx::Brush#is_non_transparent
+    # @return [Boolean]
+    def is_transparent; end
+    alias_method :transparent?, :is_transparent
+    
+    # Sets the stipple bitmap.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>The style will be set to {Wx::BrushStyle::BRUSHSTYLE_STIPPLE}, unless the bitmap has a mask associated to it, in which case the style will be set to {Wx::BrushStyle::BRUSHSTYLE_STIPPLE_MASK_OPAQUE}.
+    # </p>
+    # </div>
+    # @see Wx::Bitmap 
+    # @param bitmap [Wx::Bitmap]  The bitmap to use for stippling.
+    # @return [void]
+    def set_stipple(bitmap) end
+    alias_method :stipple=, :set_stipple
+    
+    # Sets the brush style.
+    # 
+    # 
+    # @see Wx::Brush#get_style 
+    # @param style [Wx::BrushStyle]  One of the {Wx::BrushStyle} values.
+    # @return [void]
+    def set_style(style) end
+    alias_method :style=, :set_style
+    
+    # Equality operator.
+    # 
+    # See Object Comparison for more info.
+    # @param brush [Wx::Brush] 
+    # @return [Boolean]
+    def ==(brush) end
+    
+  end # Brush
+  
+
+end

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

@@ -0,0 +1,157 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This class makes it easy to tell your user that the program is temporarily busy.
+  # 
+  # Normally the main thread should always return to the main loop to continue dispatching events as quickly as possible,
+  # hence this class shouldn't be needed. However if the main thread does need to block, this class provides a simple
+  # way to at least show this to the user: just call {Wx::BusyInfo.busy} with a block and for the duration of the
+  # execution of the block a message window will be shown.
+  # For example:
+  # ```ruby
+  #   BusyInfo.busy('Working, please wait...') do
+  #     100000.times { do_a_calculation }
+  #   end
+  # ```
+  # 
+  # The displayed window is rather plain by default but can be customized by passing {Wx::BusyInfo.busy} an object of
+  # {Wx::BusyInfoFlags} class instead of a simple message. Here is an example:
+  # 
+  # ```ruby
+  #   Wx::BusyInfo.busy(
+  #     Wx::BusyInfoFlags.new
+  #       .parent(self)
+  #       .icon(Wx::ArtProvider.get_icon(Wx::ART_PRINT,Wx::ART_OTHER, [128, 128]))
+  #       .title("<b>Printing your document</b>")
+  #       .text("Please wait...")
+  #       .foreground(Wx::WHITE)
+  #       .background(Wx::BLACK)
+  #       .transparency(4*Wx::ALPHA_OPAQUE/5)) do |bi|
+  #   end
+  # ```
+  # 
+  # This shows that separate title and text can be set, and that simple markup ({Wx::Control#set_label_markup}) can be used in them, and that it's also possible to add an icon and customize the colours and transparency of the window.
+  # You may also want to call `Wx.get_app.yield` to refresh the window periodically (in case it had been obscured by other windows, for example) like this:
+  # ```ruby
+  #   Wx::WindowDisabler.disable do
+  #     BusyInfo.busy('Working, please wait...') do
+  #       100000.times do |i| 
+  #         do_a_calculation }
+  #         Wx.get_app.yield if (i % 1000) == 0
+  #       end
+  #     end
+  #   end
+  # ```
+  # 
+  # but take care to not cause undesirable re-entrance when doing it (see {Wx::App#yield} for more details). The simplest way to do it is to use {Wx::WindowDisabler} class as illustrated in the above example.
+  # Note that a {Wx::BusyInfo} is always built with the {Wx::STAY_ON_TOP} window style (see {Wx::Frame} window styles for more info).
+  # 
+  # Category:  Common Dialogs
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_BUSYINFO
+  class BusyInfo < ::Object
+  
+    # Update the information text.
+    # 
+    # The text string may contain markup as described in {Wx::Control#set_label_markup}.
+    # @param str [String] 
+    # @return [void]
+    def update_text(str) end
+    
+    # Same as {Wx::BusyInfo#update_text} but doesn't interpret the string as containing markup.
+    # @param str [String] 
+    # @return [void]
+    def update_label(str) end
+    
+  end # BusyInfo
+  
+  # Parameters for {Wx::BusyInfo}.
+  # 
+  # This class exists only in order to make passing attributes to {Wx::BusyInfo} constructor easier and the code doing it more readable.
+  # All methods of this class return the reference to the object on which they are called, making it possible to chain them together, e.g. typically you would just create a temporary {Wx::BusyInfoFlags} object and then call the methods corresponding to the attributes you want to set, before finally passing the result to {Wx::BusyInfo} constructor, e.g.: 
+  # ```ruby
+  #   Wx::BusyInfo.busy(
+  #     Wx::BusyInfoFlags.new
+  #       .parent(self)
+  #       .icon(Wx::ArtProvider.get_icon(Wx::ART_PRINT,Wx::ART_OTHER, [128, 128]))
+  #       .title("<b>Printing your document</b>")
+  #       .text("Please wait...")
+  #       .foreground(Wx::WHITE)
+  #       .background(Wx::BLACK)
+  #       .transparency(4*Wx::ALPHA_OPAQUE/5)) do |bi|
+  #   end
+  # ```
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_BUSYINFO
+  class BusyInfoFlags < ::Object
+  
+    # Default constructor initializes all attributes to default values.
+    # 
+    # Call the other methods to really fill in the object.
+    # @return [Wx::BusyInfoFlags]
+    def initialize; end
+    
+    # Sets the parent for {Wx::BusyInfo}.
+    # @param parent [Wx::Window] 
+    # @return [Wx::BusyInfoFlags]
+    def parent(parent) end
+    
+    # Sets the icon to show in {Wx::BusyInfo}.
+    # 
+    # icon can contain multiple versions of the bitmap in different resolutions since wxWidgets 3.3.0, in the earlier versions this parameter was just a single {Wx::Icon}.
+    # @param icon [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    # @return [Wx::BusyInfoFlags]
+    def icon(icon) end
+    
+    # Sets the title, shown prominently in {Wx::BusyInfo} window.
+    # 
+    # The title string may contain markup as described in {Wx::Control#set_label_markup}.
+    # @param title [String] 
+    # @return [Wx::BusyInfoFlags]
+    def title(title) end
+    
+    # Sets the more detailed text, shown under the title, if any.
+    # 
+    # The text string may contain markup as described in {Wx::Control#set_label_markup}.
+    # @param text [String] 
+    # @return [Wx::BusyInfoFlags]
+    def text(text) end
+    
+    # Same as {Wx::BusyInfoFlags#text} but doesn't interpret the string as containing markup.
+    # 
+    # This method should be used if the text shown in {Wx::BusyInfo} comes from external source and so may contain characters having special meaning in simple markup, e.g. '<'.
+    # @param label [String] 
+    # @return [Wx::BusyInfoFlags]
+    def label(label) end
+    
+    # Sets the foreground colour of the title and text strings.
+    # @param foreground [Wx::Colour,String,Symbol] 
+    # @return [Wx::BusyInfoFlags]
+    def foreground(foreground) end
+    
+    # Sets the background colour of {Wx::BusyInfo} window.
+    # @param background [Wx::Colour,String,Symbol] 
+    # @return [Wx::BusyInfoFlags]
+    def background(background) end
+    
+    # Sets the transparency of {Wx::BusyInfo} window.
+    # 
+    # 
+    # @see Wx::TopLevelWindow#set_transparent 
+    # @param alpha [Integer]  Value in {Wx::ALPHA_TRANSPARENT} (0) to {Wx::ALPHA_OPAQUE} (255) range.
+    # @return [Wx::BusyInfoFlags]
+    def transparency(alpha) end
+    
+  end # BusyInfoFlags
+  
+
+end

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

@@ -0,0 +1,182 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A button is a control that contains a text string, and is one of the most common elements of a GUI.
+  # 
+  # It may be placed on a dialog box or on a {Wx::Panel} panel, or indeed on almost any other window.
+  # By default, i.e. if none of the alignment styles are specified, the label is centered both horizontally and vertically. If the button has both a label and a bitmap, the alignment styles above specify the location of the rectangle combining both the label and the bitmap and the bitmap position set with {Wx::Button#set_bitmap_position} defines the relative position of the bitmap with respect to the label (however currently non-default alignment combinations are not implemented on all platforms).
+  # Since version 2.9.1 {Wx::Button} supports showing both text and an image (currently only when using WXMSW, WXGTK or WXOSX/Cocoa ports), see {Wx::Button#set_bitmap} and {Wx::Button#set_bitmap_label}, {Wx::Button#set_bitmap_disabled} &c methods. In the previous wxWidgets versions this functionality was only available in (the now trivial) {Wx::BitmapButton} class which was only capable of showing an image without text.
+  # A button may have either a single image for all states or different images for the following states (different images are not currently supported under macOS where the normal image is used for all states): 
+  # 
+  # - <b>normal:</b> the default state 
+  # 
+  # - <b>disabled:</b> bitmap shown when the button is disabled. 
+  # 
+  # - <b>pressed:</b> bitmap shown when the button is pushed (e.g. while the user keeps the mouse button pressed on it) 
+  # 
+  # - <b>focus:</b> bitmap shown when the button has keyboard focus (but is not pressed as in this case the button is in the pressed state) 
+  # 
+  # - <b>current:</b> bitmap shown when the mouse is over the button (but it is not pressed although it may have focus). Notice that if current bitmap is not specified but the current platform UI uses hover images for the buttons (such as Windows or GTK+), then the focus bitmap is used for hover state as well. This makes it possible to set focus bitmap only to get reasonably good behaviour on all platforms.
+  # 
+  # All of the bitmaps must be of the same size and the normal bitmap must be set first (to a valid bitmap), before setting any other ones. Also, if the size of the bitmaps is changed later, you need to change the size of the normal bitmap before setting any other bitmaps with the new size (and you do need to reset all of them as their original values can be lost when the normal bitmap size changes).
+  # The position of the image inside the button be configured using {Wx::Button#set_bitmap_position}. By default the image is on the left of the text.
+  # Please also notice that GTK+ uses a global setting called <code>gtk-button-images</code> to determine if the images should be shown in the buttons at all. If it is off (which is the case in e.g. Gnome 2.28 by default), no images will be shown, consistently with the native behaviour.
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::BU_LEFT}: Left-justifies the label. Windows and GTK+ only. 
+  # 
+  # - {Wx::BU_TOP}: Aligns the label to the top of the button. Windows and GTK+ only. 
+  # 
+  # - {Wx::BU_RIGHT}: Right-justifies the bitmap label. Windows and GTK+ only. 
+  # 
+  # - {Wx::BU_BOTTOM}: Aligns the label to the bottom of the button. Windows and GTK+ only. 
+  # 
+  # - {Wx::BU_EXACTFIT}: By default, all buttons are made of at least the standard button size, even if their contents is small enough to fit into a smaller size. This is done for consistency as most platforms use buttons of the same size in the native dialogs, but can be overridden by specifying this flag. If it is given, the button will be made just big enough for its contents. Notice that under MSW the button will still have at least the standard height, even with this style, if it has a non-empty label. 
+  # 
+  # - {Wx::BU_NOTEXT}: Disables the display of the text label in the button even if it has one or its id is one of the standard stock ids with an associated label: without using this style a button which is only supposed to show a bitmap but uses a standard id would display a label too. 
+  # 
+  # - {Wx::Border::BORDER_NONE}: Creates a button without border. This is currently implemented in MSW, GTK2 and OSX/Cocoa. 
+  # 
+  # ### Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CommandEvent} events.
+  # Event handler methods for events emitted by this class:
+  # 
+  # - {Wx::EvtHandler#evt_button}(id, meth = nil, &block): Process a {Wx::EVT_BUTTON} event, when the button is clicked. 
+  # 
+  # Category:  {Wx::Controls}  <div class='appearance'><span class='appearance'>Appearance:</span><table><tr><td> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
+  #   </td></tr></table></div>
+  # @see Wx::BitmapButton 
+  # 
+  # 
+  # @wxrb_require USE_BUTTON
+  class Button < AnyButton
+  
+    # @overload initialize()
+    #   Default ctor.
+    #   @return [Wx::Button]
+    # @overload initialize(parent, id, label=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BUTTON_NAME_STR)
+    #   Constructor, creating and showing a button.
+    #   
+    #   The preferred way to create standard buttons is to use default value of label. If no label is supplied and id is one of standard IDs from this list, a standard label will be used. In other words, if you use a predefined {Wx::ID_XXX} constant, just omit the label completely rather than specifying it. In particular, help buttons (the ones with id of {Wx::StandardID::ID_HELP}) under macOS can't display any label at all and while {Wx::Button} will detect if the standard "Help" label is used and ignore it, using any other label will prevent the button from correctly appearing as a help button and so should be avoided.
+    #   In addition to that, the button will be decorated with stock icons under GTK+ 2.
+    #   @see Wx::Button#create
+    #   @see  Wx::Validator 
+    #   @param parent [Wx::Window]  Parent window. Must not be nil.
+    #   @param id [Integer]  Button identifier. A value of {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param label [String]  Text to be displayed on the button.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Button position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Button size. If the default size is specified then the button is sized appropriately for the text.
+    #   @param style [Integer]  Window style. See {Wx::Button} class description.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @return [Wx::Button]
+    # @overload initialize(parent, id, label=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BUTTON_NAME_STR, &block)
+    #   Constructor, creating and showing a button.
+    #   
+    #   The preferred way to create standard buttons is to use default value of label. If no label is supplied and id is one of standard IDs from this list, a standard label will be used. In other words, if you use a predefined {Wx::ID_XXX} constant, just omit the label completely rather than specifying it. In particular, help buttons (the ones with id of {Wx::StandardID::ID_HELP}) under macOS can't display any label at all and while {Wx::Button} will detect if the standard "Help" label is used and ignore it, using any other label will prevent the button from correctly appearing as a help button and so should be avoided.
+    #   In addition to that, the button will be decorated with stock icons under GTK+ 2.
+    #   @see Wx::Button#create
+    #   @see  Wx::Validator 
+    #   @param parent [Wx::Window]  Parent window. Must not be nil.
+    #   @param id [Integer]  Button identifier. A value of {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param label [String]  Text to be displayed on the button.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Button position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Button size. If the default size is specified then the button is sized appropriately for the text.
+    #   @param style [Integer]  Window style. See {Wx::Button} class description.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @yieldparam [Wx::Button] win new instance
+    #   @return [Wx::Button]
+    def initialize(*args) end
+    
+    # Button creation function for two-step creation.
+    # 
+    # For more details, see {Wx::Button#initialize}.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param label [String] 
+    # @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 [Boolean]
+    def create(parent, id, label=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BUTTON_NAME_STR) end
+    
+    # Returns true if an authentication needed symbol is displayed on the button.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This method always returns false on non-Windows platforms.
+    # </p>
+    # </div>
+    # @see Wx::Button#set_auth_needed
+    # @return [Boolean]
+    def get_auth_needed; end
+    alias_method :auth_needed, :get_auth_needed
+    
+    # Returns the string label for the button.
+    # 
+    # 
+    # @see Wx::Button#set_label 
+    # @return [String]
+    def get_label; end
+    alias_method :label, :get_label
+    
+    # Sets whether an authentication needed symbol should be displayed on the button.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This method doesn't do anything on non-Windows platforms.
+    # </p>
+    # </div>
+    # @see Wx::Button#get_auth_needed
+    # @param needed [Boolean] 
+    # @return [void]
+    def set_auth_needed(needed=true) end
+    alias_method :auth_needed=, :set_auth_needed
+    
+    # This sets the button to be the default item in its top-level window (e.g.
+    # 
+    # the panel or the dialog box containing it).
+    # As normal, pressing return causes the default button to be depressed when the return key is pressed.
+    # See also {Wx::Window#set_focus} which sets the keyboard focus for windows and text panel items, and {Wx::TopLevelWindow#set_default_item}.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Under Windows, only dialog box buttons respond to this function.
+    # </p>
+    # </div>
+    # 
+    # the old default item (possibly nil)
+    # @return [Wx::Window]
+    def set_default; end
+    
+    # Sets the string label for the button.
+    # @param label [String]  The label to set.
+    # @return [void]
+    def set_label(label) end
+    alias_method :label=, :set_label
+    
+    # Returns the default size for the buttons.
+    # 
+    # It is advised to make all the dialog buttons of the same size and this function allows retrieving the (platform, and current font dependent) size which should be the best suited for this.
+    # The optional win argument is new since wxWidgets 3.1.3 and allows to get a per-monitor DPI specific size.
+    # @param win [Wx::Window] 
+    # @return [Wx::Size]
+    def self.get_default_size(win=nil) end
+    
+  end # Button
+  
+
+end