revisions of o-p headers contributed by Utensil Candel and revised by me

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53116 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-04-10 21:16:38 +00:00
parent b3623ed593
commit b1b95a653c
13 changed files with 714 additions and 414 deletions

View File

@@ -11,20 +11,21 @@
@wxheader{printdlg.h}
This class represents the print and print setup common dialogs.
You may obtain a wxPrinterDC device context from
a successfully dismissed print dialog.
You may obtain a wxPrinterDC device context from a successfully dismissed
print dialog.
@library{wxcore}
@category{printing}
@see @ref overview_printingoverview "Printing framework overview", @ref
overview_wxprintdialogoverview "wxPrintDialog Overview"
@see @ref overview_printing, @ref overview_cmndlg_print
*/
class wxPrintDialog : public wxDialog
{
public:
/**
Constructor. Pass a parent window, and optionally a pointer to a block of print
Constructor.
Pass a parent window, and optionally a pointer to a block of print
data, which will be copied to the print dialog's print data.
@see wxPrintDialogData
@@ -32,13 +33,16 @@ public:
wxPrintDialog(wxWindow* parent, wxPrintDialogData* data = NULL);
/**
Destructor. If GetPrintDC() has @e not been called,
the device context obtained by the dialog (if any) will be deleted.
Destructor.
If GetPrintDC() has not been called, the device context obtained by
the dialog (if any) will be deleted.
*/
~wxPrintDialog();
/**
Returns the device context created by the print dialog, if any.
When this function has been called, the ownership of the device context
is transferred to the application, so it must then be deleted
explicitly.
@@ -46,15 +50,17 @@ public:
wxDC* GetPrintDC();
/**
Returns the @ref overview_wxprintdialogdata "print dialog data" associated with
the print dialog.
Returns the @ref overview_printing_printdata "print dialog data" associated
with the print dialog.
*/
wxPrintDialogData GetPrintDialogData();
/**
Shows the dialog, returning wxID_OK if the user pressed OK, and wxID_CANCEL
otherwise. After this function is called, a device context may
be retrievable using GetPrintDC().
Shows the dialog, returning @c wxID_OK if the user pressed OK, and @c
wxID_CANCEL otherwise.
After this function is called, a device context may be retrievable using
GetPrintDC().
*/
int ShowModal();
};
@@ -67,9 +73,9 @@ public:
This class represents the page setup common dialog. In MSW, the page setup
dialog is standard from Windows 95 on, replacing the print setup dialog (which
is retained in Windows and wxWidgets for backward compatibility). On Windows 95
and NT 4.0 and above, the page setup dialog is native to the windowing system,
otherwise it is emulated.
is retained in Windows and wxWidgets for backward compatibility).
On Windows 95 and NT 4.0 and above, the page setup dialog is native to the windowing
system, otherwise it is emulated.
The page setup dialog contains controls for paper size (A4, A5 etc.),
orientation (landscape or portrait), and controls for setting left, top, right
@@ -80,9 +86,8 @@ public:
On other platforms, a generic dialog is used.
When the dialog has been closed, you need to query the
wxPageSetupDialogData object associated with
the dialog.
When the dialog has been closed, you need to query the wxPageSetupDialogData
object associated with the dialog.
Note that the OK and Cancel buttons do not destroy the dialog; this must be done
by the application.
@@ -90,19 +95,19 @@ public:
@library{wxcore}
@category{printing}
@see @ref overview_printingoverview "Printing framework overview",
wxPrintDialog, wxPageSetupDialogData
@see @ref overview_printing "Printing framework overview",
wxPrintDialog, wxPageSetupDialogData
*/
class wxPageSetupDialog : public wxDialog
{
public:
/**
Constructor. Pass a parent window, and optionally a pointer to a block of page
setup
data, which will be copied to the print dialog's internal data.
Constructor.
Pass a parent window, and optionally a pointer to a block of page
setup data, which will be copied to the print dialog's internal data.
*/
wxPageSetupDialog(wxWindow* parent,
wxPageSetupDialogData* data = NULL);
wxPageSetupDialog(wxWindow* parent, wxPageSetupDialogData* data = NULL);
/**
Destructor.
@@ -110,14 +115,13 @@ public:
~wxPageSetupDialog();
/**
Returns the @ref overview_wxpagesetupdialogdata "page setup data" associated
with the dialog.
Returns the wxPageSetupDialogData object associated with the dialog.
*/
wxPageSetupDialogData GetPageSetupData();
wxPageSetupDialogData& GetPageSetupData();
/**
Shows the dialog, returning wxID_OK if the user pressed OK, and wxID_CANCEL
otherwise.
Shows the dialog, returning @c wxID_OK if the user pressed OK, and
@c wxID_CANCEL otherwise.
*/
int ShowModal();
};