wxruby3 1.6.0 → 1.7.0

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

@@ -0,0 +1,175 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A choice item is used to select one of a list of strings.
+  # 
+  # Unlike a {Wx::ListBox}, only the selection is visible until the user pulls down the menu of choices.
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::CB_SORT}: Sorts the entries alphabetically. 
+  # 
+  # ### 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_choice}(id, meth = nil, &block): Process a {Wx::EVT_CHOICE} event, when an item on the list is selected. 
+  # 
+  # 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::ListBox
+  # @see  Wx::ComboBox
+  # @see  Wx::CommandEvent 
+  # 
+  # 
+  # @wxrb_require USE_CHOICE
+  class Choice < ControlWithItems
+  
+    # Creates the choice for two-step construction.
+    # 
+    # See {Wx::Choice#initialize}.
+    # @param parent [Wx::Window] 
+    # @param id [Integer] 
+    # @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(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::CHOICE_NAME_STR) end
+    
+    # @overload initialize()
+    #   Default constructor.
+    #   
+    #   
+    #   @see Wx::Choice#create
+    #   @see  Wx::Validator 
+    #   @return [Wx::Choice]
+    # @overload initialize(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::CHOICE_NAME_STR)
+    #   Constructor, creating and showing a choice.
+    #   
+    #   
+    #   @see Wx::Choice#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 pos [Array(Integer, Integer), Wx::Point]  Window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If {Wx::DEFAULT_SIZE} is specified then the choice is sized appropriately.
+    #   @param choices [Array<String>]  An array of strings with which to initialise the choice control.
+    #   @param style [Integer]  Window style. See {Wx::Choice}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @return [Wx::Choice]
+    # @overload initialize(parent, id, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::CHOICE_NAME_STR, &block)
+    #   Constructor, creating and showing a choice.
+    #   
+    #   
+    #   @see Wx::Choice#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 pos [Array(Integer, Integer), Wx::Point]  Window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If {Wx::DEFAULT_SIZE} is specified then the choice is sized appropriately.
+    #   @param choices [Array<String>]  An array of strings with which to initialise the choice control.
+    #   @param style [Integer]  Window style. See {Wx::Choice}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @yieldparam [Wx::Choice] win new instance
+    #   @return [Wx::Choice]
+    def initialize(*args) end
+    
+    # Gets the number of columns in this choice item.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This is implemented for GTK only and always returns 1 for the other platforms. 
+    # </p>
+    # </div>
+    # @return [Integer]
+    def get_columns; end
+    alias_method :columns, :get_columns
+    
+    # Unlike {Wx::ControlWithItems#get_selection} which only returns the accepted selection value (the selection in the control once the user closes the dropdown list), this function returns the current selection.
+    # 
+    # That is, while the dropdown list is shown, it returns the currently selected item in it. When it is not shown, its result is the same as for the other function.
+    # @return [Integer]
+    def get_current_selection; end
+    alias_method :current_selection, :get_current_selection
+    
+    # Sets the number of columns in this choice item.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>This is implemented for GTK only and doesn't do anything under other platforms. 
+    # </p>
+    # </div>
+    # @param n [Integer]  Number of columns.
+    # @return [void]
+    def set_columns(n=1) end
+    alias_method :columns=, :set_columns
+    
+    # Returns the number of items in the control.
+    # 
+    # 
+    # @see Wx::Choice#is_empty 
+    # @return [Integer]
+    def get_count; end
+    alias_method :count, :get_count
+    
+    # Returns the index of the selected item or {Wx::NOT_FOUND} if no item is selected.
+    # 
+    # The position of the current selection.
+    # @see Wx::Choice#set_selection
+    # @see  Wx::Choice#get_string_selection 
+    # @return [Integer]
+    def get_selection; end
+    alias_method :selection, :get_selection
+    
+    # Sets the selection to the given item n or removes the selection entirely if n == {Wx::NOT_FOUND}.
+    # 
+    # Note that this does not cause any command events to be emitted nor does it deselect any other items in the controls which support multiple selections.
+    # @see Wx::Choice#set_string
+    # @see  Wx::Choice#set_string_selection 
+    # @param n [Integer]  The string position to select, starting from zero.
+    # @return [void]
+    def set_selection(n) end
+    alias_method :selection=, :set_selection
+    
+    # Finds an item whose label matches the given string.
+    # 
+    # The zero-based position of the item, or {Wx::NOT_FOUND} if the string was not found.
+    # @param string [String]  String to find.
+    # @param caseSensitive [Boolean]  Whether search is case sensitive (default is not).
+    # @return [Integer]
+    def find_string(string, caseSensitive=false) end
+    
+    # Returns the label of the item with the given index.
+    # 
+    # The index must be valid, i.e. less than the value returned by {Wx::Choice#get_count}, otherwise an assert is triggered. Notably, this function can't be called if the control is empty.
+    # 
+    # The label of the item.
+    # @param n [Integer]  The zero-based index.
+    # @return [String]
+    def get_string(n) end
+    alias_method :string, :get_string
+    
+    # Sets the label for the given item.
+    # @param n [Integer]  The zero-based item index.
+    # @param string [String]  The label to set.
+    # @return [void]
+    def set_string(n, string) end
+    
+  end # Choice
+  
+
+end

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

