docs/latex/wx/minifram.tex

   1 \section{\class{wxMiniFrame}}\label{wxminiframe}
   2
   3 A miniframe is a frame with a small title bar. It is suitable for floating toolbars that must not
   4 take up too much screen area.
   5
   6 \wxheading{Derived from}
   7
   8 \helpref{wxFrame}{wxframe}\\
   9 \helpref{wxWindow}{wxwindow}\\
  10 \helpref{wxEvtHandler}{wxevthandler}\\
  11 \helpref{wxObject}{wxobject}
  12
  13 \wxheading{Include files}
  14
  15 <wx/minifram.h>
  16
  17 \wxheading{Window styles}
  18
  19 \twocolwidtha{5cm}
  20 \begin{twocollist}\itemsep=0pt
  21 \twocolitem{\windowstyle{wxICONIZE}}{Display the frame iconized (minimized) (Windows only).}
  22 \twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the frame.}
  23 \twocolitem{\windowstyle{wxDEFAULT\_FRAME\_STYLE}}{Defined as {\bf wxMINIMIZE\_BOX \pipe wxMAXIMIZE\_BOX \pipe wxTHICK\_FRAME \pipe wxSYSTEM\_MENU \pipe wxCAPTION \pipe wxCLOSE\_BOX}.}
  24 \twocolitem{\windowstyle{wxMINIMIZE}}{Identical to {\bf wxICONIZE}.}
  25 \twocolitem{\windowstyle{wxMINIMIZE\_BOX}}{Displays a minimize box on the frame (Windows and Motif only).}
  26 \twocolitem{\windowstyle{wxMAXIMIZE}}{Displays the frame maximized (Windows only).}
  27 \twocolitem{\windowstyle{wxMAXIMIZE\_BOX}}{Displays a maximize box on the frame (Windows and Motif only).}
  28 \twocolitem{\windowstyle{wxCLOSE\_BOX}}{Displays a close box on the frame.}
  29 \twocolitem{\windowstyle{wxSTAY\_ON\_TOP}}{Stay on top of other windows (Windows only).}
  30 \twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Displays a system menu (Windows and Motif only).}
  31 \twocolitem{\windowstyle{wxTHICK\_FRAME}}{Displays a thick frame around the window (Windows and Motif only).}
  32 \twocolitem{\windowstyle{wxTINY\_CAPTION\_HORIZ}}{Displays a small horizontal caption. Use instead of
  33 wxCAPTION.}
  34 \twocolitem{\windowstyle{wxTINY\_CAPTION\_VERT}}{Under Windows, displays a small vertical caption. Use instead of
  35 wxCAPTION.}
  36 \twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Displays a resizeable border around the window (Motif only;
  37 for Windows, it is implicit in {\bf wxTHICK\_FRAME}).}
  38 \end{twocollist}
  39
  40 See also \helpref{window styles overview}{windowstyles}. Note that all the window styles
  41 above are ignored under GTK and the mini frame cannot be resized by the user.
  42
  43 \wxheading{Remarks}
  44
  45 This class has miniframe functionality under Windows and GTK, i.e. the presence
  46 of mini frame will not be noted in the task bar and focus behaviour is different.
  47 On other platforms, it behaves like a normal frame.
  48
  49 \wxheading{See also}
  50
  51 \helpref{wxMDIParentFrame}{wxmdiparentframe}, \helpref{wxMDIChildFrame}{wxmdichildframe},\rtfsp
  52 \helpref{wxFrame}{wxframe}, \helpref{wxDialog}{wxdialog}
  53
  54 \latexignore{\rtfignore{\wxheading{Members}}}
  55
  56 \membersection{wxMiniFrame::wxMiniFrame}\label{wxminiframeconstr}
  57
  58 \func{}{wxMiniFrame}{\void}
  59
  60 Default constructor.
  61
  62 \func{}{wxMiniFrame}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
  63 \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
  64 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
  65 \param{const wxString\& }{name = ``frame"}}
  66
  67 Constructor, creating the window.
  68
  69 \wxheading{Parameters}
  70
  71 \docparam{parent}{The window parent. This may be NULL. If it is non-NULL, the frame will
  72 always be displayed on top of the parent window on Windows.}
  73
  74 \docparam{id}{The window identifier. It may take a value of -1 to indicate a default value.}
  75
  76 \docparam{title}{The caption to be displayed on the frame's title bar.}
  77
  78 \docparam{pos}{The window position. A value of (-1, -1) indicates a default position, chosen by
  79 either the windowing system or wxWindows, depending on platform.}
  80
  81 \docparam{size}{The window size. A value of (-1, -1) indicates a default size, chosen by
  82 either the windowing system or wxWindows, depending on platform.}
  83
  84 \docparam{style}{The window style. See \helpref{wxMiniFrame}{wxminiframe}.}
  85
  86 \docparam{name}{The name of the window. This parameter is used to associate a name with the item,
  87 allowing the application user to set Motif resource values for
  88 individual windows.}
  89
  90 \wxheading{Remarks}
  91
  92 The frame behaves like a normal frame on non-Windows platforms.
  93
  94 \wxheading{See also}
  95
  96 \helpref{wxMiniFrame::Create}{wxminiframecreate}
  97
  98 \membersection{wxMiniFrame::\destruct{wxMiniFrame}}
  99
 100 \func{void}{\destruct{wxMiniFrame}}{\void}
 101
 102 Destructor. Destroys all child windows and menu bar if present.
 103
 104 \membersection{wxMiniFrame::Create}\label{wxminiframecreate}
 105
 106 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
 107 \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
 108 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
 109 \param{const wxString\& }{name = ``frame"}}
 110
 111 Used in two-step frame construction. See \helpref{wxMiniFrame::wxMiniFrame}{wxminiframeconstr}\rtfsp
 112 for further details.
 113
 114
 115