wxruby3 0.9.0.pre.beta.2-x64-mingw-ucrt-3.2-3.2.2

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

@@ -0,0 +1,91 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A bitmap button is a control that contains a bitmap.
+  # Notice that since wxWidgets 2.9.1 bitmap display is supported by the base {Wx::Button} class itself and the only tiny advantage of using this class is that it allows specifying the bitmap in its constructor, unlike {Wx::Button}. Please see the base class documentation for more information about images support in {Wx::Button}.
+  # === Styles
+  # 
+  # This class supports the following styles:
+  #  
+  # - {Wx::BU_LEFT}: Left-justifies the bitmap label. 
+  # - {Wx::BU_TOP}: Aligns the bitmap label to the top of the button. 
+  # - {Wx::BU_RIGHT}: Right-justifies the bitmap label. 
+  # - {Wx::BU_BOTTOM}: Aligns the bitmap label to the bottom of the button. 
+  # 
+  # Note that the {Wx::BU_EXACTFIT} style supported by {Wx::Button} is not used by this class as bitmap buttons don't have any minimal standard size by default.
+  # === 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> {Wx::MSW} Appearance
+  #   </td><td> {Wx::GTK} Appearance
+  #   </td><td> {Wx::OSX} Appearance
+  #   </td></tr></table></div>
+  # @see Wx::Button 
+  # 
+  # 
+  class BitmapButton < Button
+  
+    # @overload initialize()
+    #   Default ctor.
+    #   @return [BitmapButton]
+    # @overload initialize(parent, id, bitmap, 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 bitmap parameter is normally the only bitmap you need to provide, and wxWidgets will draw the button correctly in its different states. If you want more control, call any of the functions {Wx::BitmapButton#set_bitmap_pressed}, {Wx::BitmapButton#set_bitmap_focus}, {Wx::BitmapButton#set_bitmap_disabled}.
+    #   @see Wx::BitmapButton#create
+    #   @see  Wx::Validator 
+    #   @param parent [Wx::Window]  Parent window. Must not be NULL.
+    #   @param id [Integer]  Button identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image]  Bitmap to be displayed.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Button position. If {Wx::DEFAULT_POSITION} is specified then a default position is chosen.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Button size. If {Wx::DEFAULT_SIZE} is specified then the button is sized appropriately for the bitmap.
+    #   @param style [Integer]  Window style. See {Wx::BitmapButton}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @return [BitmapButton]
+    def initialize(*args) end
+    
+    # Button creation function for two-step creation.
+    # For more details, see {Wx::BitmapButton#bitmap_button}.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    # @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 [true,false]
+    def create(parent, id, bitmap, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BUTTON_NAME_STR) end
+    
+    # Creation function for two-step creation of "Close" button.
+    # It is usually not necessary to use this function directly as {Wx::BitmapButton.new_close_button} is more convenient, but, if required, it can be called on a default-constructed {Wx::BitmapButton} object to achieve the same effect.
+    # @param parent [Wx::Window]  The button parent window, must be non-NULL.
+    # @param winid [Integer]  The identifier for the new button.
+    # @param name [String]  The name for the new button.
+    # @return [true,false]
+    def create_close_button(parent, winid, name=(())) end
+    
+    # Helper function creating a standard-looking "Close" button.
+    # To get the best results, platform-specific code may need to be used to create a small, title bar-like "Close" button. This function is provided to avoid the need to test for the current platform and creates the button with as native look as possible.
+    # 
+    # The new button.
+    # @param parent [Wx::Window]  The button parent window, must be non-NULL.
+    # @param winid [Integer]  The identifier for the new button.
+    # @param name [String]  The name for the new button (available since wxWidgets 3.1.5)
+    # @return [Wx::BitmapButton]
+    def self.new_close_button(parent, winid, name=(())) end
+    
+  end # BitmapButton
+  
+
+end

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

