X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/ae3c17b4013e80b99976c750c19fca47729517f6..2392b8e8712b34c635f7079970a6ca2852493c69:/interface/wx/pickerbase.h diff --git a/interface/wx/pickerbase.h b/interface/wx/pickerbase.h index 8fca81bdd4..eec1fec175 100644 --- a/interface/wx/pickerbase.h +++ b/interface/wx/pickerbase.h @@ -3,12 +3,11 @@ // Purpose: interface of wxPickerBase // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @class wxPickerBase - @wxheader{pickerbase.h} Base abstract class for all pickers which support an auxiliary text control. @@ -51,15 +50,35 @@ public: @c wxPB_USE_TEXTCTRL style was not specified when this control was created. @remarks - The contents of the text control could be containing an invalid - representation of the entity which can be chosen through the picker - (e.g. the user entered an invalid colour syntax because of a typo). + The contents of the text control could be an invalid representation of + the entity which can be chosen through the picker + (e.g. when the user enters an invalid colour syntax because of a typo). Thus you should never parse the content of the textctrl to get the user's input; rather use the derived-class getter (e.g. wxColourPickerCtrl::GetColour(), wxFilePickerCtrl::GetPath(), etc). */ wxTextCtrl* GetTextCtrl(); + /** + Returns the native implementation of the real picker control. + + @note + The returned control in the generic implementation of wxFilePickerCtrl, + wxDirPickerCtrl, wxFontPickerCtrl and wxColourPickerCtrl is a specialized + wxButton class so that you can change its label doing, e.g.: + @code + #ifdef __WXMSW__ + // wxMSW is one of the platforms where the generic implementation + // of wxFilePickerCtrl is used... + + wxButton *pButt = wx_static_cast(wxButton*, myFilePickerCtrl->GetPickerCtrl()); + if (pButt) + pButt->SetLabel("Custom browse string"); + #endif + @endcode + */ + wxControl* GetPickerCtrl(); + /** Returns the proportion value of the text control.