X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/850c6ed46e3da19d897c2eac500d8917e6b29ced..3cc305b2b4a0674c56c84d7088cfd70676b850f0:/docs/latex/wx/minifram.tex diff --git a/docs/latex/wx/minifram.tex b/docs/latex/wx/minifram.tex index 37ff209d26..a308b9ed2c 100644 --- a/docs/latex/wx/minifram.tex +++ b/docs/latex/wx/minifram.tex @@ -3,6 +3,9 @@ A miniframe is a frame with a small title bar. It is suitable for floating toolbars that must not take up too much screen area. +An example of mini frame can be seen in the \helpref{dialogs sample}{sampledialogs} +using the ``Mini frame'' command of the ``Generic dialogs'' submenu. + \wxheading{Derived from} \helpref{wxFrame}{wxframe}\\ @@ -14,13 +17,16 @@ take up too much screen area. +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{Window styles} \twocolwidtha{5cm} \begin{twocollist}\itemsep=0pt \twocolitem{\windowstyle{wxICONIZE}}{Display the frame iconized (minimized) (Windows only).} \twocolitem{\windowstyle{wxCAPTION}}{Puts a caption on the frame.} -\twocolitem{\windowstyle{wxDEFAULT\_FRAME\_STYLE}}{Defined as {\bf wxMINIMIZE\_BOX \pipe wxMAXIMIZE\_BOX \pipe wxTHICK\_FRAME \pipe wxSYSTEM\_MENU \pipe wxCAPTION \pipe wxCLOSE\_BOX}.} \twocolitem{\windowstyle{wxMINIMIZE}}{Identical to {\bf wxICONIZE}.} \twocolitem{\windowstyle{wxMINIMIZE\_BOX}}{Displays a minimize box on the frame (Windows and Motif only).} \twocolitem{\windowstyle{wxMAXIMIZE}}{Displays the frame maximized (Windows only).} @@ -28,18 +34,13 @@ take up too much screen area. \twocolitem{\windowstyle{wxCLOSE\_BOX}}{Displays a close box on the frame.} \twocolitem{\windowstyle{wxSTAY\_ON\_TOP}}{Stay on top of other windows (Windows only).} \twocolitem{\windowstyle{wxSYSTEM\_MENU}}{Displays a system menu (Windows and Motif only).} -\twocolitem{\windowstyle{wxTHICK\_FRAME}}{Displays a thick frame around the window (Windows and Motif only).} -\twocolitem{\windowstyle{wxTINY\_CAPTION\_HORIZ}}{Displays a small horizontal caption. Use instead of -wxCAPTION.} -\twocolitem{\windowstyle{wxTINY\_CAPTION\_VERT}}{Under Windows, displays a small vertical caption. Use instead of -wxCAPTION.} -\twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Displays a resizeable border around the window (Motif only; -for Windows, it is implicit in {\bf wxTHICK\_FRAME}).} +\twocolitem{\windowstyle{wxTINY\_CAPTION\_HORIZ}}{This style is obsolete and +not used any longer.} +\twocolitem{\windowstyle{wxTINY\_CAPTION\_VERT}}{This style is obsolete and not +used any longer.} +\twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Displays a resizeable border around the window.} \end{twocollist} -See also \helpref{window styles overview}{windowstyles}. Note that all the window styles -above are ignored under GTK and the mini frame cannot be resized by the user. - \wxheading{Remarks} This class has miniframe functionality under Windows and GTK, i.e. the presence @@ -53,7 +54,7 @@ On other platforms, it behaves like a normal frame. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxMiniFrame::wxMiniFrame}\label{wxminiframeconstr} +\membersection{wxMiniFrame::wxMiniFrame}\label{wxminiframector} \func{}{wxMiniFrame}{\void} @@ -61,7 +62,7 @@ Default constructor. \func{}{wxMiniFrame}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp -\param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp +\param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxCAPTION | wxRESIZE\_BORDER},\rtfsp \param{const wxString\& }{name = ``frame"}} Constructor, creating the window. @@ -76,10 +77,10 @@ always be displayed on top of the parent window on Windows.} \docparam{title}{The caption to be displayed on the frame's title bar.} \docparam{pos}{The window position. A value of (-1, -1) indicates a default position, chosen by -either the windowing system or wxWindows, depending on platform.} +either the windowing system or wxWidgets, depending on platform.} \docparam{size}{The window size. A value of (-1, -1) indicates a default size, chosen by -either the windowing system or wxWindows, depending on platform.} +either the windowing system or wxWidgets, depending on platform.} \docparam{style}{The window style. See \helpref{wxMiniFrame}{wxminiframe}.} @@ -95,7 +96,7 @@ The frame behaves like a normal frame on non-Windows platforms. \helpref{wxMiniFrame::Create}{wxminiframecreate} -\membersection{wxMiniFrame::\destruct{wxMiniFrame}} +\membersection{wxMiniFrame::\destruct{wxMiniFrame}}\label{wxminiframedtor} \func{void}{\destruct{wxMiniFrame}}{\void} @@ -105,10 +106,10 @@ Destructor. Destroys all child windows and menu bar if present. \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp \param{const wxString\& }{title}, \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp -\param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\rtfsp +\param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxCAPTION | wxRESIZE\_BORDER},\rtfsp \param{const wxString\& }{name = ``frame"}} -Used in two-step frame construction. See \helpref{wxMiniFrame::wxMiniFrame}{wxminiframeconstr}\rtfsp +Used in two-step frame construction. See \helpref{wxMiniFrame::wxMiniFrame}{wxminiframector}\rtfsp for further details.