revision contributed by Utensil Candel

[wxWidgets.git] / interface / odcombo.h

diff --git a/interface/odcombo.h b/interface/odcombo.h
index 5ee81f1683531445e488bcf8cb7ecb3554dd9a10..ecd545f67af636d92d9f350e348a8afb8d812f66 100644 (file)
--- a/interface/odcombo.h
+++ b/interface/odcombo.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        odcombo.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        odcombo.h

-// Purpose:     documentation for wxOwnerDrawnComboBox class
+// Purpose:     interface of wxOwnerDrawnComboBox

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -30,8 +30,8 @@
            painted unless SetCustomPaintWidth is called.
     @endStyleTable
 
            painted unless SetCustomPaintWidth is called.
     @endStyleTable
 

-    @beginEventTable
-    @event{EVT_COMBOBOX(id\, func)}:
+    @beginEventTable{wxCommandEvent}
+    @event{EVT_COMBOBOX(id, func)}:

            Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
            the list is selected. Note that calling GetValue returns the new
            value of selection.
            Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
            the list is selected. Note that calling GetValue returns the new
            value of selection.


@@ -41,8 +41,7 @@
     @category{ctrl}
     @appearance{ownerdrawncombobox.png}
 
     @category{ctrl}
     @appearance{ownerdrawncombobox.png}
 

-    @seealso
-    wxComboCtrl, wxComboBox, wxVListBox, wxCommandEvent
+    @see wxComboCtrl, wxComboBox, wxVListBox, wxCommandEvent

 */
 class wxOwnerDrawnComboBox : public wxComboCtrl
 {
 */
 class wxOwnerDrawnComboBox : public wxComboCtrl
 {


@@ -50,39 +49,31 @@ public:
     //@{
     /**
         Constructor, creating and showing a owner-drawn combobox.
     //@{
     /**
         Constructor, creating and showing a owner-drawn combobox.

-        
+

         @param parent
         @param parent

-        Parent window. Must not be @NULL.
-        
+            Parent window. Must not be @NULL.

         @param id
         @param id

-        Window identifier. The value wxID_ANY indicates a default value.
-        
+            Window identifier. The value wxID_ANY indicates a default value.

         @param value
         @param value

-        Initial selection string. An empty string indicates no selection.
-        
+            Initial selection string. An empty string indicates no selection.

         @param pos
         @param pos

-        Window position.
-        
+            Window position.

         @param size
         @param size

-        Window size. If wxDefaultSize is specified then the window is sized
-        appropriately.
-        
+            Window size. If wxDefaultSize is specified then the window is
+        sized
+            appropriately.

         @param n
         @param n

-        Number of strings with which to initialise the control.
-        
+            Number of strings with which to initialise the control.

         @param choices
         @param choices

-        An array of strings with which to initialise the control.
-        
+            An array of strings with which to initialise the control.

         @param style
         @param style

-        Window style. See wxOwnerDrawnComboBox.
-        
+            Window style. See wxOwnerDrawnComboBox.

         @param validator
         @param validator

-        Window validator.
-        
+            Window validator.

         @param name
         @param name

-        Window name.
-        
-        @sa Create(), wxValidator
+            Window name.
+
+        @see Create(), wxValidator

     */
     wxOwnerDrawnComboBox();
     wxOwnerDrawnComboBox(wxWindow* parent, wxWindowID id,
     */
     wxOwnerDrawnComboBox();
     wxOwnerDrawnComboBox(wxWindow* parent, wxWindowID id,


@@ -90,7 +81,7 @@ public:
                          const wxPoint& pos = wxDefaultPosition,
                          const wxSize& size = wxDefaultSize,
                          int n = 0,
                          const wxPoint& pos = wxDefaultPosition,
                          const wxSize& size = wxDefaultSize,
                          int n = 0,

-                         const wxString choices[] = @NULL,
+                         const wxString choices[] = NULL,

                          long style = 0,
                          const wxValidator& validator = wxDefaultValidator,
                          const wxString& name = "comboBox");
                          long style = 0,
                          const wxValidator& validator = wxDefaultValidator,
                          const wxString& name = "comboBox");


@@ -137,61 +128,56 @@ public:
     /**
         Returns index to the widest item in the list.
     */
     /**
         Returns index to the widest item in the list.
     */

-    int GetWidestItem();
+    int GetWidestItem() const;

 
     /**
         Returns width of the widest item in the list.
     */
 
     /**
         Returns width of the widest item in the list.
     */

-    int GetWidestItemWidth();
+    int GetWidestItemWidth() const;

 
     /**
         This method is used to draw the items background and, maybe, a border around it.
 
     /**
         This method is used to draw the items background and, maybe, a border around it.

-        

         The base class version implements a reasonable default behaviour which consists
         in drawing the selected item with the standard background colour and drawing a
         border around the item if it is either selected or current.
         The base class version implements a reasonable default behaviour which consists
         in drawing the selected item with the standard background colour and drawing a
         border around the item if it is either selected or current.

-        
+

         @remarks flags has the same meaning as with OnDrawItem.
     */
     void OnDrawBackground(wxDC& dc, const wxRect& rect, int item,
         @remarks flags has the same meaning as with OnDrawItem.
     */
     void OnDrawBackground(wxDC& dc, const wxRect& rect, int item,

-                          int flags);
+                          int flags) const;

 
     /**
         The derived class may implement this function to actually draw the item
         with the given index on the provided DC. If function is not implemented,
         the item text is simply drawn, as if the control was a normal combobox.
 
     /**
         The derived class may implement this function to actually draw the item
         with the given index on the provided DC. If function is not implemented,
         the item text is simply drawn, as if the control was a normal combobox.

-        
+

         @param dc
         @param dc

-        The device context to use for drawing
-        
+            The device context to use for drawing

         @param rect
         @param rect

-        The bounding rectangle for the item being drawn (DC clipping
-        region is set to this rectangle before calling this function)
-        
+            The bounding rectangle for the item being drawn (DC clipping
+            region is set to this rectangle before calling this function)

         @param item
         @param item

-        The index of the item to be drawn
-        
+            The index of the item to be drawn

         @param flags
         @param flags

-        Combines any of the following flag values:
+            Combines any of the following flag values:

     */
     void OnDrawItem(wxDC& dc, const wxRect& rect, int item,
     */
     void OnDrawItem(wxDC& dc, const wxRect& rect, int item,

-                    int flags);
+                    int flags) const;

 
     /**
         The derived class may implement this method to return the height of the
         specified item (in pixels).
 
     /**
         The derived class may implement this method to return the height of the
         specified item (in pixels).

-        

         The default implementation returns text height, as if this control was
         a normal combobox.
     */
         The default implementation returns text height, as if this control was
         a normal combobox.
     */

-    wxCoord OnMeasureItem(size_t item);
+    wxCoord OnMeasureItem(size_t item) const;

 
     /**
         The derived class may implement this method to return the width of the
         specified item (in pixels). If -1 is returned, then the item text width
         is used.
 
     /**
         The derived class may implement this method to return the width of the
         specified item (in pixels). If -1 is returned, then the item text width
         is used.

-        

         The default implementation returns -1.
     */
         The default implementation returns -1.
     */

-    wxCoord OnMeasureItemWidth(size_t item);
+    wxCoord OnMeasureItemWidth(size_t item) const;

 };
 };

+