wxruby3 0.9.0.pre.beta.8-x64-mingw-ucrt

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

@@ -0,0 +1,120 @@
+# :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 = 10189
+  
+  # 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 parent for the controls which must go in the pane, <b>not</b> the {Wx::CollapsiblePane} itself!).
+  # Note that because of its nature of control which can dynamically (and drastically) change its size at run-time under user-input, when putting {Wx::CollapsiblePane} inside a {Wx::Sizer} you should be careful to add it with a proportion value of zero; this is because otherwise all other windows with non-null proportion values will automatically resize each time the user expands or collapse the pane window usually resulting in a weird, flickering effect.
+  # Usage sample:
+  # 
+  #   wxCollapsiblePane *collpane = new wxCollapsiblePane(this, wxID_ANY, "Details:");
+  #   
+  #   // add the pane with a zero proportion value to the 'sz' sizer which contains it
+  #   sz->Add(collpane, 0, wxGROW|wxALL, 5);
+  #   
+  #   // now add a test label in the collapsible pane using a sizer to layout it:
+  #   wxWindow *win = collpane->GetPane();
+  #   wxSizer *paneSz = new wxBoxSizer(wxVERTICAL);
+  #   paneSz->Add(new wxStaticText(win, wxID_ANY, "test!"), 1, wxGROW|wxALL, 2);
+  #   win->SetSizer(paneSz);
+  #   paneSz->SetSizeHints(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> {Wx::MSW} Appearance
+  #   </td><td> {Wx::GTK} Appearance
+  #   </td><td> {Wx::OSX} Appearance
+  #   </td></tr></table></div>
+  # @see Wx::Panel
+  # @see  Wx::CollapsiblePaneEvent 
+  # 
+  # 
+  class CollapsiblePane < Control
+  
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [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 [CollapsiblePane]
+    def initialize(*args) end
+    
+    # 
+    # true if the control was successfully created or false if creation failed.
+    # @param parent [Wx::Window]  Parent window, must not 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 [true,false]
+    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 [true,false] 
+    # @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 [true,false]
+    def is_collapsed; end
+    alias_method :collapsed?, :is_collapsed
+    
+    # Returns true if the pane window is currently shown.
+    # @return [true,false]
+    def is_expanded; end
+    alias_method :expanded?, :is_expanded
+    
+  end # CollapsiblePane
+  
+
+end

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

@@ -0,0 +1,45 @@
+# :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 
+  # 
+  # 
+  class CollapsiblePaneEvent < CommandEvent
+  
+    # The constructor is not normally used by the user code.
+    # @param generator [Wx::Object] 
+    # @param id [Integer] 
+    # @param collapsed [true,false] 
+    # @return [CollapsiblePaneEvent]
+    def initialize(generator, id, collapsed) end
+    
+    # Returns true if the pane has been collapsed.
+    # @return [true,false]
+    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 [true,false] 
+    # @return [void]
+    def set_collapsed(collapsed) end
+    alias_method :collapsed=, :set_collapsed
+    
+  end # CollapsiblePaneEvent
+  
+
+end

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

@@ -0,0 +1,289 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  # 
+  C2S_NAME = 1
+  
+  # 
+  # 
+  C2S_CSS_SYNTAX = 2
+  
+  # 
+  # 
+  C2S_HTML_SYNTAX = 4
+  
+  # 
+  # 
+  ALPHA_TRANSPARENT = 0
+  
+  # 
+  # 
+  ALPHA_OPAQUE = 255
+  
+  # 
+  # 
+  NULL_COLOUR = nil
+  
+  # Converts string to a {Wx::Colour} best represented by the given string.
+  # Returns true on success.
+  # 
+  # Include file: #include <wx/colour.h>
+  # @see wxToString(const wxColour&)
+  # @param string [String] 
+  # @param colour [Wx::Colour] 
+  # @return [true,false]
+  def self.from_string(string, colour) end
+  
+  # Converts the given {Wx::Colour} into a string.
+  # Include file: #include <wx/colour.h>
+  # @see wxFromString(const wxString&
+  # @see  wxColour*)
+  # @param colour [Wx::Colour,String,Symbol] 
+  # @return [String]
+  def self.to_string(colour) end
+  
+  # A colour is an object representing a combination of Red, Green, and Blue (RGB) intensity values and an Alpha value, and is used to determine drawing colours.
+  # See the entry for {Wx::ColourDatabase} for how a pointer to a predefined, named colour may be returned instead of creating a new colour.
+  # Valid RGB values are in the range 0 to 255.
+  # You can retrieve the current system colour settings with {Wx::SystemSettings}.
+  # 
+  # == Channel Accessor Functions
+  # 
+  # Note that this class provides pairs of functions for each of the colour channels, i.e. red, green, blue and alpha values. The one word functions {Wx::Colour#red}, {Wx::Colour#green}, {Wx::Colour#blue} and {Wx::Colour#alpha} return the values of type unsigned char, while {Wx::Colour#get_red}, {Wx::Colour#get_green}, {Wx::Colour#get_blue} and {Wx::Colour#get_alpha} returns the same value as unsigned int. According to the C++ integer promotion rules, the result of any arithmetic expression involving the former will be (signed) int, while that of the latter will be unsigned, which is what would be commonly expected, so the latter family of functions should be typically preferred (but they are only available since wxWidgets 3.1.6).
+  # === 
+  # 
+  # Category:  Graphics Device Interface (GDI)
+  # Predefined objects/pointers:
+  # - {Wx::NULL_COLOUR} - An empty, invalid colour.- {Wx::TransparentColour} - Valid but fully transparent colour (new in 2.9.1).- {Wx::BLACK}- {Wx::BLUE}- {Wx::CYAN}- {Wx::GREEN}- {Wx::YELLOW}- {Wx::LIGHT_GREY}- {Wx::RED}- {Wx::WHITE}
+  # @see Wx::ColourDatabase
+  # @see  Wx::Pen
+  # @see  Wx::Brush
+  # @see  Wx::ColourDialog
+  # @see  Wx::SystemSettings 
+  # 
+  # 
+  class Colour < Object
+  
+    # Sets the RGB or RGBA colour values from a single 32 bit value.
+    # The arguments colRGB and colRGBA should be of the form 0x00BBGGRR and 0xAABBGGRR respectively where 0xRR, 0xGG, 0xBB and 0xAA are the values of the red, green, blue and alpha components.
+    # Notice the right-to-left order of components!
+    # @see Wx::Colour#get_rgb
+    # @see  Wx::Colour#get_rgba
+    # @param colRGB [Integer] 
+    # @return [void]
+    def set_rgb(colRGB) end
+    alias_method :rgb=, :set_rgb
+    
+    # Sets the RGB or RGBA colour values from a single 32 bit value.
+    # The arguments colRGB and colRGBA should be of the form 0x00BBGGRR and 0xAABBGGRR respectively where 0xRR, 0xGG, 0xBB and 0xAA are the values of the red, green, blue and alpha components.
+    # Notice the right-to-left order of components!
+    # @see Wx::Colour#get_rgb
+    # @see  Wx::Colour#get_rgba
+    # @param colRGBA [Integer] 
+    # @return [void]
+    def set_rgba(colRGBA) end
+    alias_method :rgba=, :set_rgba
+    
+    # Gets the RGB or RGBA colour values as a single 32 bit value.
+    # The returned value is of the same form as expected by {Wx::Colour#set_rgb} and {Wx::Colour#set_rgba}.
+    # Notice that {Wx::Colour#get_rgb} returns the value with 0 as its highest byte independently of the value actually returned by {Wx::Colour#alpha}. So for a fully opaque colour, the return value of {Wx::Colour#get_rgba} is 0xFFBBGGRR while that of {Wx::Colour#get_rgb} is 0x00BBGGRR.
+    # @return [Integer]
+    def get_rgb; end
+    alias_method :rgb, :get_rgb
+    
+    # Gets the RGB or RGBA colour values as a single 32 bit value.
+    # The returned value is of the same form as expected by {Wx::Colour#set_rgb} and {Wx::Colour#set_rgba}.
+    # Notice that {Wx::Colour#get_rgb} returns the value with 0 as its highest byte independently of the value actually returned by {Wx::Colour#alpha}. So for a fully opaque colour, the return value of {Wx::Colour#get_rgba} is 0xFFBBGGRR while that of {Wx::Colour#get_rgb} is 0x00BBGGRR.
+    # @return [Integer]
+    def get_rgba; end
+    alias_method :rgba, :get_rgba
+    
+    # @overload set(red, green, blue, alpha=Wx::ALPHA_OPAQUE)
+    #   Sets the RGB intensity values using the given values (first overload), extracting them from the packed long (second overload), using the given string (third overload).
+    #   When using third form, {Wx::Colour#set} accepts: colour names (those listed in {Wx::ColourDatabase}), the CSS-like <code>"rgb(r,g,b)"</code> or <code>"rgba(r,g,b,a)"</code> syntax (case insensitive) and the HTML-like syntax: <code>"#"</code> followed by 6 hexadecimal digits for red, green, blue components.
+    #   Returns true if the conversion was successful, false otherwise.
+    #   @param red [Integer] 
+    #   @param green [Integer] 
+    #   @param blue [Integer] 
+    #   @param alpha [Integer] 
+    #   @return [void]
+    # @overload set(RGB)
+    #   Sets the RGB intensity values using the given values (first overload), extracting them from the packed long (second overload), using the given string (third overload).
+    #   When using third form, {Wx::Colour#set} accepts: colour names (those listed in {Wx::ColourDatabase}), the CSS-like <code>"rgb(r,g,b)"</code> or <code>"rgba(r,g,b,a)"</code> syntax (case insensitive) and the HTML-like syntax: <code>"#"</code> followed by 6 hexadecimal digits for red, green, blue components.
+    #   Returns true if the conversion was successful, false otherwise.
+    #   @param RGB [Integer] 
+    #   @return [void]
+    # @overload set(str)
+    #   Sets the RGB intensity values using the given values (first overload), extracting them from the packed long (second overload), using the given string (third overload).
+    #   When using third form, {Wx::Colour#set} accepts: colour names (those listed in {Wx::ColourDatabase}), the CSS-like <code>"rgb(r,g,b)"</code> or <code>"rgba(r,g,b,a)"</code> syntax (case insensitive) and the HTML-like syntax: <code>"#"</code> followed by 6 hexadecimal digits for red, green, blue components.
+    #   Returns true if the conversion was successful, false otherwise.
+    #   @param str [String] 
+    #   @return [true,false]
+    def set(*args) end
+    
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Colour]
+    # @overload initialize(red, green, blue, alpha=Wx::ALPHA_OPAQUE)
+    #   @param red [Integer]  The red value.
+    #   @param green [Integer]  The green value.
+    #   @param blue [Integer]  The blue value.
+    #   @param alpha [Integer]  The alpha value. Alpha values range from 0 ({Wx::ALPHA_TRANSPARENT}) to 255 ({Wx::ALPHA_OPAQUE}).
+    #   @return [Colour]
+    # @overload initialize(colourName)
+    #   @param colourName [String]  The colour name.
+    #   @return [Colour]
+    # @overload initialize(colRGB)
+    #   @param colRGB [Integer]  A packed RGB value.
+    #   @return [Colour]
+    # @overload initialize(colour)
+    #   Copy constructor.
+    #   @param colour [Wx::Colour,String,Symbol] 
+    #   @return [Colour]
+    def initialize(*args) end
+    
+    # Returns the alpha value, on platforms where alpha is not yet supported, this always returns {Wx::ALPHA_OPAQUE}.
+    # 
+    # @see Wx::Colour#get_alpha 
+    # @return [Integer]
+    def alpha; end
+    
+    # Returns the blue intensity.
+    # 
+    # @see Wx::Colour#get_blue 
+    # @return [Integer]
+    def blue; end
+    
+    # Returns the alpha value, on platforms where alpha is not yet supported, this always returns {Wx::ALPHA_OPAQUE}.
+    # @return [Integer]
+    def get_alpha; end
+    
+    # Returns the blue intensity as unsigned int.
+    # @return [Integer]
+    def get_blue; end
+    
+    # Returns the green intensity as unsigned int.
+    # @return [Integer]
+    def get_green; end
+    
+    # Returns the red intensity as unsigned int.
+    # @return [Integer]
+    def get_red; end
+    
+    # Converts this colour to a {Wx::String} using the given flags.
+    # The supported flags are {Wx::C2S_NAME}, to obtain the colour name (e.g. {colour(255,0,0)} == "red"), {Wx::C2S_CSS_SYNTAX}, to obtain the colour in the "rgb(r,g,b)" or "rgba(r,g,b,a)" syntax (e.g. {colour(255,0,0,85)} == "rgba(255,0,0,0.333)"), and {Wx::C2S_HTML_SYNTAX}, to obtain the colour as "#" followed by 6 hexadecimal digits (e.g. {colour(255,0,0)} == "#FF0000").
+    # This function returns empty string if the colour is not initialized (see {Wx::Colour#is_ok}). Otherwise, the returned string is always non-empty, but the function asserts if the colour has alpha channel (i.e. is non opaque) but {Wx::C2S_CSS_SYNTAX} (which is the only one supporting alpha) is not specified in flags.
+    # For non-solid (i.e. non-RGB) colour this function returns "rgb(??, ?? ??)" or "#??????".
+    # @param flags [Integer] 
+    # @return [String]
+    def get_as_string(flags=(wxC2S_NAME|wxC2S_CSS_SYNTAX)) end
+    alias_method :as_string, :get_as_string
+    
+    # Return the perceived brightness of the colour.
+    # This value is computed using the simple 
+    # 
+    #   0.299*R + 0.587*G + 0.114*B 
+    #  formula with the coefficients taken from the RGB to YIQ conversion formula and R, G and B being the values of the corresponding colour channels normalized to 0..1 range, so that the return value is 0 for black and 1 for white.
+    # @return [Float]
+    def get_luminance; end
+    alias_method :luminance, :get_luminance
+    
+    # Returns the green intensity.
+    # 
+    # @see Wx::Colour#get_green 
+    # @return [Integer]
+    def green; end
+    
+    # Returns true if the colour object is valid (the colour has been initialised with RGB values).
+    # @return [true,false]
+    def is_ok; end
+    alias_method :ok?, :is_ok
+    
+    # Returns the red intensity.
+    # 
+    # @see Wx::Colour#get_red 
+    # @return [Integer]
+    def red; end
+    
+    # Returns true if the color can be described using RGB values, i.e.
+    # is solid, false if it is a pattern (currently only possible on macOS)
+    # @return [true,false]
+    def is_solid; end
+    alias_method :solid?, :is_solid
+    
+    # Tests the equality of two colours by comparing individual red, green, blue intensities and alpha values.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [true,false]
+    def ==(colour) end
+    
+    # Make a disabled version of this colour.
+    # This method modifies the object in place and returns the object itself.
+    # @param brightness [Integer] 
+    # @return [Wx::Colour]
+    def make_disabled(brightness=255) end
+    
+    # Create a disabled (dimmed) colour from (in/out) rgb parameters.
+    # @param r [unsigned char] 
+    # @param g [unsigned char] 
+    # @param b [unsigned char] 
+    # @param brightness [Integer] 
+    # @return [void]
+    def self.make_disabled(r, g, b, brightness=255) end
+    
+    # {Wx::Colour} wrapper for ChangeLightness(r,g,b,ialpha).
+    # @param ialpha [Integer] 
+    # @return [Wx::Colour]
+    def change_lightness(ialpha) end
+    
+    # Utility function that simply darkens or lightens a color, based on the specified percentage ialpha.
+    # ialpha of 0 would be make the color completely black, 200 completely white and 100 would not change the color.
+    # @param r [unsigned char] 
+    # @param g [unsigned char] 
+    # @param b [unsigned char] 
+    # @param ialpha [Integer] 
+    # @return [void]
+    def self.change_lightness(r, g, b, ialpha) end
+    
+    # Assigns the same value to r, g, b: 0 if on is false, 255 otherwise.
+    # @param r [unsigned char] 
+    # @param g [unsigned char] 
+    # @param b [unsigned char] 
+    # @param on [true,false] 
+    # @return [void]
+    def self.create_mono(r, g, b, on) end
+    
+    # @overload self.create_grey(r, g, b)
+    #   Create a grey colour from (in/out) rgb parameters using integer arithmetic.
+    #   @param r [unsigned char] 
+    #   @param g [unsigned char] 
+    #   @param b [unsigned char] 
+    #   @return [void]
+    # @overload self.create_grey(r, g, b, weight_r, weight_g, weight_b)
+    #   Create a grey colour from (in/out) rgb parameters using floating point arithmetic.
+    #   Defaults to using the standard ITU-T BT.601 when converting to YUV, where every pixel equals (R * weight_r) + (G * weight_g) + (B * weight_b).
+    #   @param r [unsigned char] 
+    #   @param g [unsigned char] 
+    #   @param b [unsigned char] 
+    #   @param weight_r [Float] 
+    #   @param weight_g [Float] 
+    #   @param weight_b [Float] 
+    #   @return [void]
+    def self.create_grey(*args) end
+    
+    # Blend colour, taking alpha into account.
+    # @param fg [Integer] 
+    # @param bg [Integer] 
+    # @param alpha [Float] 
+    # @return [Integer]
+    def self.alpha_blend(fg, bg, alpha) end
+    
+  end # Colour
+  
+
+end

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