@@ -0,0 +1,116 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  CHB_DEFAULT = 0
+  
+  # 
+  CHB_TOP = 16
+  
+  # 
+  CHB_BOTTOM = 32
+  
+  # 
+  CHB_LEFT = 64
+  
+  # 
+  CHB_RIGHT = 128
+  
+  # 
+  CHB_ALIGN_MASK = 240
+  
+  # 
+  # 
+  EVT_CHOICEBOOK_PAGE_CHANGED = 10232
+  
+  # 
+  # 
+  EVT_CHOICEBOOK_PAGE_CHANGING = 10231
+  
+  # {Wx::Choicebook} is a class similar to {Wx::Notebook}, but uses a {Wx::Choice} control to show the labels instead of the tabs.
+  # 
+  # For usage documentation of this class, please refer to the base abstract class {Wx::BookCtrl}. You can also use the page_samples_notebook to see {Wx::Choicebook} in action.
+  # {Wx::Choicebook} allows the use of {Wx::BookCtrlBase#get_control_sizer}, allowing a program to add other controls next to the choice control. This is particularly useful when screen space is restricted, as it often is when {Wx::Choicebook} is being employed.
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::CHB_DEFAULT}: Choose the default location for the labels depending on the current platform (but currently it's the same everywhere, namely {Wx::CHB_TOP}). 
+  # 
+  # - {Wx::CHB_TOP}: Place labels above the page area. 
+  # 
+  # - {Wx::CHB_LEFT}: Place labels on the left side. 
+  # 
+  # - {Wx::CHB_RIGHT}: Place labels on the right side. 
+  # 
+  # - {Wx::CHB_BOTTOM}: Place labels below the page area. 
+  # 
+  # ### Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::BookCtrlEvent} events.
+  # Event handler methods for events emitted by this class:
+  # 
+  # - {Wx::EvtHandler#evt_choicebook_page_changed}(id, meth = nil, &block): The page selection was changed. Processes a {Wx::EVT_CHOICEBOOK_PAGE_CHANGED} event. 
+  # 
+  # - {Wx::EvtHandler#evt_choicebook_page_changing}(id, meth = nil, &block): The page selection is about to be changed. Processes a {Wx::EVT_CHOICEBOOK_PAGE_CHANGING} event. This event can be vetoed (using {Wx::NotifyEvent#veto}). 
+  # 
+  # Category:  Book 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 wxBookCtrl Overview
+  # @see  Wx::Notebook
+  # @see  page_samples_notebook 
+  # 
+  # 
+  # @wxrb_require USE_CHOICEBOOK
+  class Choicebook < BookCtrlBase
+  
+    # @overload initialize()
+    #   Constructs a choicebook control.
+    #   @return [Wx::Choicebook]
+    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=(''))
+    #   Constructs a choicebook control.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @return [Wx::Choicebook]
+    # @overload initialize(parent, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=(''), &block)
+    #   Constructs a choicebook control.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param pos [Array(Integer, Integer), Wx::Point] 
+    #   @param size [Array(Integer, Integer), Wx::Size] 
+    #   @param style [Integer] 
+    #   @param name [String] 
+    #   @yieldparam [Wx::Choicebook] win new instance
+    #   @return [Wx::Choicebook]
+    def initialize(*args) end
+    
+    # Create the choicebook control that has already been constructed with the default constructor.
+    # @param parent [Wx::Window] 
+    # @param id [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, id, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, name=('')) end
+    
+    # Returns the {Wx::Choice} associated with the control.
+    # @return [Wx::Choice]
+    def get_choice_ctrl; end
+    alias_method :choice_ctrl, :get_choice_ctrl
+    
+  end # Choicebook
+  
+
+end

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

