revised m*h headers

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@56227 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-10-11 13:10:48 +00:00
parent bd412bc6b6
commit ba1d7a6cec
13 changed files with 727 additions and 448 deletions

View File

@@ -9,41 +9,44 @@
/**
@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).
Displays a system menu (Windows and Motif only).
@style{wxTINY_CAPTION_HORIZ}
This style is obsolete and not used any longer.
This style is obsolete and not used any longer.
@style{wxTINY_CAPTION_VERT}
This style is obsolete and not used any longer.
This style is obsolete and not used any longer.
@style{wxRESIZE_BORDER}
Displays a resizeable border around the window.
Displays a resizeable 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 +55,11 @@
class wxMiniFrame : public wxFrame
{
public:
//@{
/**
Default ctor.
*/
wxMiniFrame();
/**
Constructor, creating the window.
@@ -60,37 +67,32 @@ 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");
//@}
/**
Destructor. Destroys all child windows and menu bar if present.
@@ -98,8 +100,8 @@ public:
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,