Add doc for wxCliboard::Get

[wxWidgets.git] / interface / wx / ribbon / art.h

diff --git a/interface/wx/ribbon/art.h b/interface/wx/ribbon/art.h
index bfaa5a1597cf122db18183438e69b5c090000279..d33de734793400e8c9333e9ec5602b36c8f060ac 100644 (file)
--- a/interface/wx/ribbon/art.h
+++ b/interface/wx/ribbon/art.h
@@ -174,6 +174,12 @@ enum wxRibbonButtonKind
         menu, and one which causes a generic action.
     */
     wxRIBBON_BUTTON_HYBRID    = wxRIBBON_BUTTON_NORMAL | wxRIBBON_BUTTON_DROPDOWN,
+    
+    /**
+        Normal button or tool with a clickable area which toggles the button
+        between a pressed and unpressed state.
+    */
+    wxRIBBON_BUTTON_TOGGLE    = 1 << 2
 };
 
 /**
@@ -186,8 +192,8 @@ enum wxRibbonButtonKind
     appearance.
 
     By default, a wxRibbonBar uses an instance of this class called
-    wxRibbonDefaultArtProvider, which resolves to wxRibbonAUIArtProvider,
-    wxRibbonMSWArtProvider, or wxRibbonOSXArtProvider - whichever is most appropriate
+    @c wxRibbonDefaultArtProvider, which resolves to @c wxRibbonAUIArtProvider,
+    @c wxRibbonMSWArtProvider, or @c wxRibbonOSXArtProvider - whichever is most appropriate
     to the current platform. These art providers are all slightly configurable with
     regard to colours and fonts, but for larger modifications, you can derive from
     one of these classes, or write a completely new art provider class.
@@ -263,19 +269,19 @@ public:
     /**
         Set the value of a certain colour setting to the value @e colour.
         @a id can be one of the colour values of @ref wxRibbonArtSetting, though
-        not all colour settings will have an affect on every art provider.
+        not all colour settings will have an effect on every art provider.
         
-        \see SetColourScheme()
+        @see SetColourScheme()
     */
     virtual void SetColour(int id, const wxColor& colour) = 0;
     
     /**
-        \see wxRibbonArtProvider::GetColour()
+        @see wxRibbonArtProvider::GetColour()
     */
     wxColour GetColor(int id) const;
     
     /**
-        \see wxRibbonArtProvider::SetColour()
+        @see wxRibbonArtProvider::SetColour()
     */
     void SetColor(int id, const wxColour& color);
     
@@ -295,14 +301,14 @@ public:
         default colours of the art provider.
         Note that if SetColour() is called, then GetColourScheme() does not try
         and return a colour scheme similar to colours being used - it's return
-        values are dependant upon the last values given to SetColourScheme(),
+        values are dependent upon the last values given to SetColourScheme(),
         as described above.
         
-        \param[out] primary
+        @param[out] primary
             Pointer to a location to store the primary colour, or NULL.
-        \param[out] secondary
+        @param[out] secondary
             Pointer to a location to store the secondary colour, or NULL.
-        \param[out] tertiary
+        @param[out] tertiary
             Pointer to a location to store the tertiary colour, or NULL.
     */
     virtual void GetColourScheme(wxColour* primary,
@@ -318,8 +324,8 @@ public:
         Note that some art providers may not use the tertiary colour for
         anything, and some may not use the secondary colour either.
         
-        \see SetColour()
-        \see GetColourScheme()
+        @see SetColour()
+        @see GetColourScheme()
     */    
     virtual void SetColourScheme(const wxColour& primary,
                         const wxColour& secondary,
@@ -449,7 +455,7 @@ public:
     
     /**
         Draw the background and chrome for a wxRibbonGallery control. This
-        should draw the border, brackground, scroll buttons, extension button,
+        should draw the border, background, scroll buttons, extension button,
         and any other UI elements which are not attached to a specific gallery
         item.
         
@@ -827,7 +833,7 @@ public:
     /**
         Calculate the portion of a page background which needs to be redrawn
         when a page is resized. To optimise the drawing of page backgrounds, as
-        small an area as possible should be returned. Of couse, if the way in
+        small an area as possible should be returned. Of course, if the way in
         which a background is drawn means that the entire background needs to
         be repainted on resize, then the entire new size should be returned.
         
@@ -899,7 +905,11 @@ public:
             The ribbon panel in question. Attributes like the panel label can
             be queried from this.
         @param[out] desired_bitmap_size
-            
+            Optional parameter which is filled with the size of the bitmap
+            suitable for a minimised ribbon panel.
+        @param[out] expanded_panel_direction
+            Optional parameter which is filled with the direction of the
+            minimised panel (@c wxEAST or @c wxSOUTH depending on the style).
     */
     virtual wxSize GetMinimisedPanelMinimumSize(
                         wxDC& dc,