X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7c913512a4c9f36e11e07ea707002fab1608d324..9602ce3d8ca47689bb69d09dbdd09152f2bde8c3:/interface/minifram.h diff --git a/interface/minifram.h b/interface/minifram.h index bb92da3ae8..c11b24e602 100644 --- a/interface/minifram.h +++ b/interface/minifram.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: minifram.h -// Purpose: documentation for wxMiniFrame class +// Purpose: interface of wxMiniFrame // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -16,40 +16,39 @@ An example of mini frame can be seen in the @ref overview_sampledialogs "dialogs sample" - using the "Mini frame'' command of the "Generic dialogs'' submenu. + using the "Mini frame" command of the "Generic dialogs" submenu. @beginStyleTable - @style{wxICONIZE}: + @style{wxICONIZE} Display the frame iconized (minimized) (Windows only). - @style{wxCAPTION}: + @style{wxCAPTION} Puts a caption on the frame. - @style{wxMINIMIZE}: + @style{wxMINIMIZE} Identical to wxICONIZE. - @style{wxMINIMIZE_BOX}: + @style{wxMINIMIZE_BOX} Displays a minimize box on the frame (Windows and Motif only). - @style{wxMAXIMIZE}: + @style{wxMAXIMIZE} Displays the frame maximized (Windows only). - @style{wxMAXIMIZE_BOX}: + @style{wxMAXIMIZE_BOX} Displays a maximize box on the frame (Windows and Motif only). - @style{wxCLOSE_BOX}: + @style{wxCLOSE_BOX} Displays a close box on the frame. - @style{wxSTAY_ON_TOP}: + @style{wxSTAY_ON_TOP} Stay on top of other windows (Windows only). - @style{wxSYSTEM_MENU}: + @style{wxSYSTEM_MENU} Displays a system menu (Windows and Motif only). - @style{wxTINY_CAPTION_HORIZ}: + @style{wxTINY_CAPTION_HORIZ} This style is obsolete and not used any longer. - @style{wxTINY_CAPTION_VERT}: + @style{wxTINY_CAPTION_VERT} This style is obsolete and not used any longer. - @style{wxRESIZE_BORDER}: + @style{wxRESIZE_BORDER} Displays a resizeable border around the window. @endStyleTable @library{wxcore} @category{managedwnd} - @seealso - wxMDIParentFrame, wxMDIChildFrame, wxFrame, wxDialog + @see wxMDIParentFrame, wxMDIChildFrame, wxFrame, wxDialog */ class wxMiniFrame : public wxFrame { @@ -57,37 +56,33 @@ public: //@{ /** Constructor, creating the window. - + @param parent - 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. - + 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. - + 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. - + The window position. The value wxDefaultPosition indicates a default position, + 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. - + 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. - + The window style. See wxMiniFrame. @param name - The name of the window. This parameter is used to associate a name with the + 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. - + allowing the application user to set Motif resource values for + individual windows. + @remarks The frame behaves like a normal frame on non-Windows platforms. - - @sa Create() + + @see Create() */ wxMiniFrame(); wxMiniFrame(wxWindow* parent, wxWindowID id, @@ -114,3 +109,4 @@ public: long style = wxCAPTION | wxRESIZE_BORDER, const wxString& name = "frame"); }; +