added wxWindow::AlwaysShowScrollbars() and its wxMac implementation

[wxWidgets.git] / docs / latex / wx / minifram.tex

diff --git a/docs/latex/wx/minifram.tex b/docs/latex/wx/minifram.tex
index 4a7b73e060ee3323cbfaeae697d39eb83f53ad3b..94be6ca012951e2023a03e20a865ecf4ad4df9ec 100644 (file)
--- a/docs/latex/wx/minifram.tex
+++ b/docs/latex/wx/minifram.tex
@@ -3,9 +3,13 @@
 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}\\
+\helpref{wxTopLevelWindow}{wxtoplevelwindow}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
@@ -14,32 +18,30 @@ take up too much screen area.
 
 <wx/minifram.h>
 
+\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}.}
 \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}}{Displays a close box on the frame.}
+\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 +55,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 +63,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 +78,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 +97,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 +107,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.