wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,395 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  # 
+  # 
+  # 
+  # @wxrb_require USE_ODCOMBOBOX
+  class OwnerDrawnComboBoxPaintingFlags < Wx::Enum
+  
+    # Combo control is being painted, instead of a list item.
+    # 
+    ODCB_PAINTING_CONTROL = Wx::OwnerDrawnComboBoxPaintingFlags.new(1)
+    
+    # An item with selection background is being painted.
+    # 
+    ODCB_PAINTING_SELECTED = Wx::OwnerDrawnComboBoxPaintingFlags.new(2)
+    
+  end # OwnerDrawnComboBoxPaintingFlags
+  
+  # Double-clicking cycles item if {Wx::CB_READONLY} is also used.
+  # 
+  ODCB_DCLICK_CYCLES = 256
+  
+  # If used, control itself is not custom paint using callback.
+  # 
+  ODCB_STD_CONTROL_PAINT = 4096
+  
+  # {Wx::OwnerDrawnComboBox} is a combobox with owner-drawn list items.
+  # 
+  # In essence, it is a {Wx::ComboCtrl} with {Wx::VListBox} popup and {Wx::ControlWithItems} interface.
+  # Implementing item drawing and measuring is similar to {Wx::VListBox}. Application needs to subclass {Wx::OwnerDrawnComboBox} and implement {Wx::OwnerDrawnComboBox#on_draw_item}, {Wx::OwnerDrawnComboBox#on_measure_item} and {Wx::OwnerDrawnComboBox#on_measure_item_width}.
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::ODCB_DCLICK_CYCLES}: Double-clicking cycles item if {Wx::CB_READONLY} is also used. Synonymous with {Wx::CC_SPECIAL_DCLICK}. 
+  # 
+  # - {Wx::ODCB_STD_CONTROL_PAINT}: Control itself is not custom painted using OnDrawItem. Even if this style is not used, writable {Wx::OwnerDrawnComboBox} is never custom painted unless {Wx::OwnerDrawnComboBox#set_custom_paint_width} is called. 
+  # 
+  # ### 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. Note that calling {Wx::OwnerDrawnComboBox#get_value} returns the new value of selection. 
+  # 
+  # 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::ComboCtrl window styles and Window Styles.
+  # 
+  # @see Events emitted by Wx::ComboCtrl.
+  # 
+  # @see Wx::ComboCtrl
+  # @see  Wx::ComboBox
+  # @see  Wx::VListBox
+  # @see  Wx::CommandEvent 
+  # 
+  # 
+  # @wxrb_require USE_ODCOMBOBOX
+  class OwnerDrawnComboBox < ComboCtrl
+  
+    # @overload create(parent, id, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COMBO_BOX_NAME_STR)
+    #   Creates the combobox for two-step construction.
+    #   
+    #   See {Wx::OwnerDrawnComboBox#initialize} for further details.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>Derived classes should call or replace this function. 
+    #   </p>
+    #   </div>
+    #   @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 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::COMBO_BOX_NAME_STR)
+    #   Creates the combobox for two-step construction.
+    #   
+    #   See {Wx::OwnerDrawnComboBox#initialize} for further details.
+    #   
+    #   <div class="wxrb-remark">
+    #   <b>Remark:</b>
+    #   <p>Derived classes should call or replace this function. 
+    #   </p>
+    #   </div>
+    #   @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
+    
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Wx::OwnerDrawnComboBox]
+    # @overload initialize(parent, id, value, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=("COMBO_BOX"))
+    #   Constructor, creating and showing a owner-drawn combobox.
+    #   
+    #   
+    #   @see Wx::OwnerDrawnComboBox#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]  Window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
+    #   @param choices [Array<String>]  An array of strings with which to initialise the control.
+    #   @param style [Integer]  Window style. See {Wx::OwnerDrawnComboBox}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @return [Wx::OwnerDrawnComboBox]
+    # @overload initialize(parent, id, value, pos, size, choices, style=0, validator=Wx::DEFAULT_VALIDATOR, name=("COMBO_BOX"), &block)
+    #   Constructor, creating and showing a owner-drawn combobox.
+    #   
+    #   
+    #   @see Wx::OwnerDrawnComboBox#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]  Window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
+    #   @param choices [Array<String>]  An array of strings with which to initialise the control.
+    #   @param style [Integer]  Window style. See {Wx::OwnerDrawnComboBox}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @yieldparam [Wx::OwnerDrawnComboBox] win new instance
+    #   @return [Wx::OwnerDrawnComboBox]
+    # @overload initialize(parent, id, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COMBO_BOX_NAME_STR)
+    #   Constructor, creating and showing a owner-drawn combobox.
+    #   
+    #   This overload creates a combobox with no initial items. It has been added in {Wx::Window} 3.3.1.
+    #   @see Wx::OwnerDrawnComboBox#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]  Window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
+    #   @param style [Integer]  Window style. See {Wx::OwnerDrawnComboBox}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @return [Wx::OwnerDrawnComboBox]
+    # @overload initialize(parent, id, value=(''), pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=0, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COMBO_BOX_NAME_STR, &block)
+    #   Constructor, creating and showing a owner-drawn combobox.
+    #   
+    #   This overload creates a combobox with no initial items. It has been added in {Wx::Window} 3.3.1.
+    #   @see Wx::OwnerDrawnComboBox#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]  Window position.
+    #   @param size [Array(Integer, Integer), Wx::Size]  Window size. If {Wx::DEFAULT_SIZE} is specified then the window is sized appropriately.
+    #   @param style [Integer]  Window style. See {Wx::OwnerDrawnComboBox}.
+    #   @param validator [Wx::Validator]  Window validator.
+    #   @param name [String]  Window name.
+    #   @yieldparam [Wx::OwnerDrawnComboBox] win new instance
+    #   @return [Wx::OwnerDrawnComboBox]
+    def initialize(*args) end
+    
+    # {Wx::OwnerDrawnComboBox#is_empty} is not available in this class.
+    # 
+    # This method is documented here only to notice that it can't be used with this class because of the ambiguity between the methods with the same name inherited from {Wx::ItemContainer} and {Wx::TextEntry} base classes.
+    # Because of this, any attempt to call it results in a compilation error and you should use either {Wx::OwnerDrawnComboBox#is_list_empty} or {Wx::OwnerDrawnComboBox#is_text_empty} depending on what exactly do you want to test.
+    # @return [Boolean]
+    def is_empty; end
+    alias_method :empty?, :is_empty
+    
+    # Returns true if the list of combobox choices is empty.
+    # 
+    # Use this method instead of (not available in this class) {Wx::OwnerDrawnComboBox#is_empty} to test if the list of items is empty.
+    # @return [Boolean]
+    def is_list_empty; end
+    alias_method :list_empty?, :is_list_empty
+    
+    # Returns true if the text of the combobox is empty.
+    # 
+    # Use this method instead of (not available in this class) {Wx::OwnerDrawnComboBox#is_empty} to test if the text currently entered into the combobox is empty.
+    # @return [Boolean]
+    def is_text_empty; end
+    alias_method :text_empty?, :is_text_empty
+    
+    # Returns index to the widest item in the list.
+    # @return [Integer]
+    def get_widest_item; end
+    alias_method :widest_item, :get_widest_item
+    
+    # Returns width of the widest item in the list.
+    # @return [Integer]
+    def get_widest_item_width; end
+    alias_method :widest_item_width, :get_widest_item_width
+    
+    # @overload append(item)
+    #   Appends item into the control.
+    #   
+    #   The return value is the index of the newly inserted item. Note that this may be different from the last one if the control is sorted (e.g. has {Wx::LB_SORT} or {Wx::CB_SORT} style).
+    #   @param item [String]  String to add.
+    #   @return [Integer]
+    # @overload append(item, clientData)
+    #   Appends item into the control.
+    #   
+    #   The return value is the index of the newly inserted item. Note that this may be different from the last one if the control is sorted (e.g. has {Wx::LB_SORT} or {Wx::CB_SORT} style).
+    #   @param item [String]  String to add.
+    #   @param clientData [Object]  Pointer to client data to associate with the new item.
+    #   @return [Integer]
+    # @overload append(items)
+    #   Appends several items at once into the control.
+    #   
+    #   Notice that calling this method is usually much faster than appending them one by one if you need to add a lot of items.
+    #   @param items [Array<String>]  Array of strings to insert.
+    #   @return [Integer]
+    # @overload append(items, clientData)
+    #   Appends several items at once into the control.
+    #   
+    #   Notice that calling this method is usually much faster than appending them one by one if you need to add a lot of items.
+    #   @param items [Array<String>]  Array of strings to insert.
+    #   @param clientData [Wx::ClientData]  Array of client data pointers of the same size as items to associate with the new items.
+    #   @return [Integer]
+    def append(*args) end
+    
+    # Returns a pointer to the client data associated with the given item (if any).
+    # 
+    # It is an error to call this function for a control which doesn't have typed client data at all although it is OK to call it even if the given item doesn't have any client data associated with it (but other items do).
+    # Notice that the returned pointer is still owned by the control and will be deleted by it, use {Wx::OwnerDrawnComboBox#detach_client_object} if you want to remove the pointer from the control.
+    # 
+    # A pointer to the client data, or nil if not present.
+    # @param n [Integer]  The zero-based position of the item.
+    # @return [Object]
+    def get_client_object(n) end
+    alias_method :client_object, :get_client_object
+    
+    # Associates the given typed client data pointer with the given item: the data object will be deleted when the item is deleted (either explicitly by using {Wx::OwnerDrawnComboBox#delete} or implicitly when the control itself is destroyed).
+    # 
+    # Note that it is an error to call this function if any untyped client data pointers had been associated with the control items before.
+    # @param n [Integer]  The zero-based item index.
+    # @param data [Object]  The client data to associate with the item.
+    # @return [void]
+    def set_client_object(n, data) end
+    
+    # @overload insert(item, pos)
+    #   Inserts item into the control.
+    #   
+    #   The return value is the index of the newly inserted item. If the insertion failed for some reason, -1 is returned.
+    #   @param item [String]  String to add.
+    #   @param pos [Integer]  Position to insert item before, zero based.
+    #   @return [Integer]
+    # @overload insert(item, pos, clientData)
+    #   Inserts item into the control.
+    #   
+    #   The return value is the index of the newly inserted item. If the insertion failed for some reason, -1 is returned.
+    #   @param item [String]  String to add.
+    #   @param pos [Integer]  Position to insert item before, zero based.
+    #   @param clientData [Object]  Pointer to client data to associate with the new item.
+    #   @return [Integer]
+    # @overload insert(items, pos)
+    #   Inserts several items at once into the control.
+    #   
+    #   Notice that calling this method is usually much faster than inserting them one by one if you need to insert a lot of items.
+    #   
+    #   The return value is the index of the last inserted item. If the insertion failed for some reason, -1 is returned.
+    #   @param items [Array<String>]  Array of strings to insert.
+    #   @param pos [Integer]  Position to insert the items before, zero based.
+    #   @return [Integer]
+    # @overload insert(items, pos, clientData)
+    #   Inserts several items at once into the control.
+    #   
+    #   Notice that calling this method is usually much faster than inserting them one by one if you need to insert a lot of items.
+    #   
+    #   The return value is the index of the last inserted item. If the insertion failed for some reason, -1 is returned.
+    #   @param items [Array<String>]  Array of strings to insert.
+    #   @param pos [Integer]  Position to insert the items before, zero based.
+    #   @param clientData [Wx::ClientData]  Array of client data pointers of the same size as items to associate with the new items.
+    #   @return [Integer]
+    def insert(*args) end
+    
+    # @overload set(items)
+    #   Replaces the current control contents with the given items.
+    #   
+    #   Notice that calling this method is usually much faster than appending them one by one if you need to add a lot of items.
+    #   @param items [Array<String>]  Array of strings to insert.
+    #   @return [void]
+    # @overload set(items, clientData)
+    #   Replaces the current control contents with the given items.
+    #   
+    #   Notice that calling this method is usually much faster than appending them one by one if you need to add a lot of items.
+    #   @param items [Array<String>]  Array of strings to insert.
+    #   @param clientData [Wx::ClientData]  Array of client data pointers of the same size as items to associate with the new items.
+    #   @return [void]
+    def set(*args) end
+    
+    # Deletes an item from the control.
+    # 
+    # The client data associated with the item will be also deleted if it is owned by the control. Note that it is an error (signalled by an assert failure in debug builds) to remove an item with the index negative or greater or equal than the number of items in the control.
+    # If there is a currently selected item below the item being deleted, i.e. if {Wx::OwnerDrawnComboBox#get_selection} returns a valid index greater than or equal to n, the selection is invalidated when this function is called. However if the selected item appears before the item being deleted, the selection is preserved unchanged.
+    # @see Wx::OwnerDrawnComboBox#clear 
+    # @param n [Integer]  The zero-based item index.
+    # @return [void]
+    def delete(n) end
+    
+    # The control may maintain its items in a sorted order in which case items are automatically inserted at the right position when they are inserted or appended.
+    # 
+    # Returns true if the control maintains its items in a sorted order.
+    # @return [Boolean]
+    def is_sorted; end
+    alias_method :sorted?, :is_sorted
+    
+    # Returns the client object associated with the given item and transfers its ownership to the caller.
+    # 
+    # This method, unlike {Wx::OwnerDrawnComboBox#get_client_object}, expects the caller to delete the returned pointer. It also replaces the internally stored pointer with nil, i.e. completely detaches the client object pointer from the control.
+    # It's an error to call this method unless {Wx::OwnerDrawnComboBox#has_client_object_data} returns true.
+    # 
+    # The associated client object pointer to be deleted by caller or nil.
+    # @param n [Integer]  The zero-based item index.
+    # @return [Object]
+    def detach_client_object(n) end
+    
+    # Returns true, if either untyped data (<code>void*</code>) or object data ({Wx::ClientData}*) is associated with the items of the control.
+    # @return [Boolean]
+    def has_client_data; end
+    alias_method :has_client_data?, :has_client_data
+    
+    # Returns true, if object data is associated with the items of the control.
+    # 
+    # Object data pointers have the type <code>wxClientData*</code> instead of <code>void*</code> and, importantly, are owned by the control, i.e. will be deleted by it, unlike their untyped counterparts.
+    # @return [Boolean]
+    def has_client_object_data; end
+    alias_method :has_client_object_data?, :has_client_object_data
+    
+    
+    protected
+    
+    # This method is used to draw the items background and, maybe, a border around it.
+    # 
+    # The base class version implements a reasonable default behaviour which consists in drawing the selected item with the standard background colour and drawing a border around the item if it is either selected or current.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>flags has the same meaning as with {Wx::OwnerDrawnComboBox#on_draw_item}. 
+    # </p>
+    # </div>
+    # @param dc [Wx::DC] 
+    # @param rect [Wx::Rect] 
+    # @param item [Integer] 
+    # @param flags [Integer] 
+    # @return [void]
+    def on_draw_background(dc, rect, item, flags) end
+    
+    # The derived class may implement this function to actually draw the item with the given index on the provided DC.
+    # 
+    # If function is not implemented, the item text is simply drawn, as if the control was a normal combobox.
+    # @param dc [Wx::DC]  The device context to use for drawing
+    # @param rect [Wx::Rect]  The bounding rectangle for the item being drawn (DC clipping region is set to this rectangle before calling this function)
+    # @param item [Integer]  The index of the item to be drawn
+    # @param flags [Integer]  A combination of the {Wx::OwnerDrawnComboBoxPaintingFlags} enumeration values.
+    # @return [void]
+    def on_draw_item(dc, rect, item, flags) end
+    
+    # The derived class may implement this method to return the height of the specified item (in pixels).
+    # 
+    # The default implementation returns text height, as if this control was a normal combobox.
+    # @param item [Integer] 
+    # @return [Integer]
+    def on_measure_item(item) end
+    
+    # The derived class may implement this method to return the width of the specified item (in pixels).
+    # 
+    # If -1 is returned, then the item text width is used.
+    # The default implementation returns -1.
+    # @param item [Integer] 
+    # @return [Integer]
+    def on_measure_item_width(item) end
+    
+  end # OwnerDrawnComboBox
+  
+
+end

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