@@ -0,0 +1,96 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This class holds a variety of information related to colour dialogs.
+  # === 
+  # 
+  # Category:  Common Dialogs, Data Structures
+  # @see Wx::Colour
+  # @see  Wx::ColourDialog
+  # @see  wxColourDialog Overview 
+  # 
+  # 
+  class ColourData < Object
+  
+    # 
+    # 
+    NUM_CUSTOM = 16
+    
+    # Constructor.
+    # Initializes the custom colours to {Wx::NULL_COLOUR}, the data colour setting to black, and the choose full setting to true.
+    # @return [ColourData]
+    def initialize; end
+    
+    # Under Windows, determines whether the Windows colour dialog will display the full dialog with custom colour selection controls.
+    # Has no meaning under other platforms.
+    # The default value is true.
+    # @return [true,false]
+    def get_choose_full; end
+    alias_method :choose_full, :get_choose_full
+    
+    # Indicates whether the colour dialog will display alpha values and an opacity selector.
+    # It is meaningful under {Wx::GTK}, {Wx::OSX} and with regards to generic colour dialog.
+    # The default value is false, except {Wx::OSX} where it is true (for the sake of backward compatibility).
+    # @return [true,false]
+    def get_choose_alpha; end
+    alias_method :choose_alpha, :get_choose_alpha
+    
+    # Gets the current colour associated with the colour dialog.
+    # The default colour is black.
+    # @return [Wx::Colour]
+    def get_colour; end
+    alias_method :colour, :get_colour
+    
+    # Returns custom colours associated with the colour dialog.
+    # @param i [Integer]  An integer between 0 and 15, being any of the 15 custom colours that the user has saved. The default custom colours are invalid colours.
+    # @return [Wx::Colour]
+    def get_custom_colour(i) end
+    alias_method :custom_colour, :get_custom_colour
+    
+    # Under Windows, tells the Windows colour dialog to display the full dialog with custom colour selection controls.
+    # Under other platforms, has no effect.
+    # The default value is true.
+    # @param flag [true,false] 
+    # @return [void]
+    def set_choose_full(flag) end
+    alias_method :choose_full=, :set_choose_full
+    
+    # Tells the colour dialog to show alpha values and an opacity selector (slider).
+    # Currently it has effect under {Wx::GTK}, {Wx::OSX} and for generic colour dialog.
+    # The default value is false, except {Wx::OSX} where it is true for backward compatibility.
+    # @param flag [true,false] 
+    # @return [void]
+    def set_choose_alpha(flag) end
+    alias_method :choose_alpha=, :set_choose_alpha
+    
+    # Sets the default colour for the colour dialog.
+    # The default colour is black.
+    # @param colour [Wx::Colour,String,Symbol] 
+    # @return [void]
+    def set_colour(colour) end
+    alias_method :colour=, :set_colour
+    
+    # Sets custom colours for the colour dialog.
+    # @param i [Integer]  An integer between 0 and 15 for whatever custom colour you want to set. The default custom colours are invalid colours.
+    # @param colour [Wx::Colour,String,Symbol]  The colour to set
+    # @return [void]
+    def set_custom_colour(i, colour) end
+    
+    # Converts the colours saved in this class in a string form, separating the various colours with a comma.
+    # @return [String]
+    def to_string; end
+    
+    # Decodes the given string, which should be in the same format returned by {Wx::ColourData#to_string}, and sets the internal colours.
+    # @param str [String] 
+    # @return [true,false]
+    def from_string(str) end
+    
+  end # ColourData
+  
+
+end

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

