wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,123 @@
+# :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> WXMSW Appearance
+  #   </td><td> WXGTK Appearance
+  #   </td><td> WXOSX Appearance
+  #   </td></tr></table></div>
+  # @see Wx::Button 
+  # 
+  # 
+  # @wxrb_require USE_BMPBUTTON
+  class BitmapButton < Button
+  
+    # @overload initialize()
+    #   Default ctor.
+    #   @return [Wx::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.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>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}.
+    #   </p>
+    #   </div>
+    #   @see Wx::BitmapButton#create
+    #   @see  Wx::Validator 
+    #   @param parent [Wx::Window]  Parent window. Must not be nil.
+    #   @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 [Wx::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, &block)
+    #   Constructor, creating and showing a button.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>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}.
+    #   </p>
+    #   </div>
+    #   @see Wx::BitmapButton#create
+    #   @see  Wx::Validator 
+    #   @param parent [Wx::Window]  Parent window. Must not be nil.
+    #   @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.
+    #   @yieldparam [Wx::BitmapButton] win new instance
+    #   @return [Wx::BitmapButton]
+    def initialize(*args) end
+    
+    # Button creation function for two-step creation.
+    # 
+    # For more details, see {Wx::BitmapButton#initialize}.
+    # @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 [Boolean]
+    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 [Boolean]
+    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/bitmap_combo_box.rb