@@ -0,0 +1,43 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # Deprecated class for drawing on the client area of a window.
+  # 
+  # {Wx::ClientDC} should not be used any longer, please use {Wx::InfoDC} instead for obtaining information about the device context associated with a window.
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>While {Wx::ClientDC} may also be used for drawing on the client area of a window from outside an EVT_PAINT() handler in some ports, this does not work on all platforms: neither WXOSX nor WXGTK with GTK 3 Wayland backend support this at all, so drawing using {Wx::ClientDC} simply doesn't have any effect there. {Wx::ClientDC.can_be_used_for_drawing} can be used to determine whether {Wx::ClientDC} can be used for drawing in the current environment, but it is recommended to only draw on the window using {Wx::PaintDC}, as this is guaranteed to work everywhere. To redraw a small part of the window, use {Wx::Window#refresh_rect} to invalidate just this part and check {Wx::Window#get_update_region} in the paint event handler to redraw this part only.
+  # </p>
+  # </div>
+  # 
+  # {Wx::ClientDC} objects should normally be constructed as temporary stack objects, i.e. don't store a {Wx::ClientDC} object.
+  # A {Wx::ClientDC} object is initialized to use the same font and colours as the window it is associated with.
+  # 
+  # Category:  Device Contexts
+  # @see Wx::DC
+  # @see  Wx::MemoryDC
+  # @see  Wx::PaintDC
+  # @see  Wx::WindowDC 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class ClientDC < WindowDC
+  
+    # Return true if drawing on {Wx::ClientDC} actually works.
+    # 
+    # In many environments (currently this includes WXGTK when using Wayland backend, WXMSW when using double buffering and WXOSX in all cases), {Wx::ClientDC} can be only used for obtaining information about the device context, but not for actually drawing on it. Portable code should avoid using {Wx::ClientDC} completely, as explained in the class documentation, but it is also possible to optionally use it only when it does work, i.e. when this function returns true.
+    # @param window [Wx::Window]  The window that would be used with {Wx::ClientDC}.
+    # @return [Boolean]
+    def self.can_be_used_for_drawing(window) end
+    
+  end # ClientDC
+  
+
+end

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