@@ -0,0 +1,84 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  # 
+  EVT_COLOUR_CHANGED = 10183
+  
+  # Shows the colour selection dialog and returns the colour selected by user or invalid colour (use {Wx::Colour#is_ok} to test whether a colour is valid) if the dialog was cancelled.
+  # Include file: #include <wx/colordlg.h>
+  # @param parent [Wx::Window]  The parent window for the colour selection dialog.
+  # @param colInit [Wx::Colour,String,Symbol]  If given, this will be the colour initially selected in the dialog.
+  # @param caption [String]  If given, this will be used for the dialog caption.
+  # @param data [Wx::ColourData]  Optional object storing additional colour dialog settings, such as custom colours. If none is provided the same settings as the last time are used.
+  # @return [Wx::Colour]
+  def self.get_colour_from_user(parent, colInit, caption=Wx::EMPTY_STRING, data=nil) end
+  
+  # This class represents the colour chooser dialog.
+  # Starting from wxWidgets 3.1.3 and currently in the MSW port only, this dialog generates {Wx::EVT_COLOUR_CHANGED} events while it is being shown, i.e. from inside its {Wx::ColourDialog#show_modal} method, that notify the program about the change of the currently selected colour and allow it to e.g. preview the effect of selecting this colour. Note that if you react to this event, you should also correctly revert to the previously selected colour if the dialog is cancelled by the user.
+  # Example of using this class with dynamic feedback for the selected colour: 
+  # 
+  #   // Some function for redrawing using the given colour. Ideally, it
+  #   // shouldn't do anything if the colour is the same as the one used
+  #   // before.
+  #   void Redraw(const wxColour& colour);
+  #   
+  #   wxColourData data;
+  #   data.SetColour(initialColourToUse);
+  #   wxColourData dlg(this, &data);
+  #   dlg.Bind(wxEVT_COLOUR_CHANGED, [](wxColourDialogEvent& event) {
+  #               Redraw(event.GetColour());
+  #            });
+  #   if ( dlg.ShowModal() == wxID_OK ) {
+  #       // Colour did change.
+  #   } else {
+  #       // Colour didn't change.
+  #   }
+  #   
+  #   // This call is unnecessary under platforms generating
+  #   // wxEVT_COLOUR_CHANGED if the dialog was accepted and unnecessary
+  #   // under the platforms not generating this event if it was cancelled,
+  #   // so we could check for the different cases explicitly to avoid it,
+  #   // but it's simpler to just always call it.
+  #   Redraw(data.GetColour());
+  # 
+  # === 
+  # 
+  # Category:  Common Dialogs
+  # @see wxColourDialog Overview
+  # @see  Wx::Colour
+  # @see  Wx::ColourData
+  # @see  Wx::ColourDialogEvent
+  # @see  get_colour_from_user 
+  # 
+  # 
+  class ColourDialog < Dialog
+  
+    # Constructor.
+    # Pass a parent window, and optionally a pointer to a block of colour data, which will be copied to the colour dialog's colour data.
+    # Custom colours from colour data object will be used in the dialog's colour palette. Invalid entries in custom colours list will be ignored on some platforms(GTK) or replaced with white colour on platforms where custom colours palette has fixed size (MSW).
+    # @see Wx::ColourData 
+    # @param parent [Wx::Window] 
+    # @param data [Wx::ColourData] 
+    # @return [ColourDialog]
+    def initialize(parent, data=nil) end
+    
+    # Same as {colour_dialog}.
+    # @param parent [Wx::Window] 
+    # @param data [Wx::ColourData] 
+    # @return [true,false]
+    def create(parent, data=nil) end
+    
+    # Shows the dialog, returning {Wx::StandardID::ID_OK} if the user pressed OK, and {Wx::StandardID::ID_CANCEL} otherwise.
+    # @return [Integer]
+    def show_modal; end
+    
+  end # ColourDialog
+  
+
+end