@@ -0,0 +1,240 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  BK_DEFAULT = 0
+  
+  # 
+  BK_TOP = 16
+  
+  # 
+  BK_BOTTOM = 32
+  
+  # 
+  BK_LEFT = 64
+  
+  # 
+  BK_RIGHT = 128
+  
+  # 
+  BK_ALIGN_MASK = 240
+  
+  # No tab at the specified point.
+  # 
+  BK_HITTEST_NOWHERE = 1
+  
+  # The point is over an icon.
+  # 
+  BK_HITTEST_ONICON = 2
+  
+  # The point is over a tab label.
+  # 
+  BK_HITTEST_ONLABEL = 4
+  
+  # The point if over a tab item but not over its icon or label.
+  # 
+  BK_HITTEST_ONITEM = 16
+  
+  # The point is over the page area.
+  # 
+  BK_HITTEST_ONPAGE = 8
+  
+  # A book control is a convenient way of displaying multiple pages of information, displayed one page at a time.
+  # wxWidgets has five variants of this control:
+  # 
+  # - {Wx::Choicebook}: controlled by a {Wx::Choice} 
+  # - {Wx::Listbook}: controlled by a {Wx::ListCtrl} 
+  # - {Wx::Notebook}: uses a row of tabs 
+  # - {Wx::Treebook}: controlled by a {Wx::TreeCtrl} 
+  # - {Wx::Toolbook}: controlled by a {Wx::ToolBar}
+  # 
+  # This abstract class is the parent of all these book controls, and provides their basic interface. This is a pure virtual class so you cannot allocate it directly.
+  # === 
+  # 
+  # Category:  Book Controls
+  # @see wxBookCtrl Overview 
+  # 
+  # 
+  class BookCtrlBase < Control
+  
+    include Wx::WithImages
+  
+    # Symbolic constant indicating that no image should be used.
+    # 
+    NO_IMAGE = -1
+    
+    # Returns the image index for the given page.
+    # @param nPage [Integer] 
+    # @return [Integer]
+    def get_page_image(nPage) end
+    alias_method :page_image, :get_page_image
+    
+    # Sets the image index for the given page.
+    # image is an index into the image list which was set with {Wx::BookCtrlBase#set_image_list}.
+    # @param page [Integer] 
+    # @param image [Integer] 
+    # @return [true,false]
+    def set_page_image(page, image) end
+    
+    # Returns the string for the given page.
+    # @param nPage [Integer] 
+    # @return [String]
+    def get_page_text(nPage) end
+    alias_method :page_text, :get_page_text
+    
+    # Sets the text for the given page.
+    # @param page [Integer] 
+    # @param text [String] 
+    # @return [true,false]
+    def set_page_text(page, text) end
+    
+    # Returns the currently selected page, or {Wx::NOT_FOUND} if none was selected.
+    # Note that this method may return either the previously or newly selected page when called from the EVT_BOOKCTRL_PAGE_CHANGED handler depending on the platform and so {Wx::BookCtrlEvent#get_selection} should be used instead in this case.
+    # @return [Integer]
+    def get_selection; end
+    alias_method :selection, :get_selection
+    
+    # Returns the currently selected page or NULL.
+    # @return [Wx::Window]
+    def get_current_page; end
+    alias_method :current_page, :get_current_page
+    
+    # Sets the selection to the given page, returning the previous selection.
+    # Notice that the call to this function generates the page changing events, use the {Wx::BookCtrlBase#change_selection} function if you don't want these events to be generated.
+    # @see Wx::BookCtrlBase#get_selection 
+    # @param page [Integer] 
+    # @return [Integer]
+    def set_selection(page) end
+    alias_method :selection=, :set_selection
+    
+    # Cycles through the tabs.
+    # The call to this function generates the page changing events.
+    # @param forward [true,false] 
+    # @return [void]
+    def advance_selection(forward=true) end
+    
+    # Changes the selection to the given page, returning the previous selection.
+    # This function behaves as {Wx::BookCtrlBase#set_selection} but does not generate the page changing events.
+    # See User Generated Events vs Programmatically Generated Events for more information.
+    # @param page [Integer] 
+    # @return [Integer]
+    def change_selection(page) end
+    
+    # Returns the index of the specified tab window or {Wx::NOT_FOUND} if not found.
+    # The zero-based tab index or {Wx::NOT_FOUND} if not found.
+    # @param page [Wx::Window]  One of the control pages.
+    # @return [Integer]
+    def find_page(page) end
+    
+    # Adds a new page.
+    # The page must have the book control itself as the parent and must not have been added to this control previously.
+    # The call to this function will generate the page changing and page changed events if select is true, but not when inserting the very first page (as there is no previous page selection to switch from in this case and so it wouldn't make sense to e.g. veto such event).
+    # 
+    # true if successful, false otherwise.
+    # 
+    # Do not delete the page, it will be deleted by the book control.
+    # @see Wx::BookCtrlBase#insert_page 
+    # @param page [Wx::Window]  Specifies the new page.
+    # @param text [String]  Specifies the text for the new page.
+    # @param select [true,false]  Specifies whether the page should be selected.
+    # @param imageId [Integer]  Specifies the optional image index for the new page.
+    # @return [true,false]
+    def add_page(page, text, select=false, imageId=Wx::NO_IMAGE) end
+    
+    # Deletes all pages.
+    # @return [true,false]
+    def delete_all_pages; end
+    
+    # Deletes the specified page, and the associated window.
+    # The call to this function generates the page changing events when deleting the currently selected page or a page preceding it in the index order, but it does not send any events when deleting the last page: while in this case the selection also changes, it becomes invalid and for compatibility reasons the control never generates events with the invalid selection index.
+    # @param page [Integer] 
+    # @return [true,false]
+    def delete_page(page) end
+    
+    # Inserts a new page at the specified position.
+    # true if successful, false otherwise.
+    # 
+    # Do not delete the page, it will be deleted by the book control.
+    # @see Wx::BookCtrlBase#add_page 
+    # @param index [Integer]  Specifies the position for the new page.
+    # @param page [Wx::Window]  Specifies the new page.
+    # @param text [String]  Specifies the text for the new page.
+    # @param select [true,false]  Specifies whether the page should be selected.
+    # @param imageId [Integer]  Specifies the optional image index for the new page.
+    # @return [true,false]
+    def insert_page(index, page, text, select=false, imageId=Wx::NO_IMAGE) end
+    
+    # Deletes the specified page, without deleting the associated window.
+    # See {Wx::BookCtrlBase#delete_page} for a note about the events generated by this function.
+    # @param page [Integer] 
+    # @return [true,false]
+    def remove_page(page) end
+    
+    # Returns the number of pages in the control.
+    # @return [Integer]
+    def get_page_count; end
+    alias_method :page_count, :get_page_count
+    
+    # Returns the window at the given page position.
+    # @param page [Integer] 
+    # @return [Wx::Window]
+    def get_page(page) end
+    alias_method :page, :get_page
+    
+    # Returns the sizer containing the control for page selection, if any.
+    # Some derived classes, e.g. {Wx::Choicebook}, use a separate control for switching the currently selected page and this function returns the sizer used for positioning this control and the pages themselves inside the book control.
+    # Note that many classes, notably {Wx::Notebook}, do not use any such control, and this function simply returns NULL for them.
+    # Non-owning pointer to the sizer or NULL.
+    # @return [Wx::Sizer]
+    def get_control_sizer; end
+    alias_method :control_sizer, :get_control_sizer
+    
+    # @overload initialize()
+    #   Default ctor.
+    #   @return [BookCtrlBase]
+    # @overload initialize(parent, winid, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::EMPTY_STRING)
+    #   Constructs the book control with the given parameters.
+    #   See {Wx::BookCtrlBase#create} for two-step construction.
+    #   @param parent [Wx::Window] 
+    #   @param winid [Integer] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @return [BookCtrlBase]
+    def initialize(*args) end
+    
+    # Constructs the book control with the given parameters.
+    # @param parent [Wx::Window] 
+    # @param winid [Integer] 
+    # @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, winid, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=Wx::EMPTY_STRING) end
+    
+    # Sets the width and height of the pages.
+    # This method is currently not implemented for {Wx::GTK}.
+    # @param size [Array(Integer, Integer), Wx::Size] 
+    # @return [void]
+    def set_page_size(size) end
+    alias_method :page_size=, :set_page_size
+    
+    # Returns the index of the tab at the specified position or {Wx::NOT_FOUND} if none.
+    # If flags parameter is non-NULL, the position of the point inside the tab is returned as well.
+    # 
+    # Returns the zero-based tab index or {Wx::NOT_FOUND} if there is no tab at the specified position.
+    # @param pt [Array(Integer, Integer), Wx::Point]  Specifies the point for the hit test.
+    # @return [Array(Integer,Integer)]
+    def hit_test(pt) end
+    
+  end # BookCtrlBase
+  
+
+end

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

