cheng/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix wrong wxMenuItem::GetBitmap() return type documentation

Browse Source 
This function returns wxBitmap by object, not by (const) reference since
wxBitmapBundle-related changes.

Also change signature of the other methods taking wxBitmapBundle instead
of wxBitmap now.

And some other minor improvements.

Closes #22306.
This commit is contained in:
Maarten Bent 2022-04-14 22:37:55 +02:00 committed by Vadim Zeitlin
parent 105e81a4b0
commit 9a255463f9
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
interface/wx/menuitem.h
View File

@ -138,7 +138,7 @@ public:
For example:
@code
wxMenuItem::GetLabelfromText("&Hello\tCtrl-h");
wxMenuItem::GetLabelText("&Hello\tCtrl-h");
@endcode
will return just @c "Hello".
@ -163,16 +163,16 @@ public:
/**
Returns the checked or unchecked bitmap.
@onlyfor{wxmsw}
The @c checked parameter is only available in wxMSW.
*/
virtual const wxBitmap& GetBitmap(bool checked = true) const;
virtual wxBitmap GetBitmap(bool checked = true) const;
/**
Returns the bitmap to be used for disabled items.
Returns the bitmap used for disabled items.
@onlyfor{wxmsw}
*/
virtual const wxBitmap& GetDisabledBitmap() const;
virtual wxBitmap GetDisabledBitmap() const;
/**
Returns the font associated with the menu item.
@ -256,7 +256,7 @@ public:
@deprecated This function is deprecated in favour of GetItemLabel().
@see GetLabelFromText()
@see GetItemLabel()
*/
const wxString& GetText() const;
@ -367,7 +367,7 @@ public:
@onlyfor{wxmsw,wxosx,wxgtk}
*/
virtual void SetBitmap(const wxBitmap& bmp, bool checked = true);
virtual void SetBitmap(const wxBitmapBundle& bmp, bool checked = true);
/**
Sets the checked/unchecked bitmaps for the menu item.
@ -375,15 +375,15 @@ public:
@onlyfor{wxmsw}
*/
void SetBitmaps(const wxBitmap& checked,
const wxBitmap& unchecked = wxNullBitmap);
void SetBitmaps(const wxBitmapBundle& checked,
const wxBitmapBundle& unchecked = wxNullBitmap);
/**
Sets the to be used for disabled menu items.
@onlyfor{wxmsw}
*/
void SetDisabledBitmap(const wxBitmap& disabled);
void SetDisabledBitmap(const wxBitmapBundle& disabled);
/**