Finished initial review of [cl*-cm*] interface headers.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53086 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2008-04-08 05:34:11 +00:00
parent 4a36036eb2
commit d18d9f6047
10 changed files with 915 additions and 496 deletions

View File

@@ -10,12 +10,11 @@
@class wxColourPickerCtrl
@wxheader{clrpicker.h}
This control allows the user to select a colour. The generic implementation is
a button which brings up a wxColourDialog when clicked. Native implementation
may differ but this is usually a (small) widget which give access to the
colour-chooser
dialog.
It is only available if @c wxUSE_COLOURPICKERCTRL is set to 1 (the default).
This control allows the user to select a colour. The generic implementation
is a button which brings up a wxColourDialog when clicked. Native
implementation may differ but this is usually a (small) widget which give
access to the colour-chooser dialog. It is only available if
@c wxUSE_COLOURPICKERCTRL is set to 1 (the default).
@beginStyleTable
@style{wxCLRP_DEFAULT_STYLE}
@@ -31,9 +30,17 @@
(instead of no label at all).
@endStyleTable
@beginEventTable{wxColourPickerEvent}
@event{EVT_COLOURPICKER_CHANGED(id, func)}
The user changed the colour selected in the control either using the
button or using text control (see @c wxCLRP_USE_TEXTCTRL; note that
in this case the event is fired only if the users input is valid,
i.e. recognizable).
@endEventTable
@library{wxcore}
@category{miscpickers}
@appearance{colourpickerctrl.png}
@category{pickers}
<!-- @appearance{colourpickerctrl.png} -->
@see wxColourDialog, wxColourPickerEvent
*/
@@ -41,8 +48,7 @@ class wxColourPickerCtrl : public wxPickerBase
{
public:
/**
Initializes the object and calls Create() with
all the parameters.
Initializes the object and calls Create() with all the parameters.
*/
wxColourPickerCtrl(wxWindow* parent, wxWindowID id,
const wxColour& colour = wxBLACK,
@@ -53,6 +59,8 @@ public:
const wxString& name = "colourpickerctrl");
/**
Creates a colour picker with the given arguments.
@param parent
Parent window, must not be non-@NULL.
@param id
@@ -88,7 +96,7 @@ public:
//@{
/**
Sets the currently selected colour. See wxColour::Set.
Sets the currently selected colour. See wxColour::Set().
*/
void SetColour(const wxColour& col);
void SetColour(const wxString& colname);
@@ -101,11 +109,15 @@ public:
@class wxColourPickerEvent
@wxheader{clrpicker.h}
This event class is used for the events generated by
wxColourPickerCtrl.
This event class is used for the events generated by wxColourPickerCtrl.
@beginEventTable{wxColourPickerEvent}
@event{EVT_COLOURPICKER_CHANGED(id, func)}
Generated whenever the selected colour changes.
@endEventTable
@library{wxcore}
@category{FIXME}
@category{events}
@see wxColourPickerCtrl
*/