@@ -0,0 +1,60 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This class represents the events generated by book controls ({Wx::Notebook}, {Wx::Listbook}, {Wx::Choicebook}, {Wx::Treebook}, {Wx::AUI::AuiNotebook}).
+  # The PAGE_CHANGING events are sent before the current page is changed. It allows the program to examine the current page (which can be retrieved with {Wx::BookCtrlEvent#get_old_selection}) and to veto the page change by calling {Wx::NotifyEvent#veto} if, for example, the current values in the controls of the old page are invalid.
+  # The PAGE_CHANGED events are sent after the page has been changed and the program cannot veto it any more, it just informs it about the page change.
+  # To summarize, if the program is interested in validating the page values before allowing the user to change it, it should process the PAGE_CHANGING event, otherwise PAGE_CHANGED is probably enough. In any case, it is probably unnecessary to process both events at once.
+  # === 
+  # 
+  # Category:  {Wx::Events}, Book Controls
+  # @see Wx::Notebook
+  # @see  Wx::Listbook
+  # @see  Wx::Choicebook
+  # @see  Wx::Treebook
+  # @see  Wx::Toolbook
+  # @see  Wx::AUI::AuiNotebook 
+  # 
+  # 
+  class BookCtrlEvent < NotifyEvent
+  
+    # Constructor (used internally by wxWidgets only).
+    # @param eventType [Integer] 
+    # @param id [Integer] 
+    # @param sel [Integer] 
+    # @param oldSel [Integer] 
+    # @return [BookCtrlEvent]
+    def initialize(eventType=Wx::EVT_NULL, id=0, sel=Wx::NOT_FOUND, oldSel=Wx::NOT_FOUND) end
+    
+    # Returns the page that was selected before the change, {Wx::NOT_FOUND} if none was selected.
+    # @return [Integer]
+    def get_old_selection; end
+    alias_method :old_selection, :get_old_selection
+    
+    # Returns the currently selected page, or {Wx::NOT_FOUND} if none was selected.
+    # under Windows, {Wx::BookCtrlEvent#get_selection} will return the same value as {Wx::BookCtrlEvent#get_old_selection} when called from the EVT_BOOKCTRL_PAGE_CHANGING handler and not the page which is going to be selected.
+    # @return [Integer]
+    def get_selection; end
+    alias_method :selection, :get_selection
+    
+    # Sets the id of the page selected before the change.
+    # @param page [Integer] 
+    # @return [void]
+    def set_old_selection(page) end
+    alias_method :old_selection=, :set_old_selection
+    
+    # Sets the selection member variable.
+    # @param page [Integer] 
+    # @return [void]
+    def set_selection(page) end
+    alias_method :selection=, :set_selection
+    
+  end # BookCtrlEvent
+  
+
+end

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