@@ -0,0 +1,144 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A class for manipulating the clipboard.
+  # 
+  # To use the clipboard, you call member functions of the global {Wx::Clipboard} object passed to the block for {Wx::Clipboard.open}.
+  # See the {Wx::DataObject} Overview for further information.
+  # Call {Wx::Clipboard.open} to get ownership of the (global) clipboard and execute the given block. You now 
+  # own the clipboard passed to the given block. Call {Wx::Clipboard#set_data} to put data on the clipboard, or 
+  # {Wx::Clipboard#get_data} to retrieve data from the clipboard. The clipboard is closed and ownership 
+  # relinquished when the block returns. You should keep the clipboard open only momentarily.
+  # For example:
+  # 
+  # ```ruby
+  #   # Write some text to the clipboard
+  #   Wx::Clipboard.open do |clip|
+  #     # This data object is held by the clipboard
+  #     clip.place(Wx::TextDataObject.new("Some text"))
+  #     # or alternatively
+  #     # clip.set_data(Wx::TextDataObject.new("Some text"))
+  #   end
+  # 
+  #   # Read some text
+  #   data = Wx::TextDataObject.new
+  #   Wx::Clipboard.open do |clip|
+  #      if clip.supported?(Wx::DF_TEXT)
+  #        clip.fetch(data) # or clip.get_data(data)
+  #      end
+  #   end
+  #   Wx.message_box(data.get_text)
+  # ```
+  # 
+  # On GTK, the clipboard behavior can vary depending on the configuration of the end-user's machine. In order 
+  # for the clipboard data to persist after the window closes, a clipboard manager must be installed. Some 
+  # clipboard managers will automatically flush the clipboard after each new piece of data is added, while others 
+  # will not. The {Wx::Clipboard#flush} function will force the clipboard manager to flush the data.
+  # 
+  # Category:  Clipboard and Drag & Drop
+  # @see  Wx::DataObject
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_CLIPBOARD
+  class Clipboard < Object
+  
+    # Default constructor.
+    # @return [Wx::Clipboard]
+    def initialize; end
+    
+    # Call this function to add the data object to the clipboard.
+    # 
+    # This is an obsolete synonym for {Wx::Clipboard#set_data}.
+    # @param data [Wx::DataObject] 
+    # @return [Boolean]
+    def add_data(data) end
+    
+    # Clears the global clipboard object and the system's clipboard if possible.
+    # @return [void]
+    def clear; end
+    
+    # Call this function to close the clipboard, having opened it with {Wx::Clipboard#open}.
+    # @return [void]
+    def close; end
+    
+    # Flushes the clipboard: this means that the data which is currently on clipboard will stay available even after the application exits (possibly eating memory), otherwise the clipboard will be emptied on exit.
+    # 
+    # Currently this method is implemented in MSW and GTK and always returns false otherwise.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>On GTK, only the non-primary selection can be flushed. Calling this function when the clipboard is using the primary selection will return false and not make any data available after the program exits.
+    # </p>
+    # </div>
+    # 
+    # false if the operation is unsuccessful for any reason.
+    # @return [Boolean]
+    def flush; end
+    
+    # Call this function to fill data with data on the clipboard, if available in the required format.
+    # 
+    # Returns true on success.
+    # @param data [Wx::DataObject] 
+    # @return [Boolean]
+    def get_data(data) end
+    alias_method :data, :get_data
+    
+    # Returns true if the clipboard has been opened.
+    # @return [Boolean]
+    def is_opened; end
+    alias_method :opened?, :is_opened
+    
+    # Returns true if there is data which matches the data format of the given data object currently <b>available</b> on the clipboard.
+    # 
+    # TodoThe name of this function is misleading. This should be renamed to something that more accurately indicates what it does.
+    # @param format [Wx::DataFormat] 
+    # @return [Boolean]
+    def is_supported(format) end
+    alias_method :supported?, :is_supported
+    
+    # Returns true if we are using the primary selection, false if clipboard one.
+    # 
+    # 
+    # @see Wx::Clipboard#use_primary_selection 
+    # @return [Boolean]
+    def is_using_primary_selection; end
+    alias_method :using_primary_selection?, :is_using_primary_selection
+    
+    # Call this function to open the clipboard before calling {Wx::Clipboard#set_data} and {Wx::Clipboard#get_data}.
+    # 
+    # Call {Wx::Clipboard#close} when you have finished with the clipboard. You should keep the clipboard open for only a very short time.
+    # true on success. This should be tested (as in the sample shown above).
+    # @return [Boolean]
+    def open; end
+    
+    # Call this function to set the data object to the clipboard.
+    # 
+    # The new data object replaces any previously set one, so if the application wants to provide clipboard data in several different formats, it must use a composite data object supporting all of the formats instead of calling this function several times with different data objects as this would only leave data from the last one in the clipboard.
+    # After this function has been called, the clipboard owns the data, so do not delete the data explicitly.
+    # @param data [Wx::DataObject] 
+    # @return [Boolean]
+    def set_data(data) end
+    alias_method :data=, :set_data
+    
+    # On platforms supporting it (all X11-based ports), {Wx::Clipboard} uses the CLIPBOARD X11 selection by default.
+    # 
+    # When this function is called with true, all subsequent clipboard operations will use PRIMARY selection until this function is called again with false.
+    # On the other platforms, there is no PRIMARY selection and so all clipboard operations will fail. This allows implementing the standard X11 handling of the clipboard which consists in copying data to the CLIPBOARD selection only when the user explicitly requests it (i.e. by selecting the "Copy" menu command) but putting the currently selected text into the PRIMARY selection automatically, without overwriting the normal clipboard contents with the currently selected text on the other platforms.
+    # @param primary [Boolean] 
+    # @return [void]
+    def use_primary_selection(primary=false) end
+    
+    # Returns the global instance ({Wx::TheClipboard}) of the clipboard object.
+    # @return [Wx::Clipboard]
+    def self.get; end
+    
+  end # Clipboard
+  
+
+end

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

