wxruby3 1.6.1 → 1.7.0

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

@@ -0,0 +1,333 @@
+# :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.
+  # @see wxToString(const wxColour&)
+  # @param string [String] 
+  # @param colour [Wx::Colour] 
+  # @return [Boolean]
+  def self.from_string(string, colour) end
+  
+  # Converts the given {Wx::Colour} into a string.
+  # 
+  # 
+  # @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::TRANSPARENT_COLOUR} - 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 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  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 [Boolean]
+    def set(*args) end
+    
+    # @overload initialize()
+    #   Default constructor.
+    #   @return [Wx::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 [Wx::Colour]
+    # @overload initialize(colourName)
+    #   @param colourName [String]  The colour name.
+    #   @return [Wx::Colour]
+    # @overload initialize(colRGB)
+    #   @param colRGB [Integer]  A packed RGB value.
+    #   @return [Wx::Colour]
+    # @overload initialize(colour)
+    #   Copy constructor.
+    #   @param colour [Wx::Colour,String,Symbol] 
+    #   @return [Wx::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.
+    # 
+    # <div class="wxrb-note">
+    # <b>Note:</b>
+    # <p>For non-solid (i.e. non-RGB) colour this function returns "rgb(??, ?? ??)" or "#??????".
+    # </p>
+    # </div>
+    # @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 [Boolean]
+    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 [Boolean]
+    def is_solid; end
+    alias_method :solid?, :is_solid
+    
+    # Returns true if the color is completely transparent (i.e., no opacity).
+    # @return [Boolean]
+    def is_transparent; end
+    alias_method :transparent?, :is_transparent
+    
+    # Returns true if the color is completely opaque (i.e., full opacity).
+    # @return [Boolean]
+    def is_opaque; end
+    alias_method :opaque?, :is_opaque
+    
+    # Returns true if the color has some translucency (not fully opaque, but not transparent either).
+    # @return [Boolean]
+    def is_translucent; end
+    alias_method :translucent?, :is_translucent
+    
+    # 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 [Integer] 
+    # @param g [Integer] 
+    # @param b [Integer] 
+    # @param brightness [Integer] 
+    # @return [Array(Integer,Integer,Integer)]
+    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 [Integer] 
+    # @param g [Integer] 
+    # @param b [Integer] 
+    # @param ialpha [Integer] 
+    # @return [Array(Integer,Integer,Integer)]
+    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 [Integer] 
+    # @param g [Integer] 
+    # @param b [Integer] 
+    # @param on [Boolean] 
+    # @return [Array(Integer,Integer,Integer)]
+    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 [Integer] 
+    #   @param g [Integer] 
+    #   @param b [Integer] 
+    #   @return [Array(Integer,Integer,Integer)]
+    # @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 [Integer] 
+    #   @param g [Integer] 
+    #   @param b [Integer] 
+    #   @param weight_r [Float] 
+    #   @param weight_g [Float] 
+    #   @param weight_b [Float] 
+    #   @return [Array(Integer,Integer,Integer)]
+    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_dialog.rb