@@ -0,0 +1,66 @@
+# :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
+  
+    # 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 [BoxSizer]
+    def initialize(orient) end
+    
+    # Adds non-stretchable space to the main orientation of the sizer only.
+    # More readable way of calling: 
+    # 
+    #   if ( wxBoxSizer::IsVertical() )
+    #   {
+    #       wxBoxSizer::Add(0, size, 0).
+    #   }
+    #   else
+    #   {
+    #       wxBoxSizer::Add(size, 0, 0).
+    #   }
+    # @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
+    
+  end # BoxSizer
+  
+
+end

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

@@ -0,0 +1,219 @@
+# :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 
+  # 
+  # 
+  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 [Brush]
+    # @overload initialize(colour, style=Wx::BRUSHSTYLE_SOLID)
+    #   Constructs a brush from a colour object and style.
+    #   @param colour [Wx::Colour,String,Symbol]  Colour object.
+    #   @param style [BrushStyle]  One of the {Wx::BrushStyle} enumeration values.
+    #   @return [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 [Brush]
+    # @overload initialize(brush)
+    #   Copy constructor, uses reference counting.
+    #   @param brush [Wx::Brush] 
+    #   @return [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 [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 [true,false]
+    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 [true,false]
+    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 [true,false]
+    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 [true,false]
+    def is_transparent; end
+    alias_method :transparent?, :is_transparent
+    
+    # Sets the stipple bitmap.
+    # 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}.
+    # @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 [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 [true,false]
+    def ==(brush) end
+    
+  end # Brush
+  
+
+end