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