<?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>wxColourDialog</title>
</header>
<module>wxColourDialog</module>
<modulesummary>Functions for wxColourDialog class</modulesummary>
<description><p>This class represents the colour chooser dialog.
      </p><p>Starting from wxWidgets 3.1.3 and currently in the MSW port only, this dialog generates wxEVT_COLOUR_CHANGED events while it is being shown, i.e. from inside its <seemfa marker="wxDialog#showModal/1"><c>wxDialog:showModal/1</c></seemfa> 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.
      </p><p>Example of using this class with dynamic feedback for the selected colour: 
      </p><p>See: <url href="https://docs.wxwidgets.org/3.1/overview_cmndlg.html#overview_cmndlg_colour">Overview cmndlg</url>, <seetype marker="wx#wx_colour"><c>wx_color()</c></seetype>, <seeerl marker="wxColourData"><c>wxColourData</c></seeerl>, <c>wxColourDialogEvent</c> (not implemented in wx), ?wxGetColourFromUser()
      </p>
  <p>This class is derived (and can use functions) from: 
    <seeerl marker="wxDialog"><c>wxDialog</c></seeerl> <seeerl marker="wxTopLevelWindow"><c>wxTopLevelWindow</c></seeerl> <seeerl marker="wxWindow"><c>wxWindow</c></seeerl> <seeerl marker="wxEvtHandler"><c>wxEvtHandler</c></seeerl></p>
  
  <p>wxWidgets docs: <url href="https://docs.wxwidgets.org/3.1/classwx_colour_dialog.html">wxColourDialog</url></p>
  </description>
<datatypes><datatype><name name="wxColourDialog"/></datatype></datatypes>

<funcs>
  <func>
    <name name="new" arity="0" clause_i="1" since=""/>
    <fsummary/>
    <desc/>
  </func>
  
  <func>
    <name name="new" arity="1" clause_i="1" since=""/>
    <fsummary>See: <c>new/2</c></fsummary>
  </func>
  
  <func>
    <name name="new" arity="2" clause_i="1" since=""/>
    <fsummary>Constructor. </fsummary>
    <desc><p>Constructor. 
      </p><p>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.
      </p><p>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).
      </p><p>See: <seeerl marker="wxColourData"><c>wxColourData</c></seeerl>
      </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="create" arity="2" clause_i="1" since=""/>
    <fsummary>See: <c>create/3</c></fsummary>
  </func>
  
  <func>
    <name name="create" arity="3" clause_i="1" since=""/>
    <fsummary>Same as <c>new/2</c>. </fsummary>
    <desc><p>Same as <seemfa marker="#new/2"><c>new/2</c></seemfa>. 
      </p></desc>
  </func>
  
  <func>
    <name name="getColourData" arity="1" clause_i="1" since=""/>
    <fsummary>Returns the colour data associated with the colour dialog. </fsummary>
    <desc><p>Returns the colour data associated with the colour dialog. 
      </p></desc>
  </func>
  </funcs>
</erlref>