@@ -0,0 +1,138 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  CP_DEFAULT_STYLE = 2621440
+  
+  # 
+  CP_NO_TLW_RESIZE = 2
+  
+  # 
+  # 
+  EVT_COLLAPSIBLEPANE_CHANGED = 10145
+  
+  # A collapsible pane is a container with an embedded button-like control which can be used by the user to collapse or expand the pane's contents.
+  # 
+  # Once constructed, you should use the {Wx::CollapsiblePane#get_pane} function to access the pane and add your controls inside it (i.e., use the returned pointer from {Wx::CollapsiblePane#get_pane} as the parent for the controls which must go in the pane, <b>not</b> the {Wx::CollapsiblePane} itself!).
+  # Note that when using this control inside a sizer, you will usually want to call {Wx::Window#layout} whenever its size changes due to the pane being opened or closed, in order to adjust the positions of the neighbouring controls, for example:
+  # 
+  # ```ruby
+  #   collpane = Wx::CollapsiblePane.new(self, Wx::ID_ANY, "Details:")
+  #   
+  #   # add the pane with a zero proportion value to the 'sz' sizer which contains it
+  #   sz.add(collpane, 0, Wx::GROW|Wx::ALL, 5)
+  #   
+  #   #/ now add a test label in the collapsible pane using a sizer to layout it:
+  #   win = collpane.get_pane
+  #   pane_sz = Wx::VBoxSizer
+  #   pane_sz.add(Wx::StaticText.new(win, Wx::ID_ANY, "test!"), 1, Wx::GROW|Wx::ALL, 2)
+  #   win.set_sizer(pane_sz)
+  #   pane_sz.set_size_hints(win)
+  # ```
+  # 
+  # It is only available if {Wx::Setup::USE_COLLPANE} is set to 1 (the default).
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::CP_DEFAULT_STYLE}: The default style. It includes {Wx::TAB_TRAVERSAL} and {Wx::Border::BORDER_NONE}. 
+  # 
+  # - {Wx::CP_NO_TLW_RESIZE}: By default {Wx::CollapsiblePane} resizes the top level window containing it when its own size changes. This allows easily implementing dialogs containing an optionally shown part, for example, and so is the default behaviour but can be inconvenient in some specific cases  use this flag to disable this automatic parent resizing then. 
+  # 
+  # ### Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::NavigationKeyEvent} events.
+  # Event handler methods for events emitted by this class:
+  # 
+  # - {Wx::EvtHandler#evt_collapsiblepane_changed}(id, meth = nil, &block): The user expanded or collapsed the collapsible pane. 
+  # 
+  # - {Wx::EvtHandler#evt_navigation_key}(meth = nil, &block): Process a navigation key event. 
+  # 
+  # 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::Panel
+  # @see  Wx::CollapsiblePaneEvent 
+  # 
+  # 
+  # @wxrb_require USE_COLLPANE
+  class CollapsiblePane < Control
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Wx::CollapsiblePane]
+    # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::CP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COLLAPSIBLE_PANE_NAME_STR)
+    #   Initializes the object and calls {Wx::CollapsiblePane#create} with all the parameters.
+    #   @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 [Wx::CollapsiblePane]
+    # @overload initialize(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::CP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COLLAPSIBLE_PANE_NAME_STR, &block)
+    #   Initializes the object and calls {Wx::CollapsiblePane#create} with all the parameters.
+    #   @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] 
+    #   @yieldparam [Wx::CollapsiblePane] win new instance
+    #   @return [Wx::CollapsiblePane]
+    def initialize(*args) end
+    
+    # 
+    # 
+    # true if the control was successfully created or false if creation failed.
+    # @param parent [Wx::Window]  Parent window, must be non-null.
+    # @param id [Integer]  The identifier for the control.
+    # @param label [String]  The initial label shown in the button which allows the user to expand or collapse the pane window.
+    # @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::CP_}* flags.
+    # @param validator [Wx::Validator]  Validator which can be used for additional data checks.
+    # @param name [String]  Control name.
+    # @return [Boolean]
+    def create(parent, id, label, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::CP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COLLAPSIBLE_PANE_NAME_STR) end
+    
+    # Collapses or expands the pane window.
+    # @param collapse [Boolean] 
+    # @return [void]
+    def collapse(collapse=true) end
+    
+    # Same as calling Collapse(false).
+    # @return [void]
+    def expand; end
+    
+    # Returns a pointer to the pane window.
+    # 
+    # Add controls to the returned {Wx::Window} to make them collapsible.
+    # @return [Wx::Window]
+    def get_pane; end
+    alias_method :pane, :get_pane
+    
+    # Returns true if the pane window is currently hidden.
+    # @return [Boolean]
+    def is_collapsed; end
+    alias_method :collapsed?, :is_collapsed
+    
+    # Returns true if the pane window is currently shown.
+    # @return [Boolean]
+    def is_expanded; end
+    alias_method :expanded?, :is_expanded
+    
+  end # CollapsiblePane
+  
+
+end

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

