X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/12a44087e448071f9f108208a0a88e908d543d44..0fec2f73ecb616a2189f95c340e9fa7e5cc2350f:/docs/latex/wx/minifram.tex diff --git a/docs/latex/wx/minifram.tex b/docs/latex/wx/minifram.tex index db8cd206b4..e51efd81ca 100644 --- a/docs/latex/wx/minifram.tex +++ b/docs/latex/wx/minifram.tex @@ -10,34 +10,41 @@ take up too much screen area. \helpref{wxEvtHandler}{wxevthandler}\\ \helpref{wxObject}{wxobject} +\wxheading{Include files} + + + \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}.} +\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).} \twocolitem{\windowstyle{wxMAXIMIZE\_BOX}}{Displays a maximize box on the frame (Windows and Motif only).} +\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{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 (Motif only; for Windows, it is implicit in {\bf wxTHICK\_FRAME}).} \end{twocollist} -See also \helpref{window styles overview}{windowstyles}. +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+. On other platforms, -it behaves like a normal frame. +This class has miniframe functionality under Windows and GTK, i.e. the presence +of mini frame will not be noted in the task bar and focus behaviour is different. +On other platforms, it behaves like a normal frame. \wxheading{See also} @@ -46,7 +53,7 @@ it behaves like a normal frame. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxMiniFrame::wxMiniFrame}\label{wxminiframeconstr} +\membersection{wxMiniFrame::wxMiniFrame}\label{wxminiframector} \func{}{wxMiniFrame}{\void} @@ -69,10 +76,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}.} @@ -88,7 +95,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} @@ -101,7 +108,7 @@ Destructor. Destroys all child windows and menu bar if present. \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = wxDEFAULT\_FRAME\_STYLE},\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.