@@ -0,0 +1,221 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A combobox that displays bitmap in front of the list items.
+  # 
+  # It currently only allows using bitmaps of one size, and resizes itself so that a bitmap can be shown next to the text field.
+  # 
+  # <div class="wxrb-remark">
+  # <b>Remark:</b>
+  # <p>While {Wx::BitmapComboBox} contains the {Wx::ComboBox} API, but it might not actually be derived from that class. In fact, if the platform does not have a native implementation, {Wx::BitmapComboBox} will inherit from {Wx::OwnerDrawnComboBox}. You can determine if the implementation is generic by checking whether {Wx::GENERIC_BITMAPCOMBOBOX} is defined. Currently {Wx::BitmapComboBox} is implemented natively for MSW and GTK+.
+  # </p>
+  # </div>
+  # 
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::CB_READONLY}: Creates a combobox without a text editor. On some platforms the control may appear very different when this style is used. 
+  # 
+  # - {Wx::CB_SORT}: Sorts the entries in the list alphabetically. 
+  # 
+  # - {Wx::TE_PROCESS_ENTER}: The control will generate the event {Wx::EVT_TEXT_ENTER} (otherwise pressing Enter key is either processed internally by the control or used for navigation between dialog controls). Windows only. 
+  # 
+  # Todocreate {Wx::CB_PROCESS_ENTER} rather than reusing {Wx::TE_PROCESS_ENTER}!
+  # 
+  # ### 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_combobox}(id, meth = nil, &block): Process a {Wx::EVT_COMBOBOX} event, when an item on the list is selected. 
+  # 
+  # - {Wx::EvtHandler#evt_text}(id, meth = nil, &block): Process a {Wx::EVT_TEXT} event, when the combobox text changes. 
+  # 
+  # - {Wx::EvtHandler#evt_text_enter}(id, meth = nil, &block): Process a {Wx::EVT_TEXT_ENTER} event, when RETURN is pressed in the combobox. 
+  # 
+  # 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::ComboBox
+  # @see  Wx::Choice
+  # @see  Wx::OwnerDrawnComboBox
+  # @see  Wx::CommandEvent 
+  # 
+  # 
+  # @wxrb_require USE_BITMAPCOMBOBOX
+  class BitmapComboBox < ComboBox
+  
+    # @overload initialize()
+    #   Default ctor.
+    #   @return [Wx::BitmapComboBox]
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BITMAP_COMBO_BOX_NAME_STR)
+    #   Constructor, creating and showing a combobox.
+    #   
+    #   
+    #   @see Wx::BitmapComboBox#create
+    #   @see  Wx::Validator 
+    #   @param parent [Wx::Window]  Parent window. Must not be nil.
+    #   @param id [Integer]  Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param value [String]  Initial selection string. An empty string indicates no selection.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Initial position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Initial size.
+    #   @param choices [Array<String>]  An array of strings with which to initialise the control.
+    #   @param style [Integer]  The window style, see {Wx::CB_}* flags.
+    #   @param validator [Wx::Validator]  Validator which can be used for additional data checks.
+    #   @param name [String]  Control name.
+    #   @return [Wx::BitmapComboBox]
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, choices=nil, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BITMAP_COMBO_BOX_NAME_STR, &block)
+    #   Constructor, creating and showing a combobox.
+    #   
+    #   
+    #   @see Wx::BitmapComboBox#create
+    #   @see  Wx::Validator 
+    #   @param parent [Wx::Window]  Parent window. Must not be nil.
+    #   @param id [Integer]  Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param value [String]  Initial selection string. An empty string indicates no selection.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Initial position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Initial size.
+    #   @param choices [Array<String>]  An array of strings with which to initialise the control.
+    #   @param style [Integer]  The window style, see {Wx::CB_}* flags.
+    #   @param validator [Wx::Validator]  Validator which can be used for additional data checks.
+    #   @param name [String]  Control name.
+    #   @yieldparam [Wx::BitmapComboBox] win new instance
+    #   @return [Wx::BitmapComboBox]
+    # @overload initialize(parent, id, value, pos, size, choices, style, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BITMAP_COMBO_BOX_NAME_STR)
+    #   Constructor, creating and showing a combobox.
+    #   
+    #   
+    #   @see Wx::BitmapComboBox#create
+    #   @see  Wx::Validator 
+    #   @param parent [Wx::Window]  Parent window. Must not be nil.
+    #   @param id [Integer]  Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param value [String]  Initial selection string. An empty string indicates no selection.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Initial position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Initial size.
+    #   @param choices [Array<String>]  A {Wx::ArrayString} with which to initialise the control.
+    #   @param style [Integer]  The window style, see {Wx::CB_}* flags.
+    #   @param validator [Wx::Validator]  Validator which can be used for additional data checks.
+    #   @param name [String]  Control name.
+    #   @return [Wx::BitmapComboBox]
+    # @overload initialize(parent, id, value, pos, size, choices, style, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BITMAP_COMBO_BOX_NAME_STR, &block)
+    #   Constructor, creating and showing a combobox.
+    #   
+    #   
+    #   @see Wx::BitmapComboBox#create
+    #   @see  Wx::Validator 
+    #   @param parent [Wx::Window]  Parent window. Must not be nil.
+    #   @param id [Integer]  Window identifier. The value {Wx::StandardID::ID_ANY} indicates a default value.
+    #   @param value [String]  Initial selection string. An empty string indicates no selection.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  Initial position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Initial size.
+    #   @param choices [Array<String>]  A {Wx::ArrayString} with which to initialise the control.
+    #   @param style [Integer]  The window style, see {Wx::CB_}* flags.
+    #   @param validator [Wx::Validator]  Validator which can be used for additional data checks.
+    #   @param name [String]  Control name.
+    #   @yieldparam [Wx::BitmapComboBox] win new instance
+    #   @return [Wx::BitmapComboBox]
+    def initialize(*args) end
+    
+    # @overload append(item, bitmap=(Wx::BitmapBundle.new()))
+    #   Adds the item to the end of the combo box.
+    #   @param item [String] 
+    #   @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    #   @return [Integer]
+    # @overload append(item, bitmap, clientData)
+    #   Adds the item to the end of the combo box, associating the given untyped, client data pointer clientData with the item.
+    #   @param item [String] 
+    #   @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    #   @param clientData [Object] 
+    #   @return [Integer]
+    # @overload append(item, bitmap, clientData)
+    #   Adds the item to the end of the combo box, associating the given typed client data pointer clientData with the item.
+    #   @param item [String] 
+    #   @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    #   @param clientData [Object] 
+    #   @return [Integer]
+    def append(*args) end
+    
+    # @overload create(parent, id, value, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BITMAP_COMBO_BOX_NAME_STR)
+    #   Creates the combobox for two-step construction.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param value [String] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param choices [Array<String>] 
+    #   @param style [Integer] 
+    #   @param validator [Wx::Validator] 
+    #   @param name [String] 
+    #   @return [Boolean]
+    # @overload create(parent, id, value, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::BITMAP_COMBO_BOX_NAME_STR)
+    #   Creates the combobox for two-step construction.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param value [String] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param choices [Array<String>] 
+    #   @param style [Integer] 
+    #   @param validator [Wx::Validator] 
+    #   @param name [String] 
+    #   @return [Boolean]
+    def create(*args) end
+    
+    # Returns the size of the bitmaps used in the combo box.
+    # 
+    # If the combo box is empty, then {Wx::DEFAULT_SIZE} is returned.
+    # @return [Wx::Size]
+    def get_bitmap_size; end
+    alias_method :bitmap_size, :get_bitmap_size
+    
+    # Returns the bitmap of the item with the given index.
+    # @param n [Integer] 
+    # @return [Wx::Bitmap]
+    def get_item_bitmap(n) end
+    alias_method :item_bitmap, :get_item_bitmap
+    
+    # @overload insert(item, bitmap, pos)
+    #   Inserts the item into the list before pos.
+    #   
+    #   Not valid for {Wx::CB_SORT} style, use {Wx::BitmapComboBox#append} instead.
+    #   @param item [String] 
+    #   @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    #   @param pos [Integer] 
+    #   @return [Integer]
+    # @overload insert(item, bitmap, pos, clientData)
+    #   Inserts the item into the list before pos, associating the given untyped, client data pointer with the item.
+    #   
+    #   Not valid for {Wx::CB_SORT} style, use {Wx::BitmapComboBox#append} instead.
+    #   @param item [String] 
+    #   @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    #   @param pos [Integer] 
+    #   @param clientData [Object] 
+    #   @return [Integer]
+    # @overload insert(item, bitmap, pos, clientData)
+    #   Inserts the item into the list before pos, associating the given typed client data pointer with the item.
+    #   
+    #   Not valid for {Wx::CB_SORT} style, use {Wx::BitmapComboBox#append} instead.
+    #   @param item [String] 
+    #   @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    #   @param pos [Integer] 
+    #   @param clientData [Object] 
+    #   @return [Integer]
+    def insert(*args) end
+    
+    # Sets the bitmap for the given item.
+    # @param n [Integer] 
+    # @param bitmap [Wx::BitmapBundle,Wx::Bitmap,Wx::Icon,Wx::Image] 
+    # @return [void]
+    def set_item_bitmap(n, bitmap) end
+    
+  end # BitmapComboBox
+  
+
+end

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

