restored wxWindow::Line/PageUp/Down docs

[wxWidgets.git] / interface / pickerbase.h

diff --git a/interface/pickerbase.h b/interface/pickerbase.h
index 278dccba6cec73e4f49b517e13ceaba2585bb58f..94792952fcbb11d26c9bdf8454884895e14ab2aa 100644 (file)
--- a/interface/pickerbase.h
+++ b/interface/pickerbase.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        pickerbase.h
-// Purpose:     documentation for wxPickerBase class
+// Purpose:     interface of wxPickerBase
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -9,7 +9,7 @@
 /**
     @class wxPickerBase
     @wxheader{pickerbase.h}
-    
+
     Base abstract class for all pickers which support an auxiliary text control.
     This class handles all positioning and sizing of the text control like a
     an horizontal wxBoxSizer would do, with the text control on
@@ -18,18 +18,17 @@
     proportion values) of the picker control defaults to 1 when there isn't a text
     control
     associated (see @c wxPB_USE_TEXTCTRL style) and to 0 otherwise.
-    
+
     @beginStyleTable
     @style{wxPB_USE_TEXTCTRL}:
            Creates a text control to the left of the picker which is
            completely managed by this wxPickerBase class.
     @endStyleTable
-    
+
     @library{wxcore}
     @category{FIXME}
-    
-    @seealso
-    wxColourPickerCtrl
+
+    @see wxColourPickerCtrl
 */
 class wxPickerBase : public wxControl
 {
@@ -38,12 +37,12 @@ public:
         Returns the margin (in pixel) between the picker and the text control.
         This function can be used only when HasTextCtrl() returns @true.
     */
-    int GetInternalMargin();
+    int GetInternalMargin() const;
 
     /**
         Returns the proportion value of the picker.
     */
-    int GetPickerCtrlProportion();
+    int GetPickerCtrlProportion() const;
 
     /**
         Returns a pointer to the text control handled by this window or @NULL if the
@@ -51,31 +50,31 @@ public:
         Very important: the contents of the text control could be containing an invalid
         representation of the entity which can be chosen through the picker (e.g. the user entered an invalid colour syntax because of a typo). Thus you should never parse the content of the textctrl to get the user's input; rather use the derived-class getter (e.g. wxColourPickerCtrl::GetColour, wxFilePickerCtrl::GetPath, etc).
     */
-    wxTextCtrl * GetTextCtrl();
+    wxTextCtrl* GetTextCtrl();
 
     /**
         Returns the proportion value of the text control.
         This function can be used only when HasTextCtrl() returns @true.
     */
-    int GetTextCtrlProportion();
+    int GetTextCtrlProportion() const;
 
     /**
         Returns @true if this window has a valid text control (i.e. if the @b
         wxPB_USE_TEXTCTRL style was
         given when creating this control).
     */
-    bool HasTextCtrl();
+    bool HasTextCtrl() const;
 
     /**
         Returns @true if the picker control is growable.
     */
-    bool IsPickerCtrlGrowable();
+    bool IsPickerCtrlGrowable() const;
 
     /**
         Returns @true if the text control is growable.
         This function can be used only when HasTextCtrl() returns @true.
     */
-    bool IsTextCtrlGrowable();
+    bool IsTextCtrlGrowable() const;
 
     /**
         Sets the margin (in pixel) between the picker and the text control.
@@ -86,7 +85,7 @@ public:
     /**
         Sets the picker control as growable when @c grow is @true.
     */
-    void SetPickerCtrlGrowable(bool grow = @true);
+    void SetPickerCtrlGrowable(bool grow = true);
 
     /**
         Sets the proportion value of the picker.
@@ -98,7 +97,7 @@ public:
         Sets the text control as growable when @c grow is @true.
         This function can be used only when HasTextCtrl() returns @true.
     */
-    void SetTextCtrlGrowable(bool grow = @true);
+    void SetTextCtrlGrowable(bool grow = true);
 
     /**
         Sets the proportion value of the text control.
@@ -107,3 +106,4 @@ public:
     */
     void SetTextCtrlProportion(int prop);
 };
+