X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12f5e1e78fe906050ff2fee9529476db332633f0..92c0fc34c104c8d7c12d6a3b78ea232690fc23f4:/interface/wx/minifram.h diff --git a/interface/wx/minifram.h b/interface/wx/minifram.h index dc137679b2..7502ed8513 100644 --- a/interface/wx/minifram.h +++ b/interface/wx/minifram.h @@ -2,48 +2,46 @@ // Name: minifram.h // Purpose: interface of wxMiniFrame // Author: wxWidgets team -// RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @class wxMiniFrame - A miniframe is a frame with a small title bar. It is suitable for floating - toolbars that must not - take up too much screen area. + A miniframe is a frame with a small title bar. + It is suitable for floating toolbars that must not take up too much screen area. - An example of mini frame can be seen in the @ref overview_sampledialogs - "dialogs sample" + An example of mini frame can be seen in the @ref page_samples_dialogs using the "Mini frame" command of the "Generic dialogs" submenu. @beginStyleTable @style{wxICONIZE} - Display the frame iconized (minimized) (Windows only). + Display the frame iconized (minimized) (Windows only). @style{wxCAPTION} - Puts a caption on the frame. + Puts a caption on the frame. @style{wxMINIMIZE} - Identical to wxICONIZE. + Identical to wxICONIZE. @style{wxMINIMIZE_BOX} - Displays a minimize box on the frame (Windows and Motif only). + Displays a minimize box on the frame (Windows and Motif only). @style{wxMAXIMIZE} - Displays the frame maximized (Windows only). + Displays the frame maximized (Windows only). @style{wxMAXIMIZE_BOX} - Displays a maximize box on the frame (Windows and Motif only). + Displays a maximize box on the frame (Windows and Motif only). @style{wxCLOSE_BOX} - Displays a close box on the frame. + Displays a close box on the frame. @style{wxSTAY_ON_TOP} - Stay on top of other windows (Windows only). + Stay on top of other windows (Windows only). @style{wxSYSTEM_MENU} - Displays a system menu (Windows and Motif only). - @style{wxTINY_CAPTION_HORIZ} - This style is obsolete and not used any longer. - @style{wxTINY_CAPTION_VERT} - This style is obsolete and not used any longer. + Displays a system menu (Windows and Motif only). @style{wxRESIZE_BORDER} - Displays a resizeable border around the window. + Displays a resizable border around the window. @endStyleTable + @remarks + This class has miniframe functionality under Windows and GTK, i.e. the presence + of mini frame will not be noted in the task bar and focus behaviour is different. + On other platforms, it behaves like a normal frame. + @library{wxcore} @category{managedwnd} @@ -52,7 +50,11 @@ class wxMiniFrame : public wxFrame { public: - //@{ + /** + Default ctor. + */ + wxMiniFrame(); + /** Constructor, creating the window. @@ -60,52 +62,46 @@ public: The window parent. This may be @NULL. If it is non-@NULL, the frame will always be displayed on top of the parent window on Windows. @param id - The window identifier. It may take a value of -1 to indicate a default - value. + The window identifier. It may take a value of -1 to indicate a default value. @param title The caption to be displayed on the frame's title bar. @param pos The window position. The value wxDefaultPosition indicates a default position, - chosen by - either the windowing system or wxWidgets, depending on platform. + chosen by either the windowing system or wxWidgets, depending on platform. @param size The window size. The value wxDefaultSize indicates a default size, chosen by either the windowing system or wxWidgets, depending on platform. @param style The window style. See wxMiniFrame. @param name - The name of the window. This parameter is used to associate a name with the - item, - allowing the application user to set Motif resource values for + The name of the window. This parameter is used to associate a name with + the item, allowing the application user to set Motif resource values for individual windows. @remarks The frame behaves like a normal frame on non-Windows platforms. @see Create() */ - wxMiniFrame(); wxMiniFrame(wxWindow* parent, wxWindowID id, const wxString& title, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxCAPTION | wxRESIZE_BORDER, - const wxString& name = "frame"); - //@} + const wxString& name = wxFrameNameStr); /** Destructor. Destroys all child windows and menu bar if present. */ - ~wxMiniFrame(); + virtual ~wxMiniFrame(); /** - Used in two-step frame construction. See wxMiniFrame() - for further details. + Used in two-step frame construction. + See wxMiniFrame() for further details. */ - bool Create(wxWindow* parent, wxWindowID id, - const wxString& title, + bool Create(wxWindow* parent, wxWindowID id, const wxString& title, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxCAPTION | wxRESIZE_BORDER, - const wxString& name = "frame"); + const wxString& name = wxFrameNameStr); };