@@ -0,0 +1,273 @@
+# :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 
+  # 
+  # 
+  # @wxrb_require USE_AUI|USE_NOTEBOOK|USE_LISTBOOK|USE_CHOICEBOOK|USE_TOOLBOOK|USE_TREEBOOK
+  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 [Boolean]
+    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.
+    # 
+    # The text may contain mnemonics, i.e. accelerator characters preceded by the ampersand (<code>&</code>) character. If you need to include a literal ampersand in the text, you need to double it, i.e. use <code>&&</code>.
+    # @param page [Integer] 
+    # @param text [String] 
+    # @return [Boolean]
+    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 nil.
+    # @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 [Boolean] 
+    # @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.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Do not delete the page, it will be deleted by the book control.
+    # </p>
+    # </div>
+    # @see Wx::BookCtrlBase#insert_page 
+    # @param page [Wx::Window]  Specifies the new page.
+    # @param text [String]  Specifies the text of the new page. Note that it may contain mnemonic characters, see {Wx::BookCtrlBase#set_page_text} for more information.
+    # @param select [Boolean]  Specifies whether the page should be selected.
+    # @param imageId [Integer]  Specifies the optional image index for the new page.
+    # @return [Boolean]
+    def add_page(page, text, select=false, imageId=Wx::AUI::AuiNotebook::NO_IMAGE) end
+    
+    # Deletes all pages.
+    # @return [Boolean]
+    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 [Boolean]
+    def delete_page(page) end
+    
+    # Inserts a new page at the specified position.
+    # 
+    # true if successful, false otherwise.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Do not delete the page, it will be deleted by the book control.
+    # </p>
+    # </div>
+    # @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 of the new page. Note that it may contain mnemonic characters, see {Wx::BookCtrlBase#set_page_text} for more information.
+    # @param select [Boolean]  Specifies whether the page should be selected.
+    # @param imageId [Integer]  Specifies the optional image index for the new page.
+    # @return [Boolean]
+    def insert_page(index, page, text, select=false, imageId=Wx::AUI::AuiNotebook::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 [Boolean]
+    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 nil for them.
+    # Non-owning pointer to the sizer or nil.
+    # @return [Wx::Sizer]
+    def get_control_sizer; end
+    alias_method :control_sizer, :get_control_sizer
+    
+    # @overload initialize()
+    #   Default ctor.
+    #   @return [Wx::BookCtrlBase]
+    # @overload initialize(parent, winid, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=(''))
+    #   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 [Wx::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 [Boolean]
+    def create(parent, winid, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=('')) end
+    
+    # Sets the width and height of the pages.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>This method is currently not implemented for WXGTK. 
+    # </p>
+    # </div>
+    # @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,66 @@
+# :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. However the handler for this event does not have access to the new page being selected as this information is not always provided by the underlying native control.
+  # 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. However the handler for this event has access to the newly selected page.
+  # 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. If it just needs to react to the page change after it happened, handling page changed events is enough. It is also perfectly possible to handle both of these events, for different purposes.
+  # 
+  # Category:  {Wx::Events}, Book Controls
+  # @see Wx::Notebook
+  # @see  Wx::Listbook
+  # @see  Wx::Choicebook
+  # @see  Wx::Treebook
+  # @see  Wx::Toolbook
+  # @see  Wx::AUI::AuiNotebook 
+  # 
+  # 
+  # @wxrb_require USE_AUI|USE_NOTEBOOK|USE_LISTBOOK|USE_CHOICEBOOK|USE_TOOLBOOK|USE_TREEBOOK
+  class BookCtrlEvent < NotifyEvent
+  
+    # Constructor (used internally by wxWidgets only).
+    # @param eventType [Wx::TipWindow::EventType] 
+    # @param id [Integer] 
+    # @param sel [Integer] 
+    # @param oldSel [Integer] 
+    # @return [Wx::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.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>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. 
+    # </p>
+    # </div>
+    # @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