X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/b3231f0aaf369e384d41b2e5890b75a3e26f3fea..15041ff9c88a55041f91e04d8019c38e8e188b05:/include/wx/mac/carbon/drawer.h diff --git a/include/wx/mac/carbon/drawer.h b/include/wx/mac/carbon/drawer.h index 5103f73fce..e2230aca8c 100644 --- a/include/wx/mac/carbon/drawer.h +++ b/include/wx/mac/carbon/drawer.h @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: drawer.h +// Name: wx/mac/carbon/drawer.h // Purpose: Drawer child window class. // Drawer windows appear under their parent window and // behave like a drawer, opening and closing to reveal @@ -15,37 +15,39 @@ #ifndef _WX_DRAWERWINDOW_H_ #define _WX_DRAWERWINDOW_H_ -#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA) -#pragma interface "drawer.h" -#endif - #include "wx/toplevel.h" +// +// NB: This is currently a private undocumented class - +// it is stable, but the API is not and will change in the +// near future +// + #if ( MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_2 ) class WXDLLEXPORT wxDrawerWindow : public wxTopLevelWindow { DECLARE_DYNAMIC_CLASS(wxDrawerWindow) - + public: wxDrawerWindow(); - + wxDrawerWindow(wxWindow* parent, - wxWindowID id, - const wxString& title, - wxSize size = wxDefaultSize, - wxDirection edge = wxLEFT, - const wxString& name = wxT("drawerwindow")) + wxWindowID id, + const wxString& title, + wxSize size = wxDefaultSize, + wxDirection edge = wxLEFT, + const wxString& name = wxT("drawerwindow")) { this->Create(parent, id, title, size, edge, name); } - - ~wxDrawerWindow(); - - // Create a drawer window. + + virtual ~wxDrawerWindow(); + + // Create a drawer window. // If parent is NULL, create as a tool window. - // If parent is not NULL, then wxTopLevelWindow::Attach this window to parent. + // If parent is not NULL, then wxTopLevelWindow::Attach this window to parent. bool Create(wxWindow *parent, wxWindowID id, const wxString& title, @@ -56,13 +58,14 @@ public: bool Open(bool show = true); // open or close the drawer, possibility for async param, i.e. animate bool Close() { return this->Open(false); } bool IsOpen() const; - + // Set the edge of the parent where the drawer attaches. bool SetPreferredEdge(wxDirection edge); wxDirection GetPreferredEdge() const; - wxDirection GetCurrentEdge() const; // not necessarily the preferred, due to screen constraints + wxDirection GetCurrentEdge() const; // not necessarily the preferred, due to screen constraints }; #endif // defined( __WXMAC__ ) && TARGET_API_MAC_OSX && ( MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_2 ) -#endif // _WX_DRAWERWINDOW_H_ +#endif + // _WX_DRAWERWINDOW_H_