@@ -0,0 +1,46 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This event class is used for the events generated by {Wx::CollapsiblePane}.
+  # 
+  # ### Events using this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::CollapsiblePaneEvent} events.
+  # Event handler methods:
+  # 
+  # - {Wx::EvtHandler#evt_collapsiblepane_changed}(id, meth = nil, &block): The user expanded or collapsed the collapsible pane. 
+  # 
+  # Category:  {Wx::Events}
+  # @see Wx::CollapsiblePane 
+  # 
+  # 
+  # @wxrb_require USE_COLLPANE
+  class CollapsiblePaneEvent < CommandEvent
+  
+    # The constructor is not normally used by the user code.
+    # @param generator [Wx::Object] 
+    # @param id [Integer] 
+    # @param collapsed [Boolean] 
+    # @return [Wx::CollapsiblePaneEvent]
+    def initialize(generator, id, collapsed) end
+    
+    # Returns true if the pane has been collapsed.
+    # @return [Boolean]
+    def get_collapsed; end
+    alias_method :collapsed, :get_collapsed
+    
+    # Sets this as a collapsed pane event (if collapsed is true) or as an expanded pane event (if collapsed is false).
+    # @param collapsed [Boolean] 
+    # @return [void]
+    def set_collapsed(collapsed) end
+    alias_method :collapsed=, :set_collapsed
+    
+  end # CollapsiblePaneEvent
+  
+
+end