<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE erlref SYSTEM "erlref.dtd">

<!-- THIS FILE IS GENERATED DO NOT EDIT -->


<erlref>
<header>
  <copyright>
    <year>2020</year>
    <holder>Ericsson AB. All Rights Reserved.</holder></copyright>
  <legalnotice>
      Licensed under the Apache License, Version 2.0 (the "License");
      you may not use this file except in compliance with the License.
      You may obtain a copy of the License at

          http://www.apache.org/licenses/LICENSE-2.0

      Unless required by applicable law or agreed to in writing, software
      distributed under the License is distributed on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
      See the License for the specific language governing permissions and
      limitations under the License.

  </legalnotice>
  <title>wxColourData</title>
</header>
<module>wxColourData</module>
<modulesummary>Functions for wxColourData class</modulesummary>
<description><p>This class holds a variety of information related to colour dialogs.
      </p><p>See: <seetype marker="wx#wx_colour"><c>wx_color()</c></seetype>, <seeerl marker="wxColourDialog"><c>wxColourDialog</c></seeerl>, <url href="https://docs.wxwidgets.org/3.1/overview_cmndlg.html#overview_cmndlg_colour">Overview cmndlg</url>
      </p>
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_colour_data.html">wxColourData</url></p>
  </description>
<datatypes><datatype><name name="wxColourData"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary>Constructor. </fsummary>
    <desc><p>Constructor. 
      </p><p>Initializes the custom colours to <c>wxNullColour</c>, the <c>data</c> colour setting to black, and the <c>choose</c> full setting to true. 
      </p></desc>
  </func>
  
  <func>
    <name name="destroy" arity="1" clause_i="1" since=""/>
    <fsummary>Destructor. </fsummary>
    <desc><p>Destructor. 
      </p></desc>
  </func>
  
  <func>
    <name name="getChooseFull" arity="1" clause_i="1" since=""/>
    <fsummary>Under Windows, determines whether the Windows colour dialog will display the full dialog with custom colour selection controls. </fsummary>
    <desc><p>Under Windows, determines whether the Windows colour dialog will display the full dialog with custom colour selection controls. 
      </p><p>Has no meaning under other platforms.
      </p><p>The default value is true. 
      </p></desc>
  </func>
  
  <func>
    <name name="getColour" arity="1" clause_i="1" since=""/>
    <fsummary>Gets the current colour associated with the colour dialog. </fsummary>
    <desc><p>Gets the current colour associated with the colour dialog. 
      </p><p>The default colour is black. 
      </p></desc>
  </func>
  
  <func>
    <name name="getCustomColour" arity="2" clause_i="1" since=""/>
    <fsummary>Returns custom colours associated with the colour dialog. </fsummary>
    <desc><p>Returns custom colours associated with the colour dialog. 
      </p></desc>
  </func>
  
  <func>
    <name name="setChooseFull" arity="2" clause_i="1" since=""/>
    <fsummary>Under Windows, tells the Windows colour dialog to display the full dialog with custom colour selection controls. </fsummary>
    <desc><p>Under Windows, tells the Windows colour dialog to display the full dialog with custom colour selection controls. 
      </p><p>Under other platforms, has no effect.
      </p><p>The default value is true. 
      </p></desc>
  </func>
  
  <func>
    <name name="setColour" arity="2" clause_i="1" since=""/>
    <fsummary>Sets the default colour for the colour dialog. </fsummary>
    <desc><p>Sets the default colour for the colour dialog. 
      </p><p>The default colour is black. 
      </p></desc>
  </func>
  
  <func>
    <name name="setCustomColour" arity="3" clause_i="1" since=""/>
    <fsummary>Sets custom colours for the colour dialog. </fsummary>
    <desc><p>Sets custom colours for the colour dialog. 
      </p></desc>
  </func>
  </funcs>
</erlref>
