Fix typo in wxStandardPathsBase::ResourceCat description and document it.

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

diff --git a/interface/wx/ribbon/gallery.h b/interface/wx/ribbon/gallery.h
index 27d2fe349e177ad9f78c4fd6dc2b127701a92e99..eb2b01938ff97080748fa7be626aecd93542d217 100644 (file)
--- a/interface/wx/ribbon/gallery.h
+++ b/interface/wx/ribbon/gallery.h
@@ -16,7 +16,7 @@ enum wxRibbonGalleryButtonState
 
 /**
     @class wxRibbonGallery
 
 /**
     @class wxRibbonGallery

-    
+

     A ribbon gallery is like a wxListBox, but for bitmaps rather than strings.
     It displays a collection of bitmaps arranged in a grid and allows the user
     to choose one. As there are typically more bitmaps in a gallery than can
     A ribbon gallery is like a wxListBox, but for bitmaps rather than strings.
     It displays a collection of bitmaps arranged in a grid and allows the user
     to choose one. As there are typically more bitmaps in a gallery than can


@@ -25,11 +25,16 @@ enum wxRibbonGalleryButtonState
     has an "extension" button, the behaviour of which is outside the scope of
     the gallery control itself, though it typically displays some kind of
     dialog related to the gallery.
     has an "extension" button, the behaviour of which is outside the scope of
     the gallery control itself, though it typically displays some kind of
     dialog related to the gallery.

-    
+

     @beginEventEmissionTable{wxRibbonGalleryEvent}
     @event{EVT_RIBBONGALLERY_SELECTED(id, func)}
         Triggered when the user selects an item from the gallery. Note that the
         ID is that of the gallery, not of the item.
     @beginEventEmissionTable{wxRibbonGalleryEvent}
     @event{EVT_RIBBONGALLERY_SELECTED(id, func)}
         Triggered when the user selects an item from the gallery. Note that the
         ID is that of the gallery, not of the item.

+    @event{EVT_RIBBONGALLERY_CLICKED(id, func)}
+        Similar to EVT_RIBBONGALLERY_SELECTED but triggered every time a
+        gallery item is clicked, even if it is already selected. Note that the
+        ID of the event is that of the gallery, not of the item, just as above.
+        This event is available since wxWidgets 2.9.2.

     @event{EVT_RIBBONGALLERY_HOVER_CHANGED(id, func)}
         Triggered when the item being hovered over by the user changes. The
         item in the event will be the new item being hovered, or NULL if there
     @event{EVT_RIBBONGALLERY_HOVER_CHANGED(id, func)}
         Triggered when the item being hovered over by the user changes. The
         item in the event will be the new item being hovered, or NULL if there


@@ -98,17 +103,17 @@ public:
         Query if the gallery has no items in it.
     */
     bool IsEmpty() const;
         Query if the gallery has no items in it.
     */
     bool IsEmpty() const;

-    
+

     /**
         Get the number of items in the gallery.
     */
     unsigned int GetCount() const;
     /**
         Get the number of items in the gallery.
     */
     unsigned int GetCount() const;

-    
+

     /**
         Get an item by index.
     */
     wxRibbonGalleryItem* GetItem(unsigned int n);
     /**
         Get an item by index.
     */
     wxRibbonGalleryItem* GetItem(unsigned int n);

-    
+

     /**
         Add an item to the gallery (with no client data).
         @param bitmap
     /**
         Add an item to the gallery (with no client data).
         @param bitmap


@@ -119,7 +124,7 @@ public:
             anything important.
     */
     wxRibbonGalleryItem* Append(const wxBitmap& bitmap, int id);
             anything important.
     */
     wxRibbonGalleryItem* Append(const wxBitmap& bitmap, int id);

-    
+

     /**
         Add an item to the gallery (with simple client data).
         @param bitmap
     /**
         Add an item to the gallery (with simple client data).
         @param bitmap


@@ -132,7 +137,7 @@ public:
             An opaque pointer to associate with the item.
     */
     wxRibbonGalleryItem* Append(const wxBitmap& bitmap, int id, void* clientData);
             An opaque pointer to associate with the item.
     */
     wxRibbonGalleryItem* Append(const wxBitmap& bitmap, int id, void* clientData);

-    
+

     /**
         Add an item to the gallery (with complex client data)
         @param bitmap
     /**
         Add an item to the gallery (with complex client data)
         @param bitmap


@@ -153,17 +158,17 @@ public:
         Set the client object associated with a gallery item.
     */
     void SetItemClientObject(wxRibbonGalleryItem* item, wxClientData* data);
         Set the client object associated with a gallery item.
     */
     void SetItemClientObject(wxRibbonGalleryItem* item, wxClientData* data);

-    
+

     /**
         Get the client object associated with a gallery item.
     */
     wxClientData* GetItemClientObject(const wxRibbonGalleryItem* item) const;
     /**
         Get the client object associated with a gallery item.
     */
     wxClientData* GetItemClientObject(const wxRibbonGalleryItem* item) const;

-    
+

     /**
         Set the client data associated with a gallery item.
     */
     void SetItemClientData(wxRibbonGalleryItem* item, void* data);
     /**
         Set the client data associated with a gallery item.
     */
     void SetItemClientData(wxRibbonGalleryItem* item, void* data);

-    
+

     /**
         Get the client data associated with a gallery item.
     */
     /**
         Get the client data associated with a gallery item.
     */


