wxRibbon: Added @since tags to new function documentation

This commit is contained in:
Max Maisel
2018-03-26 16:50:32 +02:00
parent 2be4724d53
commit 7612d1f6fa
2 changed files with 14 additions and 0 deletions

View File

@@ -983,6 +983,8 @@ public:
@return Width of the given label text in pixel. @return Width of the given label text in pixel.
@note This function only works with single-line strings. @note This function only works with single-line strings.
@since 3.1.2
*/ */
virtual wxCoord GetButtonBarButtonTextWidth( virtual wxCoord GetButtonBarButtonTextWidth(
wxDC& dc, const wxString& label, wxDC& dc, const wxString& label,

View File

@@ -495,6 +495,8 @@ public:
Small bitmap of the new button when it is disabled. If left as Small bitmap of the new button when it is disabled. If left as
null, then a bitmap will be automatically generated from @a null, then a bitmap will be automatically generated from @a
bitmap_small. bitmap_small.
@since 3.1.2
*/ */
virtual void SetButtonIcon( virtual void SetButtonIcon(
int button_id, int button_id,
@@ -518,6 +520,8 @@ public:
after every change. after every change.
@see SetButtonTextMinWidth @see SetButtonTextMinWidth
@since 3.1.2
*/ */
virtual void SetButtonText(int button_id, const wxString& label); virtual void SetButtonText(int button_id, const wxString& label);
@@ -543,6 +547,8 @@ public:
button labels on the fly without modifying the button bar layout. button labels on the fly without modifying the button bar layout.
@see SetButtonText() @see SetButtonText()
@since 3.1.2
*/ */
virtual void SetButtonTextMinWidth(int button_id, virtual void SetButtonTextMinWidth(int button_id,
int min_width_medium, int min_width_large); int min_width_medium, int min_width_large);
@@ -565,6 +571,8 @@ public:
button labels on the fly without modifying the button bar layout. button labels on the fly without modifying the button bar layout.
@see SetButtonText() @see SetButtonText()
@since 3.1.2
*/ */
virtual void SetButtonTextMinWidth(int button_id, const wxString& label); virtual void SetButtonTextMinWidth(int button_id, const wxString& label);
@@ -580,6 +588,8 @@ public:
The minimum size-class of the button. Buttons on a button bar The minimum size-class of the button. Buttons on a button bar
can have three distinct sizes: wxRIBBON_BUTTONBAR_BUTTON_SMALL, can have three distinct sizes: wxRIBBON_BUTTONBAR_BUTTON_SMALL,
wxRIBBON_BUTTONBAR_BUTTON_MEDIUM, and wxRIBBON_BUTTONBAR_BUTTON_LARGE. wxRIBBON_BUTTONBAR_BUTTON_MEDIUM, and wxRIBBON_BUTTONBAR_BUTTON_LARGE.
@since 3.1.2
*/ */
virtual void SetButtonMinSizeClass(int button_id, virtual void SetButtonMinSizeClass(int button_id,
wxRibbonButtonBarButtonState min_size_class); wxRibbonButtonBarButtonState min_size_class);
@@ -596,6 +606,8 @@ public:
The maximum size-class of the button. Buttons on a button bar The maximum size-class of the button. Buttons on a button bar
can have three distinct sizes: wxRIBBON_BUTTONBAR_BUTTON_SMALL, can have three distinct sizes: wxRIBBON_BUTTONBAR_BUTTON_SMALL,
wxRIBBON_BUTTONBAR_BUTTON_MEDIUM, and wxRIBBON_BUTTONBAR_BUTTON_LARGE. wxRIBBON_BUTTONBAR_BUTTON_MEDIUM, and wxRIBBON_BUTTONBAR_BUTTON_LARGE.
@since 3.1.2
*/ */
virtual void SetButtonMaxSizeClass(int button_id, virtual void SetButtonMaxSizeClass(int button_id,
wxRibbonButtonBarButtonState max_size_class); wxRibbonButtonBarButtonState max_size_class);