added wxMessageQueue class for inter-thread communications

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

diff --git a/docs/latex/wx/minifram.tex b/docs/latex/wx/minifram.tex
index e51efd81ca399261c82cdc561a3597a67d9c1fbe..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.
 
 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}\\
 \wxheading{Derived from}
 
 \helpref{wxFrame}{wxframe}\\

+\helpref{wxTopLevelWindow}{wxtoplevelwindow}\\

 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}


@@ -14,13 +18,16 @@ take up too much screen area.
 
 <wx/minifram.h>
 
 
 <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.}
 \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).}
 \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 +35,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{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}}{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{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}).}
+\twocolitem{\windowstyle{wxRESIZE\_BORDER}}{Displays a resizeable border around the window.}

 \end{twocollist}
 
 \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
 \wxheading{Remarks}
 
 This class has miniframe functionality under Windows and GTK, i.e. the presence


@@ -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
 
 \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.
 \param{const wxString\& }{name = ``frame"}}
 
 Constructor, creating the window.


@@ -105,7 +107,7 @@ 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
 
 \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}{wxminiframector}\rtfsp
 \param{const wxString\& }{name = ``frame"}}
 
 Used in two-step frame construction. See \helpref{wxMiniFrame::wxMiniFrame}{wxminiframector}\rtfsp