@@ -172,44 +177,44 @@ public:
     /**
         Set the selection to the given item, or removes the selection if
         @a item == NULL.
     /**
         Set the selection to the given item, or removes the selection if
         @a item == NULL.

-        
+

         Note that this not cause any events to be emitted.
     */
     void SetSelection(wxRibbonGalleryItem* item);
 
     /**
         Get the currently selected item, or NULL if there is none.
         Note that this not cause any events to be emitted.
     */
     void SetSelection(wxRibbonGalleryItem* item);
 
     /**
         Get the currently selected item, or NULL if there is none.

-        
+

         The selected item is set by SetSelection(), or by the user clicking on
         an item.
     */
     wxRibbonGalleryItem* GetSelection() const;
         The selected item is set by SetSelection(), or by the user clicking on
         an item.
     */
     wxRibbonGalleryItem* GetSelection() const;

-    
+

     /**
         Get the currently hovered item, or NULL if there is none.
     /**
         Get the currently hovered item, or NULL if there is none.

-        
+

         The hovered item is the item underneath the mouse cursor.
     */
     wxRibbonGalleryItem* GetHoveredItem() const;
         The hovered item is the item underneath the mouse cursor.
     */
     wxRibbonGalleryItem* GetHoveredItem() const;

-    
+

     /**
         Get the currently active item, or NULL if there is none.
     /**
         Get the currently active item, or NULL if there is none.

-        
+

         The active item is the item being pressed by the user, and will thus
         become the selected item if the user releases the mouse button.
     */
     wxRibbonGalleryItem* GetActiveItem() const;
         The active item is the item being pressed by the user, and will thus
         become the selected item if the user releases the mouse button.
     */
     wxRibbonGalleryItem* GetActiveItem() const;

-    
+

     /**
         Get the state of the scroll up button.
     */
     wxRibbonGalleryButtonState GetUpButtonState() const;
     /**
         Get the state of the scroll up button.
     */
     wxRibbonGalleryButtonState GetUpButtonState() const;

-    
+

     /**
         Get the state of the scroll down button.
     */
     wxRibbonGalleryButtonState GetDownButtonState() const;
     /**
         Get the state of the scroll down button.
     */
     wxRibbonGalleryButtonState GetDownButtonState() const;

-    
+

     /**
         Get the state of the "extension" button.
     */
     /**
         Get the state of the "extension" button.
     */


@@ -217,24 +222,24 @@ public:
 
     /**
         Query is the mouse is currently hovered over the gallery.
 
     /**
         Query is the mouse is currently hovered over the gallery.

-        
+

         @return @true if the cursor is within the bounds of the gallery (not
             just hovering over an item), @false otherwise.
     */
     bool IsHovered() const;
         @return @true if the cursor is within the bounds of the gallery (not
             just hovering over an item), @false otherwise.
     */
     bool IsHovered() const;

-    
+

     /**
         Scroll the gallery contents by some amount.
     /**
         Scroll the gallery contents by some amount.

-        
+

         @param lines
           Positive values scroll toward the end of the gallery, while negative
           values scroll toward the start.
         @param lines
           Positive values scroll toward the end of the gallery, while negative
           values scroll toward the start.

-    
+

         @return @true if the gallery scrolled at least one pixel in the given
             direction, @false if it did not scroll.
     */
     virtual bool ScrollLines(int lines);
         @return @true if the gallery scrolled at least one pixel in the given
             direction, @false if it did not scroll.
     */
     virtual bool ScrollLines(int lines);

-    
+

     /**
         Scroll the gallery to ensure that the given item is visible.
     */
     /**
         Scroll the gallery to ensure that the given item is visible.
     */


@@ -249,33 +254,33 @@ public:
 
     @see wxRibbonBar
 */
 
     @see wxRibbonBar
 */

-class wxRibbonButtonBarEvent : public wxCommandEvent
+class wxRibbonGalleryEvent : public wxCommandEvent

 {
 public:
     /**
         Constructor.
     */
 {
 public:
     /**
         Constructor.
     */

-    wxRibbonButtonBarEvent(wxEventType command_type = wxEVT_NULL,
-                       int win_id = 0,
-                       wxRibbonGallery* gallery = NULL,
-                       wxRibbonGalleryItem* item = NULL);
+    wxRibbonGalleryEvent(wxEventType command_type = wxEVT_NULL,
+                         int win_id = 0,
+                         wxRibbonGallery* gallery = NULL,
+                         wxRibbonGalleryItem* item = NULL);

 
     /**
         Returns the gallery which the event relates to.
     */
     wxRibbonGallery* GetGallery();
 
     /**
         Returns the gallery which the event relates to.
     */
     wxRibbonGallery* GetGallery();

-    
+

     /**
         Returns the gallery item which the event relates to, or NULL if it does
         not relate to an item.
     */
     wxRibbonGalleryItem* GetGalleryItem();
     /**
         Returns the gallery item which the event relates to, or NULL if it does
         not relate to an item.
     */
     wxRibbonGalleryItem* GetGalleryItem();

-        
+

     /**
         Sets the gallery relating to this event.
     */
     void SetGallery(wxRibbonGallery* gallery);
     /**
         Sets the gallery relating to this event.
     */
     void SetGallery(wxRibbonGallery* gallery);

-    
+

     /**
         Sets the gallery item relating to this event.
     */
     /**
         Sets the gallery item relating to this event.
     */