X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2352862a7ee8440fdc2ae65baff31b73e40179d5..1c6a98048b47cf1dd1926e97f94abe81a3fded1e:/interface/wx/bmpbuttn.h diff --git a/interface/wx/bmpbuttn.h b/interface/wx/bmpbuttn.h index 1d352d856a..8a95888271 100644 --- a/interface/wx/bmpbuttn.h +++ b/interface/wx/bmpbuttn.h @@ -3,7 +3,7 @@ // Purpose: interface of wxBitmapButton // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -18,21 +18,14 @@ support in wxButton. @beginStyleTable - @style{wxBU_AUTODRAW} - If this is specified, the button will be drawn automatically using - the label bitmap only, providing a 3D-look border. If this style is - not specified, the button will be drawn without borders and using - all provided bitmaps. Has effect only under MS Windows. @style{wxBU_LEFT} - Left-justifies the bitmap label. Has effect only under MS Windows. + Left-justifies the bitmap label. @style{wxBU_TOP} Aligns the bitmap label to the top of the button. - Has effect only under MS Windows. @style{wxBU_RIGHT} - Right-justifies the bitmap label. Has effect only under MS Windows. + Right-justifies the bitmap label. @style{wxBU_BOTTOM} Aligns the bitmap label to the bottom of the button. - Has effect only under MS Windows. @endStyleTable Note that the wxBU_EXACTFIT style supported by wxButton is not used by this @@ -40,12 +33,12 @@ @beginEventEmissionTable{wxCommandEvent} @event{EVT_BUTTON(id, func)} - Process a wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked. + Process a @c wxEVT_BUTTON event, when the button is clicked. @endEventTable @library{wxcore} @category{ctrl} - @appearance{bitmapbutton.png} + @appearance{bitmapbutton} @see wxButton */ @@ -106,5 +99,21 @@ public: long style = wxBU_AUTODRAW, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxButtonNameStr); + + /** + Helper function creating a standard-looking "Close" button. + + To get the best results, platform-specific code may need to be used to + create a small, title bar-like "Close" button. This function is + provided to avoid the need to test for the current platform and creates + the button with as native look as possible. + + @param parent The button parent window, must be non-@NULL. + @param winid The identifier for the new button. + @return The new button. + + @since 2.9.5 + */ + static wxBitmapButton* NewCloseButton(wxWindow* parent, wxWindowID winid); };