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