Remove double entry of wxTrackable

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

diff --git a/docs/latex/wx/wizard.tex b/docs/latex/wx/wizard.tex
index c401b8c5c438f6fb59b3f4bf484f145f7805a21d..412017a28d94ceac72cf3212926bcfa27f70a77b 100644 (file)
--- a/docs/latex/wx/wizard.tex
+++ b/docs/latex/wx/wizard.tex
@@ -24,12 +24,22 @@ To show a wizard dialog, you must first create an instance of the wxWizard class
 using either the non-default constructor or a default one followed by call to the 
 \helpref{Create}{wxwizardcreate} function. Then you should add all pages you
 want the wizard to show and call \helpref{RunWizard}{wxwizardrunwizard}.
-Finally, don't forget to call {\tt wizard->Destroy()}.
+Finally, don't forget to call {\tt wizard->Destroy()}, otherwise your application will hang on exit due to an undestroyed window.
+
+You can supply a bitmap to display on the left of the wizard, either for all pages
+or for individual pages. If you need to have the bitmap resize to the height of the wizard,
+call \helpref{wxWizard::SetBitmapPlacement}{wxwizardsetbitmapplacement} and if necessary,\rtfsp
+\helpref{wxWizard::SetBitmapBackgroundColour}{wxwizardsetbitmapbackgroundcolour} and \helpref{wxWizard::SetMinimumBitmapWidth}{wxwizardsetminimumbitmapwidth}.
+
+To make wizard pages scroll when the display is too small to fit the whole dialog, you can switch
+layout adaptation on globally with \helpref{wxDialog::EnableLayoutAdaptation}{wxdialogenablelayoutadaptation} or
+per dialog with \helpref{wxDialog::SetLayoutAdaptationMode}{wxdialogsetlayoutadaptationmode}. For more
+about layout adaptation, see \helpref{Automatic scrolling dialogs}{autoscrollingdialogs}.
 
 \wxheading{Derived from}
 
 \helpref{wxDialog}{wxdialog}\\
-\helpref{wxPanel}{wxpanel}\\
+\helpref{wxTopLevelWindow}{wxtoplevelwindow}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
@@ -38,6 +48,10 @@ Finally, don't forget to call {\tt wizard->Destroy()}.
 
 <wx/wizard.h>
 
+\wxheading{Library}
+
+\helpref{wxAdv}{librarieslist}
+
 \wxheading{Event table macros}
 
 To process input from a wizard dialog, use these event handler macros to
@@ -157,6 +171,33 @@ This is useful if the decision about which pages to show is taken during
 run-time, as in this case, the wizard won't be able to get to all pages starting
 from a single one and you should call {\it Fit} separately for the others.
 
+\membersection{wxWizard::GetBitmap}\label{wxwizardgetbitmap}
+
+\constfunc{const wxBitmap\&}{GetBitmap}{\void}
+
+Returns the bitmap used for the wizard.
+
+
+\membersection{wxWizard::GetBitmapBackgroundColour}\label{wxwizardgetbitmapbackgroundcolour}
+
+\constfunc{const wxColour\&}{GetBitmapBackgroundColour}{\void}
+
+Returns the colour that should be used to fill the area not taken up by the wizard or page bitmap,
+if a non-zero bitmap placement flag has been set.
+
+See also \helpref{wxWizard::SetBitmapPlacement}{wxwizardsetbitmapplacement}.
+
+
+
+\membersection{wxWizard::GetBitmapPlacement}\label{wxwizardgetbitmapplacement}
+
+\func{int}{GetBitmapPlacement}{\void}
+
+Returns the flags indicating how the wizard or page bitmap should be expanded and positioned to fit the
+page height. By default, placement is 0 (no expansion is done).
+
+See also \helpref{wxWizard::SetBitmapPlacement}{wxwizardsetbitmapplacement} for the possible values.
+
 
 \membersection{wxWizard::GetCurrentPage}\label{wxwizardgetcurrentpage}
 
