# :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