Fix missing documentation for several GDI functions.

[wxWidgets.git] / include / wx / gtk / print.h

diff --git a/include/wx/gtk/print.h b/include/wx/gtk/print.h
index 66f34f0702a8d4da53e48f4b23c086e7df3fcda6..180d0c6e88f9dccfe70cf1ca65b77682cb1786c0 100644 (file)
--- a/include/wx/gtk/print.h
+++ b/include/wx/gtk/print.h
@@ -3,7 +3,7 @@
 // Author:      Anthony Bretaudeau
 // Purpose:     GTK printing support
 // Created:     2007-08-25
 // Author:      Anthony Bretaudeau
 // Purpose:     GTK printing support
 // Created:     2007-08-25

-// RCS-ID:      $Id: print.h,v 1 2007-08-25 05:44:44 PC Exp $
+// RCS-ID:      $Id$

 // Copyright:   (c) Anthony Bretaudeau
 // Licence:     wxWindows Licence
 /////////////////////////////////////////////////////////////////////////////
 // Copyright:   (c) Anthony Bretaudeau
 // Licence:     wxWindows Licence
 /////////////////////////////////////////////////////////////////////////////


@@ -19,8 +19,6 @@
 #include "wx/printdlg.h"
 #include "wx/prntbase.h"
 #include "wx/dc.h"
 #include "wx/printdlg.h"
 #include "wx/prntbase.h"
 #include "wx/dc.h"

-#include "wx/cairo.h"
-

 
 typedef struct _GtkPrintOperation GtkPrintOperation;
 typedef struct _GtkPrintContext GtkPrintContext;
 
 typedef struct _GtkPrintOperation GtkPrintOperation;
 typedef struct _GtkPrintContext GtkPrintContext;


@@ -174,7 +172,7 @@ private:
     wxDC            *m_dc;
 
     DECLARE_DYNAMIC_CLASS(wxGtkPrinter)
     wxDC            *m_dc;
 
     DECLARE_DYNAMIC_CLASS(wxGtkPrinter)

-    DECLARE_NO_COPY_CLASS(wxGtkPrinter)
+    wxDECLARE_NO_COPY_CLASS(wxGtkPrinter);

 };
 
 //----------------------------------------------------------------------------
 };
 
 //----------------------------------------------------------------------------


@@ -196,8 +194,8 @@ public:
     GtkPrintSettings* GetPrintConfig() { return m_config; }
     void SetPrintConfig( GtkPrintSettings * config );
 
     GtkPrintSettings* GetPrintConfig() { return m_config; }
     void SetPrintConfig( GtkPrintSettings * config );
 

-    void SetPrintJob( GtkPrintOperation *job ) { m_job = job; }

     GtkPrintOperation* GetPrintJob() { return m_job; }
     GtkPrintOperation* GetPrintJob() { return m_job; }

+    void SetPrintJob(GtkPrintOperation *job) { m_job = job; }

 
     GtkPrintContext *GetPrintContext() { return m_context; }
     void SetPrintContext(GtkPrintContext *context) {m_context = context; }
 
     GtkPrintContext *GetPrintContext() { return m_context; }
     void SetPrintContext(GtkPrintContext *context) {m_context = context; }


@@ -207,6 +205,8 @@ public:
     void SetPageSetupToSettings(GtkPrintSettings* settings, GtkPageSetup* page_setup);
 
 private:
     void SetPageSetupToSettings(GtkPrintSettings* settings, GtkPageSetup* page_setup);
 
 private:

+    // NB: m_config is created and owned by us, but the other objects are not
+    //     and their accessors don't change their ref count.

     GtkPrintSettings    *m_config;
     GtkPrintOperation   *m_job;
     GtkPrintContext     *m_context;
     GtkPrintSettings    *m_config;
     GtkPrintOperation   *m_job;
     GtkPrintContext     *m_context;


@@ -228,13 +228,14 @@ public:
     bool IsOk() const;
 
     virtual void* GetCairoContext() const;
     bool IsOk() const;
 
     virtual void* GetCairoContext() const;

