]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/prevwin.tex
Whole bunch of minor doc updates from an external patch.
[wxWidgets.git] / docs / latex / wx / prevwin.tex
index fbf2203a4fe8ed5595323fb81b4fab057d266b45..aaddfcada5c579e6034b23c6a57a1f1a2f80f78a 100644 (file)
@@ -1,4 +1,3 @@
-
 \section{\class{wxPreviewCanvas}}\label{wxpreviewcanvas}
 
 A preview canvas is the default canvas used by the print preview
@@ -11,6 +10,10 @@ system to display the preview.
 \helpref{wxevthandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/print.h>
+
 \wxheading{See also}
 
 \helpref{wxPreviewFrame}{wxpreviewframe}, \helpref{wxPreviewControlBar}{wxpreviewcontrolbar},\rtfsp
@@ -18,7 +21,7 @@ system to display the preview.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxPreviewCanvas::wxPreviewCanvas}
+\membersection{wxPreviewCanvas::wxPreviewCanvas}\label{wxpreviewcanvasctor}
 
 \func{}{wxPreviewCanvas}{\param{wxPrintPreview* }{preview}, \param{wxWindow* }{parent},
  \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},
@@ -26,7 +29,7 @@ system to display the preview.
 
 Constructor.
 
-\membersection{wxPreviewCanvas::\destruct{wxPreviewCanvas}}
+\membersection{wxPreviewCanvas::\destruct{wxPreviewCanvas}}\label{wxpreviewcanvasdtor}
 
 \func{}{\destruct{wxPreviewCanvas}}{\void}
 
@@ -52,6 +55,10 @@ or you can leave it as it is.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/print.h>
+
 \wxheading{See also}
 
 \helpref{wxPreviewFrame}{wxpreviewframe}, \helpref{wxPreviewCanvas}{wxpreviewcanvas},\rtfsp
@@ -59,7 +66,7 @@ or you can leave it as it is.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxPreviewControlBar::wxPreviewControlbar}
+\membersection{wxPreviewControlBar::wxPreviewControlbar}\label{wxpreviewcontrolbarctor}
 
 \func{}{wxPreviewControlBar}{\param{wxPrintPreview* }{preview}, \param{long}{ buttons}, \param{wxWindow* }{parent},
  \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},
@@ -78,31 +85,31 @@ The buttons parameter may be a combination of the following, using the bitwise `
 wxPREVIEW\_ZOOM.}
 \end{twocollist}
 
-\membersection{wxPreviewControlBar::\destruct{wxPreviewControlBar}}
+\membersection{wxPreviewControlBar::\destruct{wxPreviewControlBar}}\label{wxpreviewcontrolbardtor}
 
 \func{}{\destruct{wxPreviewControlBar}}{\void}
 
 Destructor.
 
-\membersection{wxPreviewControlBar::CreateButtons}
+\membersection{wxPreviewControlBar::CreateButtons}\label{wxpreviewcontrolbarcreatebuttons}
 
 \func{void}{CreateButtons}{\void}
 
 Creates buttons, according to value of the button style flags.
 
-\membersection{wxPreviewControlBar::GetPrintPreview}
+\membersection{wxPreviewControlBar::GetPrintPreview}\label{wxpreviewcontrolbargetprintpreview}
 
 \func{wxPrintPreview *}{GetPrintPreview}{\void}
 
 Gets the print preview object associated with the control bar.
 
-\membersection{wxPreviewControlBar::GetZoomControl}
+\membersection{wxPreviewControlBar::GetZoomControl}\label{wxpreviewcontrolbargetzoomcontrol}
 
 \func{int}{GetZoomControl}{\void}
 
 Gets the current zoom setting in percent.
 
-\membersection{wxPreviewControlBar::SetZoomControl}
+\membersection{wxPreviewControlBar::SetZoomControl}\label{wxpreviewcontrolbarsetzoomcontrol}
 
 \func{void}{SetZoomControl}{\param{int }{percent}}
 
@@ -121,6 +128,10 @@ class may be used without derivation.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Include files}
+
+<wx/print.h>
+
 \wxheading{See also}
 
 \helpref{wxPreviewCanvas}{wxpreviewcanvas}, \helpref{wxPreviewControlBar}{wxpreviewcontrolbar},\rtfsp
@@ -128,46 +139,47 @@ class may be used without derivation.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxPreviewFrame::wxPreviewFrame}
+\membersection{wxPreviewFrame::wxPreviewFrame}\label{wxpreviewframector}
 
-\func{}{wxPreviewFrame}{\param{wxPrintPreview* }{preview}, \param{wxFrame* }{parent}, \param{const wxString\& }{title},
+\func{}{wxPreviewFrame}{\param{wxPrintPreview* }{preview}, \param{wxWindow* }{parent}, \param{const wxString\& }{title},
  \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& size }{size = wxDefaultSize},
  \param{long}{ style = wxDEFAULT\_FRAME\_STYLE}, \param{const wxString\& }{name = ``frame"}}
 
 Constructor. Pass a print preview object plus other normal frame arguments.
+The print preview object will be destroyed by the frame when it closes.
 
-\membersection{wxPreviewFrame::\destruct{wxPreviewFrame}}
+\membersection{wxPreviewFrame::\destruct{wxPreviewFrame}}\label{wxpreviewframedtor}
 
 \func{}{\destruct{wxPreviewFrame}}{\void}
 
 Destructor. 
 
-\membersection{wxPreviewFrame::CreateControlBar}
+\membersection{wxPreviewFrame::CreateControlBar}\label{wxpreviewframecreatecontrolbar}
 
 \func{void}{CreateControlBar}{\void}
 
 Creates a wxPreviewControlBar. Override this function to allow
 a user-defined preview control bar object to be created.
 
-\membersection{wxPreviewFrame::CreateCanvas}
+\membersection{wxPreviewFrame::CreateCanvas}\label{wxpreviewframecreatecanvas}
 
 \func{void}{CreateCanvas}{\void}
 
 Creates a wxPreviewCanvas. Override this function to allow
 a user-defined preview canvas object to be created.
 
-\membersection{wxPreviewFrame::Initialize}
+\membersection{wxPreviewFrame::Initialize}\label{wxpreviewframeinitialize}
 
 \func{void}{Initialize}{\void}
 
 Creates the preview canvas and control bar, and calls
-wxWindow::MakeModal(TRUE) to disable other top-level windows
+wxWindow::MakeModal(true) to disable other top-level windows
 in the application.
 
 This function should be called by the application prior to
 showing the frame.
 
-\membersection{wxPreviewFrame::OnCloseWindow}
+\membersection{wxPreviewFrame::OnCloseWindow}\label{wxpreviewframeonclosewindow}
 
 \func{void}{OnCloseWindow}{\param{wxCloseEvent\&}{ event}}