@@ -0,0 +1,27 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A {Wx::PaintDC} must be constructed if an application wishes to paint on the client area of a window from within an EVT_PAINT() event handler.
+  # 
+  # This should normally be constructed as a temporary stack object; don't store a {Wx::PaintDC} object. If you have an EVT_PAINT() handler, you must create a {Wx::PaintDC} object within it even if you don't actually use it.
+  # Using {Wx::PaintDC} within your EVT_PAINT() handler is important because it automatically sets the clipping area to the damaged area of the window. Attempts to draw outside this area do not appear.
+  # A {Wx::PaintDC} 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 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class PaintDC < ClientDC
+  
+  end # PaintDC
+  
+
+end

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

@@ -0,0 +1,92 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # An empty palette.
+  # 
+  NULL_PALETTE = nil
+  
+  # A palette is a table that maps pixel values to RGB colours.
+  # 
+  # It allows the colours of a low-depth bitmap, for example, to be mapped to the available colours in a display. The notion of palettes is becoming more and more obsolete nowadays and only the MSW port is still using a native palette. All other ports use generic code which is basically just an array of colours.
+  # It is likely that in the future the only use for palettes within wxWidgets will be for representing colour indices from images (such as GIF or PNG). The image handlers for these formats have been modified to create a palette if there is such information in the original image file (usually 256 or less colour images). See {Wx::Image} for more information.
+  # 
+  # Category:  Graphics Device Interface (GDI)
+  # Predefined objects/pointers: {Wx::NULL_PALETTE}
+  # @see Wx::DC#set_palette
+  # @see  Wx::Bitmap 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  class Palette < GDIObject
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Wx::Palette]
+    # @overload initialize(palette)
+    #   Copy constructor, uses Reference Counting.
+    #   @param palette [Wx::Palette]  A reference to the palette to copy.
+    #   @return [Wx::Palette]
+    # @overload initialize(n, green, blue)
+    #   Creates a palette from arrays of size n, one for each red, blue or green component.
+    #   
+    #   
+    #   @see Wx::Palette#create 
+    #   @param n [Array<Integer>]  The number of indices in the palette.
+    #   @param green [Array<Integer>]  An array of green values.
+    #   @param blue [Array<Integer>]  An array of blue values.
+    #   @return [Wx::Palette]
+    def initialize(*args) end
+    
+    # Creates a palette from arrays of size n, one for each red, blue or green component.
+    # 
+    # true if the creation was successful, false otherwise.
+    # @see Wx::Palette#initialize 
+    # @param n [Array<Integer>]  The number of indices in the palette.
+    # @param green [Array<Integer>]  An array of green values.
+    # @param blue [Array<Integer>]  An array of blue values.
+    # @return [Boolean]
+    def create(n, green, blue) end
+    
+    # Returns number of entries in palette.
+    # @return [Integer]
+    def get_colours_count; end
+    alias_method :colours_count, :get_colours_count
+    
+    # Returns a pixel value (index into the palette) for the given RGB values.
+    # 
+    # The nearest palette index or {Wx::NOT_FOUND} for unexpected errors.
+    # @see Wx::Palette#get_rgb 
+    # @param red [Integer]  Red value.
+    # @param green [Integer]  Green value.
+    # @param blue [Integer]  Blue value.
+    # @return [Integer]
+    def get_pixel(red, green, blue) end
+    alias_method :pixel, :get_pixel
+    
+    # Returns RGB values for a given palette index.
+    # 
+    # true if the operation was successful.
+    # @see Wx::Palette#get_pixel 
+    # @param pixel [Integer]  The palette index.
+    # @param red [unsigned char]  Receives the red value.
+    # @param green [unsigned char]  Receives the green value.
+    # @param blue [unsigned char]  Receives the blue value.
+    # @return [Boolean]
+    def get_rgb(pixel, red, green, blue) end
+    alias_method :rgb, :get_rgb
+    
+    # Returns true if palette data is present.
+    # @return [Boolean]
+    def is_ok; end
+    alias_method :ok?, :is_ok
+    
+  end # Palette
+  
+
+end

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

