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}.}
  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{wxSTAY\_ON\_TOP}}{Stay on top of other windows (Windows only).}
  29 \twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Displays a system menu (Windows and Motif only).}
  30 \twocolitem{\windowstyle{wxTHICK\_FRAME}}{Displays a thick frame around the window (Windows and Motif only).}
  31 \twocolitem{\windowstyle{wxTINY\_CAPTION\_HORIZ}}{Displays a small horizontal caption. Use instead of
  32 wxCAPTION.}
  33 \twocolitem{\windowstyle{wxTINY\_CAPTION\_VERT}}{Under Windows, displays a small vertical caption. Use instead of
  34 wxCAPTION.}
  35 \twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Displays a resizeable border around the window (Motif only;
  36 for Windows, it is implicit in {\bf wxTHICK\_FRAME}).}
  37 \end{twocollist}
  38
  39 See also \helpref{window styles overview}{windowstyles}. Note that all the window styles
  40 above are ignored under GTK and the mini frame cannot be resized by the user.
  41
  42 \wxheading{Remarks}
  43
  44 This class has miniframe functionality under Windows and GTK, i.e. the presence
  45 of mini frame will not be noted in the task bar and focus behaviour is different.
  46 On other platforms, it behaves like a normal frame.
  47
  48 \wxheading{See also}
  49
  50 \helpref{wxMDIParentFrame}{wxmdiparentframe}, \helpref{wxMDIChildFrame}{wxmdichildframe},\rtfsp
  51 \helpref{wxFrame}{wxframe}, \helpref{wxDialog}{wxdialog}
  52
  53 \latexignore{\rtfignore{\wxheading{Members}}}
  54
  55 \membersection{wxMiniFrame::wxMiniFrame}\label{wxminiframeconstr}
  56
  57 \func{}{wxMiniFrame}{\void}
  58
  59 Default constructor.
  60
  61 \func{}{wxMiniFrame}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
  62 \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
  63 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
  64 \param{const wxString\& }{name = ``frame"}}
  65
  66 Constructor, creating the window.
  67
  68 \wxheading{Parameters}
  69
  70 \docparam{parent}{The window parent. This may be NULL. If it is non-NULL, the frame will
  71 always be displayed on top of the parent window on Windows.}
  72
  73 \docparam{id}{The window identifier. It may take a value of -1 to indicate a default value.}
  74
  75 \docparam{title}{The caption to be displayed on the frame's title bar.}
  76
  77 \docparam{pos}{The window position. A value of (-1, -1) indicates a default position, chosen by
  78 either the windowing system or wxWindows, depending on platform.}
  79
  80 \docparam{size}{The window size. A value of (-1, -1) indicates a default size, chosen by
  81 either the windowing system or wxWindows, depending on platform.}
  82
  83 \docparam{style}{The window style. See \helpref{wxMiniFrame}{wxminiframe}.}
  84
  85 \docparam{name}{The name of the window. This parameter is used to associate a name with the item,
  86 allowing the application user to set Motif resource values for
  87 individual windows.}
  88
  89 \wxheading{Remarks}
  90
  91 The frame behaves like a normal frame on non-Windows platforms.
  92
  93 \wxheading{See also}
  94
  95 \helpref{wxMiniFrame::Create}{wxminiframecreate}
  96
  97 \membersection{wxMiniFrame::\destruct{wxMiniFrame}}
  98
  99 \func{void}{\destruct{wxMiniFrame}}{\void}
 100
 101 Destructor. Destroys all child windows and menu bar if present.
 102
 103 \membersection{wxMiniFrame::Create}\label{wxminiframecreate}
 104
 105 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
 106 \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
 107 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp
 108 \param{const wxString\& }{name = ``frame"}}
 109
 110 Used in two-step frame construction. See \helpref{wxMiniFrame::wxMiniFrame}{wxminiframeconstr}\rtfsp
 111 for further details.
 112
 113
 114