Go to main content

man pages section 3: Extended Library Functions, Volume 1

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

wxColourData (3erl)

Name

wxColourData - Functions for wxColourData class

Synopsis

Please see following description for synopsis

Description

wxColourData(3)            Erlang Module Definition            wxColourData(3)



NAME
       wxColourData - Functions for wxColourData class

DESCRIPTION
       This class holds a variety of information related to colour dialogs.

       See: wx_color(), wxColourDialog, Overview cmndlg

       wxWidgets docs: wxColourData

DATA TYPES
       wxColourData() = wx:wx_object()

EXPORTS
       new() -> wxColourData()

              Constructor.

              Initializes  the custom colours to wxNullColour, the data colour
              setting to black, and the choose full setting to true.

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

              Destructor.

       getChooseFull(This) -> boolean()

              Types:

                 This = wxColourData()

              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.

       getColour(This) -> wx:wx_colour4()

              Types:

                 This = wxColourData()

              Gets the current colour associated with the colour dialog.

              The default colour is black.

       getCustomColour(This, I) -> wx:wx_colour4()

              Types:

                 This = wxColourData()
                 I = integer()

              Returns custom colours associated with the colour dialog.

       setChooseFull(This, Flag) -> ok

              Types:

                 This = wxColourData()
                 Flag = boolean()

              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.

       setColour(This, Colour) -> ok

              Types:

                 This = wxColourData()
                 Colour = wx:wx_colour()

              Sets the default colour for the colour dialog.

              The default colour is black.

       setCustomColour(This, I, Colour) -> ok

              Types:

                 This = wxColourData()
                 I = integer()
                 Colour = wx:wx_colour()

              Sets custom colours for the colour dialog.



wxWidgets team.                    wx 2.1.1                    wxColourData(3)