]>
git.saurik.com Git - wxWidgets.git/blob - interface/wx/minifram.h
1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxMiniFrame
4 // Author: wxWidgets team
6 // Licence: wxWindows license
7 /////////////////////////////////////////////////////////////////////////////
12 A miniframe is a frame with a small title bar.
13 It is suitable for floating toolbars that must not take up too much screen area.
15 An example of mini frame can be seen in the @ref page_samples_dialogs
16 using the "Mini frame" command of the "Generic dialogs" submenu.
20 Display the frame iconized (minimized) (Windows only).
22 Puts a caption on the frame.
24 Identical to wxICONIZE.
25 @style{wxMINIMIZE_BOX}
26 Displays a minimize box on the frame (Windows and Motif only).
28 Displays the frame maximized (Windows only).
29 @style{wxMAXIMIZE_BOX}
30 Displays a maximize box on the frame (Windows and Motif only).
32 Displays a close box on the frame.
34 Stay on top of other windows (Windows only).
36 Displays a system menu (Windows and Motif only).
37 @style{wxTINY_CAPTION_HORIZ}
38 This style is obsolete and not used any longer.
39 @style{wxTINY_CAPTION_VERT}
40 This style is obsolete and not used any longer.
41 @style{wxRESIZE_BORDER}
42 Displays a resizeable border around the window.
46 This class has miniframe functionality under Windows and GTK, i.e. the presence
47 of mini frame will not be noted in the task bar and focus behaviour is different.
48 On other platforms, it behaves like a normal frame.
53 @see wxMDIParentFrame, wxMDIChildFrame, wxFrame, wxDialog
55 class wxMiniFrame
: public wxFrame
64 Constructor, creating the window.
67 The window parent. This may be @NULL. If it is non-@NULL, the frame will
68 always be displayed on top of the parent window on Windows.
70 The window identifier. It may take a value of -1 to indicate a default value.
72 The caption to be displayed on the frame's title bar.
74 The window position. The value wxDefaultPosition indicates a default position,
75 chosen by either the windowing system or wxWidgets, depending on platform.
77 The window size. The value wxDefaultSize indicates a default size, chosen by
78 either the windowing system or wxWidgets, depending on platform.
80 The window style. See wxMiniFrame.
82 The name of the window. This parameter is used to associate a name with
83 the item, allowing the application user to set Motif resource values for
86 @remarks The frame behaves like a normal frame on non-Windows platforms.
90 wxMiniFrame(wxWindow
* parent
, wxWindowID id
,
91 const wxString
& title
,
92 const wxPoint
& pos
= wxDefaultPosition
,
93 const wxSize
& size
= wxDefaultSize
,
94 long style
= wxCAPTION
| wxRESIZE_BORDER
,
95 const wxString
& name
= "frame");
98 Destructor. Destroys all child windows and menu bar if present.
100 virtual ~wxMiniFrame();
103 Used in two-step frame construction.
104 See wxMiniFrame() for further details.
106 bool Create(wxWindow
* parent
, wxWindowID id
, const wxString
& title
,
107 const wxPoint
& pos
= wxDefaultPosition
,
108 const wxSize
& size
= wxDefaultSize
,
109 long style
= wxCAPTION
| wxRESIZE_BORDER
,
110 const wxString
& name
= wxFrameNameStr
);