1wxColourDialog(3)          Erlang Module Definition          wxColourDialog(3)
2
3
4

NAME

6       wxColourDialog - Functions for wxColourDialog class
7

DESCRIPTION

9       This class represents the colour chooser dialog.
10
11       Starting  from wxWidgets 3.1.3 and currently in the MSW port only, this
12       dialog generates wxEVT_COLOUR_CHANGED events while it is  being  shown,
13       i.e.  from inside its wxDialog:showModal/1 method, that notify the pro‐
14       gram about the change of the currently selected colour and allow it  to
15       e.g.  preview the effect of selecting this colour. Note that if you re‐
16       act to this event, you should also correctly revert to  the  previously
17       selected colour if the dialog is cancelled by the user.
18
19       Example  of  using  this  class  with dynamic feedback for the selected
20       colour:
21
22       See: Overview  cmndlg,  wx_color(),  wxColourData,  wxColourDialogEvent
23       (not implemented in wx), ?wxGetColourFromUser()
24
25       This  class  is  derived  (and  can use functions) from: wxDialog wxTo‐
26       pLevelWindow wxWindow wxEvtHandler
27
28       wxWidgets docs: wxColourDialog
29

DATA TYPES

31       wxColourDialog() = wx:wx_object()
32

EXPORTS

34       new() -> wxColourDialog()
35
36       new(Parent) -> wxColourDialog()
37
38              Types:
39
40                 Parent = wxWindow:wxWindow()
41
42       new(Parent, Options :: [Option]) -> wxColourDialog()
43
44              Types:
45
46                 Parent = wxWindow:wxWindow()
47                 Option = {data, wxColourData:wxColourData()}
48
49              Constructor.
50
51              Pass a parent window, and optionally a pointer  to  a  block  of
52              colour  data, which will be copied to the colour dialog's colour
53              data.
54
55              Custom colours from colour data object will be used in the  dia‐
56              log's  colour  palette.  Invalid  entries in custom colours list
57              will be ignored on some platforms(GTK) or  replaced  with  white
58              colour  on platforms where custom colours palette has fixed size
59              (MSW).
60
61              See: wxColourData
62
63       destroy(This :: wxColourDialog()) -> ok
64
65              Destructor.
66
67       create(This, Parent) -> boolean()
68
69              Types:
70
71                 This = wxColourDialog()
72                 Parent = wxWindow:wxWindow()
73
74       create(This, Parent, Options :: [Option]) -> boolean()
75
76              Types:
77
78                 This = wxColourDialog()
79                 Parent = wxWindow:wxWindow()
80                 Option = {data, wxColourData:wxColourData()}
81
82              Same as new/2.
83
84       getColourData(This) -> wxColourData:wxColourData()
85
86              Types:
87
88                 This = wxColourDialog()
89
90              Returns the colour data associated with the colour dialog.
91
92
93
94wxWidgets team.                    wx 2.2.1                  wxColourDialog(3)