X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/11e3af6e7eed3c4717608ba2095a688b1fea60e0..15fa4de377053c3c38f62593b2df941c217ea34b:/interface/wx/print.h diff --git a/interface/wx/print.h b/interface/wx/print.h index 53ce4e2f3e..ad0ef0ea31 100644 --- a/interface/wx/print.h +++ b/interface/wx/print.h @@ -3,7 +3,7 @@ // Purpose: interface of wxPreviewControlBar // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -586,6 +586,11 @@ public: @beginWxPythonOnly This method returns the output-only parameters as a tuple. @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl this method takes no arguments and returns a + 2-element list (w, h). + @endWxPerlOnly */ void GetPPIPrinter(int* w, int* h) const; @@ -601,6 +606,11 @@ public: @beginWxPythonOnly This method returns the output-only parameters as a tuple. @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl this method takes no arguments and returns a + 2-element list (w, h). + @endWxPerlOnly */ void GetPPIScreen(int* w, int* h) const; @@ -630,6 +640,11 @@ public: @beginWxPythonOnly This method returns the output-only parameters as a tuple. @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl this method takes no arguments and returns a + 2-element list (w, h). + @endWxPerlOnly */ void GetPageSizeMM(int* w, int* h) const; @@ -646,6 +661,11 @@ public: @beginWxPythonOnly This method returns the output-only parameters as a tuple. @endWxPythonOnly + + @beginWxPerlOnly + In wxPerl this method takes no arguments and returns a + 2-element list (w, h). + @endWxPerlOnly */ void GetPageSizePixels(int* w, int* h) const; @@ -688,9 +708,26 @@ public: /** Returns @true if the printout is currently being used for previewing. + + @see GetPreview() */ virtual bool IsPreview() const; + /** + Returns the associated preview object if any. + + If this printout object is used for previewing, returns the associated + wxPrintPreview. Otherwise returns @NULL. + + The returned pointer is not owned by the printout and must not be + deleted. + + @see IsPreview() + + @since 2.9.1. + */ + wxPrintPreview *GetPreview() const; + /** Set the user scale and device origin of the wxDC associated with this wxPrintout so that one screen pixel maps to one device pixel on the DC. @@ -710,14 +747,14 @@ public: void MapScreenSizeToDevice(); /** - This sets the user scale of the wxDC assocated with this wxPrintout to the same + This sets the user scale of the wxDC associated with this wxPrintout to the same scale as MapScreenSizeToPaper() but sets the logical origin to the top left corner of the page rectangle. */ void MapScreenSizeToPage(); /** - This sets the user scale of the wxDC assocated with this wxPrintout to the same + This sets the user scale of the wxDC associated with this wxPrintout to the same scale as MapScreenSizeToPageMargins() but sets the logical origin to the top left corner of the page margins specified by the given wxPageSetupDialogData object. */ @@ -733,7 +770,7 @@ public: (It will, of course, be larger or smaller in the preview image, depending on the zoom factor.) - Use this if you want WYSIWYG behavior, e.g., in a text editor. + Use this if you want WYSIWYG behaviour, e.g., in a text editor. */ void MapScreenSizeToPaper();