oracular (3) wxColourDialog.3erl.gz

NAME

       wxColourDialog - Functions for wxColourDialog class

DESCRIPTION

       This class represents the colour chooser dialog.

       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  wxDialog:showModal/1  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:

       See:   Overview   cmndlg,   wx_color(),   wxColourData,  wxColourDialogEvent  (not  implemented  in  wx),
       ?wxGetColourFromUser()

       This class is derived (and can use functions) from: wxDialog wxTopLevelWindow wxWindow wxEvtHandler

       wxWidgets docs: wxColourDialog

DATA TYPES

       wxColourDialog() = wx:wx_object()

EXPORTS

       new() -> wxColourDialog()

       new(Parent) -> wxColourDialog()

              Types:

                 Parent = wxWindow:wxWindow()

       new(Parent, Options :: [Option]) -> wxColourDialog()

              Types:

                 Parent = wxWindow:wxWindow()
                 Option = {data, wxColourData:wxColourData()}

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

       destroy(This :: wxColourDialog()) -> ok

              Destructor.

       create(This, Parent) -> boolean()

              Types:

                 This = wxColourDialog()
                 Parent = wxWindow:wxWindow()

       create(This, Parent, Options :: [Option]) -> boolean()

              Types:

                 This = wxColourDialog()
                 Parent = wxWindow:wxWindow()
                 Option = {data, wxColourData:wxColourData()}

              Same as new/2.

       getColourData(This) -> wxColourData:wxColourData()

              Types:

                 This = wxColourDialog()

              Returns the colour data associated with the colour dialog.