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