@@ -0,0 +1,190 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # 
+  # 
+  EVT_COLOUR_CHANGED = 10151
+  
+  # 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.
+  # @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=nil, colInit=Wx::NULL_COLOUR, caption=(''), 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: 
+  # ```ruby
+  #   # 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.
+  #   # def redraw(colour) ... end
+  # 
+  #   data = Wx::ColourData.new
+  #   data.set_colour(initialColourToUse)
+  #   Wx::ColourDialog(self, data) do |dlg|
+  #     dlg.evt_colour_changed { |event| redraw(event.get_colour) }
+  #     if dlg.show_modal == Wx::ID_OK
+  #        # Colour did change.
+  #     else
+  #        # Colour didn't change.
+  #     end
+  #   end
+  # 
+  #   # This call is unnecessary under platforms generating
+  #   # Wx::EVT_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.get_colour)
+  # ```
+  # 
+  # Category:  Common Dialogs
+  # @see wxColourDialog Overview
+  # @see  Wx::Colour
+  # @see  Wx::ColourData
+  # @see  Wx::ColourDialogEvent
+  # @see  get_colour_from_user 
+  # 
+  # 
+  # @wxrb_require USE_COLOURDLG
+  class ColourDialog < Dialog
+  
+    # @overload initialize(parent, data=nil)
+    #   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 [Wx::ColourDialog]
+    # @overload initialize(parent, data=nil, &block)
+    #   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] 
+    #   @yieldparam [Wx::ColourDialog] win new instance
+    #   @return [Wx::ColourDialog]
+    def initialize(*args) end
+    
+    # Same as {Wx::ColourDialog#initialize}.
+    # @param parent [Wx::Window] 
+    # @param data [Wx::ColourData] 
+    # @return [Boolean]
+    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
+  
+  # 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 
+  # 
+  # 
+  # 
+  # @note This class is <b>untracked</b> and should not be derived from nor instances extended!
+  # @wxrb_require USE_COLOURDLG
+  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 [Wx::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 [Boolean]
+    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 WXGTK, WXOSX and with regards to generic colour dialog.
+    # The default value is false, except WXOSX where it is true (for the sake of backward compatibility).
+    # @return [Boolean]
+    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 [Boolean] 
+    # @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 WXGTK, WXOSX and for generic colour dialog.
+    # The default value is false, except WXOSX where it is true for backward compatibility.
+    # @param flag [Boolean] 
+    # @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 [Boolean]
+    def from_string(str) end
+    
+  end # ColourData
+  
+
+end

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

@@ -0,0 +1,110 @@
+# :stopdoc:
+# This file is automatically generated by the WXRuby3 documentation 
+# generator. Do not alter this file.
+# :startdoc:
+
+
+module Wx
+
+  # This control allows the user to select a colour.
+  # 
+  # The generic implementation is a button which brings up a {Wx::ColourDialog} when clicked. Native implementation may differ but this is usually a (small) widget which give access to the colour-chooser dialog. It is only available if {Wx::Setup::USE_COLOURPICKERCTRL} is set to 1 (the default).
+  # ### Styles
+  # 
+  # This class supports the following styles:
+  # 
+  # - {Wx::CLRP_DEFAULT_STYLE}: The default style: 0. 
+  # 
+  # - {Wx::CLRP_USE_TEXTCTRL}: Creates a text control to the left of the picker button which is completely managed by the {Wx::ColourPickerCtrl} and which can be used by the user to specify a colour (see SetColour). The text control is automatically synchronized with button's value. Use functions defined in {Wx::PickerBase} to modify the text control. 
+  # 
+  # - {Wx::CLRP_SHOW_LABEL}: Shows the colour in HTML form (AABBCC) as colour button label (instead of no label at all). 
+  # 
+  # - {Wx::CLRP_SHOW_ALPHA}: Allows selecting opacity in the colour-chooser (effective under WXGTK and WXOSX). 
+  # 
+  # ### Events emitted by this class
+  # 
+  # The following event-handler methods redirect the events to member method or handler blocks for {Wx::ColourPickerEvent} events.
+  # Event handler methods for events emitted by this class:
+  # 
+  # - {Wx::EvtHandler#evt_colourpicker_changed}(id, meth = nil, &block): The user changed the colour selected in the control either using the button or using text control (see {Wx::CLRP_USE_TEXTCTRL}; note that in this case the event is fired only if the user's input is valid, i.e. recognizable). When using a popup dialog for changing the colour, this event is sent only when the changes in the dialog are accepted by the user, unlike EVT_COLOURPICKER_CURRENT_CHANGED. 
+  # 
+  # - {Wx::EvtHandler#evt_colourpicker_current_changed}(id, meth = nil, &block): The user changed the currently selected colour in the dialog associated with the control. This event is sent immediately when the selection changes and you must also handle EVT_COLOUR_CANCELLED to revert to the previously selected colour if the selection ends up not being accepted. This event is new since wxWidgets 3.1.3 and currently is only implemented in WXMSW. 
+  # 
+  # - {Wx::EvtHandler#evt_colourpicker_dialog_cancelled}(id, meth = nil, &block): The user cancelled the colour dialog associated with the control, i.e. closed it without accepting the selection. This event is new since wxWidgets 3.1.3 and currently is only implemented in WXMSW. 
+  # 
+  # Category:  Picker 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::ColourDialog
+  # @see  Wx::ColourPickerEvent 
+  # 
+  # 
+  # @wxrb_require USE_COLOURPICKERCTRL,USE_COLOURDLG
+  class ColourPickerCtrl < PickerBase
+  
+    # @overload set_colour(col)
+    #   Sets the currently selected colour.
+    #   
+    #   See {Wx::Colour#set}.
+    #   @param col [Wx::Colour,String,Symbol] 
+    #   @return [void]
+    # @overload set_colour(colname)
+    #   Sets the currently selected colour.
+    #   
+    #   See {Wx::Colour#set}.
+    #   @param colname [String] 
+    #   @return [void]
+    def set_colour(*args) end
+    alias_method :colour=, :set_colour
+    
+    # @overload initialize()
+    #   @return [Wx::ColourPickerCtrl]
+    # @overload initialize(parent, id, colour=Wx::BLACK, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::CLRP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COLOUR_PICKER_CTRL_NAME_STR)
+    #   Initializes the object and calls {Wx::ColourPickerCtrl#create} with all the parameters.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param colour [Wx::Colour,String,Symbol] 
+    #   @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::ColourPickerCtrl]
+    # @overload initialize(parent, id, colour=Wx::BLACK, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::CLRP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COLOUR_PICKER_CTRL_NAME_STR, &block)
+    #   Initializes the object and calls {Wx::ColourPickerCtrl#create} with all the parameters.
+    #   @param parent [Wx::Window] 
+    #   @param id [Integer] 
+    #   @param colour [Wx::Colour,String,Symbol] 
+    #   @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::ColourPickerCtrl] win new instance
+    #   @return [Wx::ColourPickerCtrl]
+    def initialize(*args) end
+    
+    # Creates a colour picker with the given arguments.
+    # 
+    # 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 colour [Wx::Colour,String,Symbol]  The initial colour shown in the control.
+    # @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::CRLP_}* 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, colour=Wx::BLACK, pos=Wx::DEFAULT_POSITION, size=Wx::DEFAULT_SIZE, style=Wx::CLRP_DEFAULT_STYLE, validator=Wx::DEFAULT_VALIDATOR, name=Wx::COLOUR_PICKER_CTRL_NAME_STR) end
+    
+    # Returns the currently selected colour.
+    # @return [Wx::Colour]
+    def get_colour; end
+    alias_method :colour, :get_colour
+    
+  end # ColourPickerCtrl
+  
+
+end