-
+    virtual void* GetHandle() const;
+    

     bool CanDrawBitmap() const { return true; }
     void Clear();
     void SetFont( const wxFont& font );
     void SetPen( const wxPen& pen );
     void SetBrush( const wxBrush& brush );
     bool CanDrawBitmap() const { return true; }
     void Clear();
     void SetFont( const wxFont& font );
     void SetPen( const wxPen& pen );
     void SetBrush( const wxBrush& brush );

-    void SetLogicalFunction( int function );
+    void SetLogicalFunction( wxRasterOperationMode function );

     void SetBackground( const wxBrush& brush );
     void DestroyClippingRegion();
     bool StartDoc(const wxString& message);
     void SetBackground( const wxBrush& brush );
     void DestroyClippingRegion();
     bool StartDoc(const wxString& message);


@@ -249,13 +250,14 @@ public:
     void SetBackgroundMode(int mode);
     void SetPalette(const wxPalette& WXUNUSED(palette)) { }
     void SetResolution(int ppi);
     void SetBackgroundMode(int mode);
     void SetPalette(const wxPalette& WXUNUSED(palette)) { }
     void SetResolution(int ppi);

-    
-    // overriden for wxPrinterDC Impl
-    virtual int GetResolution();
-    virtual wxRect GetPaperRect();
+
+    // overridden for wxPrinterDC Impl
+    virtual int GetResolution() const;
+    virtual wxRect GetPaperRect() const;

 
 protected:
 
 protected:

-    bool DoFloodFill(wxCoord x1, wxCoord y1, const wxColour &col, int style=wxFLOOD_SURFACE );
+    bool DoFloodFill(wxCoord x1, wxCoord y1, const wxColour &col,
+                     wxFloodFillStyle style=wxFLOOD_SURFACE );

     void DoGradientFillConcentric(const wxRect& rect, const wxColour& initialColour, const wxColour& destColour, const wxPoint& circleCenter);
     void DoGradientFillLinear(const wxRect& rect, const wxColour& initialColour, const wxColour& destColour, wxDirection nDirection = wxEAST);
     bool DoGetPixel(wxCoord x1, wxCoord y1, wxColour *col) const;
     void DoGradientFillConcentric(const wxRect& rect, const wxColour& initialColour, const wxColour& destColour, const wxPoint& circleCenter);
     void DoGradientFillLinear(const wxRect& rect, const wxColour& initialColour, const wxColour& destColour, wxDirection nDirection = wxEAST);
     bool DoGetPixel(wxCoord x1, wxCoord y1, wxColour *col) const;


@@ -264,9 +266,9 @@ protected:
     void DoDrawArc(wxCoord x1,wxCoord y1,wxCoord x2,wxCoord y2,wxCoord xc,wxCoord yc);
     void DoDrawEllipticArc(wxCoord x,wxCoord y,wxCoord w,wxCoord h,double sa,double ea);
     void DoDrawPoint(wxCoord x, wxCoord y);
     void DoDrawArc(wxCoord x1,wxCoord y1,wxCoord x2,wxCoord y2,wxCoord xc,wxCoord yc);
     void DoDrawEllipticArc(wxCoord x,wxCoord y,wxCoord w,wxCoord h,double sa,double ea);
     void DoDrawPoint(wxCoord x, wxCoord y);

-    void DoDrawLines(int n, wxPoint points[], wxCoord xoffset = 0, wxCoord yoffset = 0);
-    void DoDrawPolygon(int n, wxPoint points[], wxCoord xoffset = 0, wxCoord yoffset = 0, int fillStyle=wxODDEVEN_RULE);
-    void DoDrawPolyPolygon(int n, int count[], wxPoint points[], wxCoord xoffset = 0, wxCoord yoffset = 0, int fillStyle=wxODDEVEN_RULE);
+    void DoDrawLines(int n, const wxPoint points[], wxCoord xoffset = 0, wxCoord yoffset = 0);
+    void DoDrawPolygon(int n, const wxPoint points[], wxCoord xoffset = 0, wxCoord yoffset = 0, wxPolygonFillMode fillStyle=wxODDEVEN_RULE);
+    void DoDrawPolyPolygon(int n, const int count[], const wxPoint points[], wxCoord xoffset = 0, wxCoord yoffset = 0, wxPolygonFillMode fillStyle=wxODDEVEN_RULE);

     void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
     void DoDrawRoundedRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height, double radius = 20.0);
     void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
     void DoDrawRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height);
     void DoDrawRoundedRectangle(wxCoord x, wxCoord y, wxCoord width, wxCoord height, double radius = 20.0);
     void DoDrawEllipse(wxCoord x, wxCoord y, wxCoord width, wxCoord height);