@@ -0,0 +1,127 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # A panel is a window on which controls are placed.
+  # 
+  # It is usually placed within a frame. Its main feature over its parent class {Wx::Window} is code for handling child windows and TAB traversal, which is implemented natively if possible (e.g. in WXGTK) or by wxWidgets itself otherwise.
+  # 
+  # <div class="wxrb-note">
+  # <b>Note:</b>
+  # <p>if not all characters are being intercepted by your OnKeyDown or OnChar handler, it may be because you are using the {Wx::TAB_TRAVERSAL} style, which grabs some keypresses for use by child controls.
+  # </p>
+  # </div>
+  # 
+  # <div class="wxrb-remark">
+  # <b>Remark:</b>
+  # <p>By default, a panel has the same colouring as a dialog.
+  # </p>
+  # </div>
+  # 
+  # ### 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_navigation_key}(meth = nil, &block): Process a navigation key event. 
+  # 
+  # Category:  Miscellaneous Windows
+  # @see Wx::Dialog 
+  # 
+  # 
+  class Panel < Window
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Wx::Panel]
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::TAB_TRAVERSAL, name=Wx::PANEL_NAME_STR)
+    #   Constructor.
+    #   
+    #   
+    #   @see Wx::Panel#create 
+    #   @param parent [Wx::Window]  The parent window.
+    #   @param id [Integer]  An identifier for the panel. {Wx::StandardID::ID_ANY} is taken to mean a default.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  The panel position. The value {Wx::DEFAULT_POSITION} indicates a default position, chosen by either the windowing system or wxWidgets, depending on platform.
+    #   @param size [Array(Integer, Integer), Wx::Size]  The panel size. The value {Wx::DEFAULT_SIZE} indicates a default size, chosen by either the windowing system or wxWidgets, depending on platform.
+    #   @param style [Integer]  The window style. See {Wx::Panel}.
+    #   @param name [String]  Window name.
+    #   @return [Wx::Panel]
+    # @overload initialize(parent, id=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::TAB_TRAVERSAL, name=Wx::PANEL_NAME_STR, &block)
+    #   Constructor.
+    #   
+    #   
+    #   @see Wx::Panel#create 
+    #   @param parent [Wx::Window]  The parent window.
+    #   @param id [Integer]  An identifier for the panel. {Wx::StandardID::ID_ANY} is taken to mean a default.
+    #   @param pos [Array(Integer, Integer), Wx::Point]  The panel position. The value {Wx::DEFAULT_POSITION} indicates a default position, chosen by either the windowing system or wxWidgets, depending on platform.
+    #   @param size [Array(Integer, Integer), Wx::Size]  The panel size. The value {Wx::DEFAULT_SIZE} indicates a default size, chosen by either the windowing system or wxWidgets, depending on platform.
+    #   @param style [Integer]  The window style. See {Wx::Panel}.
+    #   @param name [String]  Window name.
+    #   @yieldparam [Wx::Panel] win new instance
+    #   @return [Wx::Panel]
+    def initialize(*args) end
+    
+    # This method is overridden from {Wx::Window#accepts_focus} and returns true only if there is no child window in the panel which can accept the focus.
+    # 
+    # This is reevaluated each time a child window is added or removed from the panel.
+    # @return [Boolean]
+    def accepts_focus; end
+    
+    # Used for two-step panel construction.
+    # 
+    # See {Wx::Panel#initialize} for details.
+    # @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=Wx::StandardID::ID_ANY, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::TAB_TRAVERSAL, name=Wx::PANEL_NAME_STR) end
+    
+    # Sends a {Wx::InitDialogEvent}, which in turn transfers data to the dialog via validators.
+    # 
+    # 
+    # @see Wx::InitDialogEvent 
+    # @return [void]
+    def init_dialog; end
+    
+    # See {Wx::Window#set_auto_layout}: when auto layout is on, this function gets called automatically when the window is resized.
+    # @return [Boolean]
+    def layout; end
+    
+    # The default handler for {Wx::EVT_SYS_COLOUR_CHANGED}.
+    # 
+    # <div class="wxrb-remark">
+    # <b>Remark:</b>
+    # <p>Changes the panel's colour to conform to the current settings. Add an event table entry for your panel class if you wish the behaviour to be different (such as keeping a user-defined background colour). If you do override this function, call {Wx::Event#skip} to propagate the notification to child windows and controls.
+    # </p>
+    # </div>
+    # @see Wx::SysColourChangedEvent 
+    # @param event [Wx::SysColourChangedEvent]  The colour change event.
+    # @return [void]
+    def on_sys_colour_changed(event) end
+    
+    # Overrides {Wx::Window#set_focus}.
+    # 
+    # This method uses the (undocumented) mix-in class {Wx::ControlContainer} which manages the focus and TAB logic for controls which usually have child controls.
+    # In practice, if you call this method and the control has at least one child window, the focus will be given to the child window.
+    # @see Wx::FocusEvent
+    # @see  Wx::Window#set_focus 
+    # @return [void]
+    def set_focus; end
+    
+    # In contrast to {Wx::Panel#set_focus} (see above) this will set the focus to the panel even if there are child windows in the panel.
+    # 
+    # This is only rarely needed.
+    # @return [void]
+    def set_focus_ignoring_children; end
+    
+  end # Panel
+  
+
+end