@@ -166,6 +207,16 @@ Get the current page while the wizard is running. {\tt NULL} is returned if
 \helpref{RunWizard()}{wxwizardrunwizard} is not being executed now.
 
 
+\membersection{wxWizard::GetMinimumBitmapWidth}\label{wxwizardgetminimumbitmapwidth}
+
+\constfunc{int}{GetMinimumBitmapWidth}{\void}
+
+Returns the minimum width for the bitmap that will be constructed to contain the actual wizard or page bitmap
+if a non-zero bitmap placement flag has been set.
+
+See also \helpref{wxWizard::SetBitmapPlacement}{wxwizardsetbitmapplacement}.
+
+
 \membersection{wxWizard::GetPageAreaSizer}\label{wxwizardgetpageareasizer}
 
 \constfunc{virtual wxSizer*}{GetPageAreaSizer}{\void}
@@ -241,6 +292,55 @@ Executes the wizard starting from the given page, returning {\tt true} if it was
 successfully finished or {\tt false} if user cancelled it. The {\it firstPage} 
 can not be {\tt NULL}.
 
+\membersection{wxWizard::SetBitmap}\label{wxwizardsetbitmap}
+
+\func{void}{SetBitmap}{\param{const wxBitmap\& }{bitmap}}
+
+Sets the bitmap used for the wizard.
+
+
+\membersection{wxWizard::SetBitmapBackgroundColour}\label{wxwizardsetbitmapbackgroundcolour}
+
+\func{void}{SetBitmapBackgroundColour}{\param{const wxColour\&}{ colour}}
+
+Sets the colour that should be used to fill the area not taken up by the wizard or page bitmap,
+if a non-zero bitmap placement flag has been set.
+
+See also \helpref{wxWizard::SetBitmapPlacement}{wxwizardsetbitmapplacement}.
+
+
+\membersection{wxWizard::SetBitmapPlacement}\label{wxwizardsetbitmapplacement}
+
+\func{void}{SetBitmapPlacement}{\param{int}{ placement}}
+
+Sets the flags indicating how the wizard or page bitmap should be expanded and positioned to fit the
+page height. By default, placement is 0 (no expansion is done). {\it placement} is a bitlist with the
+following possible values:
+
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\windowstyle{wxWIZARD\_VALIGN\_TOP}}{Aligns the bitmap at the top.}
+\twocolitem{\windowstyle{wxWIZARD\_VALIGN\_CENTRE}}{Centres the bitmap vertically.}
+\twocolitem{\windowstyle{wxWIZARD\_VALIGN\_BOTTOM}}{Aligns the bitmap at the bottom.}
+\twocolitem{\windowstyle{wxWIZARD\_HALIGN\_LEFT}}{Left-aligns the bitmap.}
+\twocolitem{\windowstyle{wxWIZARD\_HALIGN\_CENTRE}}{Centres the bitmap horizontally.}
+\twocolitem{\windowstyle{wxWIZARD\_HALIGN\_RIGHT}}{Right-aligns the bitmap.}
+\twocolitem{\windowstyle{wxWIZARD\_TILE}}{}
+\end{twocollist}
+
+See also \helpref{wxWizard::SetMinimumBitmapWidth}{wxwizardsetminimumbitmapwidth}.
+
+
+\membersection{wxWizard::SetMinimumBitmapWidth}\label{wxwizardsetminimumbitmapwidth}
+
+\func{void}{SetMinimumBitmapWidth}{\param{int}{ width}}
+
+Sets the minimum width for the bitmap that will be constructed to contain the actual wizard or page bitmap
+if a non-zero bitmap placement flag has been set. If this is not set when using bitmap placement, the initial
+layout may be incorrect.
+
+See also \helpref{wxWizard::SetBitmapPlacement}{wxwizardsetbitmapplacement}.
+
+
 
 \membersection{wxWizard::SetPageSize}\label{wxwizardsetpagesize}