@@ -274,7 +276,8 @@ protected:
     void DoDrawSpline(const wxPointList *points);
 #endif
     bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,
     void DoDrawSpline(const wxPointList *points);
 #endif
     bool DoBlit(wxCoord xdest, wxCoord ydest, wxCoord width, wxCoord height,

-            wxDC *source, wxCoord xsrc, wxCoord ysrc, int rop = wxCOPY, bool useMask = false,
+            wxDC *source, wxCoord xsrc, wxCoord ysrc,
+            wxRasterOperationMode rop = wxCOPY, bool useMask = false,

             wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord);
     void DoDrawIcon( const wxIcon& icon, wxCoord x, wxCoord y );
     void DoDrawBitmap( const wxBitmap& bitmap, wxCoord x, wxCoord y, bool useMask = false  );
             wxCoord xsrcMask = wxDefaultCoord, wxCoord ysrcMask = wxDefaultCoord);
     void DoDrawIcon( const wxIcon& icon, wxCoord x, wxCoord y );
     void DoDrawBitmap( const wxBitmap& bitmap, wxCoord x, wxCoord y, bool useMask = false  );


@@ -286,9 +289,9 @@ protected:
         wxFAIL_MSG( "not implemented" );
     }
     void DoGetTextExtent(const wxString& string, wxCoord *x, wxCoord *y,
         wxFAIL_MSG( "not implemented" );
     }
     void DoGetTextExtent(const wxString& string, wxCoord *x, wxCoord *y,

-                     wxCoord *descent = (wxCoord *) NULL,
-                     wxCoord *externalLeading = (wxCoord *) NULL,
-                     const wxFont *theFont = (wxFont *) NULL ) const;
+                     wxCoord *descent = NULL,
+                     wxCoord *externalLeading = NULL,
+                     const wxFont *theFont = NULL ) const;

     void DoGetSize(int* width, int* height) const;
     void DoGetSizeMM(int *width, int *height) const;
 
     void DoGetSize(int* width, int* height) const;
     void DoGetSizeMM(int *width, int *height) const;
 


@@ -313,7 +316,7 @@ private:
     double                  m_DEV2PS;
 
     DECLARE_DYNAMIC_CLASS(wxGtkPrinterDCImpl)
     double                  m_DEV2PS;
 
     DECLARE_DYNAMIC_CLASS(wxGtkPrinterDCImpl)

-    DECLARE_NO_COPY_CLASS(wxGtkPrinterDCImpl)
+    wxDECLARE_NO_COPY_CLASS(wxGtkPrinterDCImpl);

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -325,8 +328,8 @@ class WXDLLIMPEXP_CORE wxGtkPrintPreview : public wxPrintPreviewBase
 {
 public:
     wxGtkPrintPreview(wxPrintout *printout,
 {
 public:
     wxGtkPrintPreview(wxPrintout *printout,

-                             wxPrintout *printoutForPrinting = (wxPrintout *) NULL,
-                             wxPrintDialogData *data = (wxPrintDialogData *) NULL);
+                             wxPrintout *printoutForPrinting = NULL,
+                             wxPrintDialogData *data = NULL);

     wxGtkPrintPreview(wxPrintout *printout,
                              wxPrintout *printoutForPrinting,
                              wxPrintData *data);
     wxGtkPrintPreview(wxPrintout *printout,
                              wxPrintout *printoutForPrinting,
                              wxPrintData *data);