/////////////////////////////////////////////////////////////////////////////
// Name: graphics.h
-// Purpose: documentation for wxGraphicsPath class
+// Purpose: interface of wxGraphicsPath
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
public:
//@{
/**
-
+
*/
void AddArc(wxDouble x, wxDouble y, wxDouble r,
wxDouble startAngle,
//@{
/**
-
+
*/
void AddCurveToPoint(wxDouble cx1, wxDouble cy1, wxDouble cx2,
wxDouble cy2,
//@{
/**
-
+
*/
void AddLineToPoint(wxDouble x, wxDouble y);
void AddLineToPoint(const wxPoint2DDouble& p);
Returns @true if the point is within the path.
*/
bool Contains(const wxPoint2DDouble& c,
- int fillStyle = wxODDEVEN_RULE);
- bool Contains(wxDouble x, wxDouble y,
- int fillStyle = wxODDEVEN_RULE);
+ int fillStyle = wxODDEVEN_RULE) const;
+ const bool Contains(wxDouble x, wxDouble y,
+ int fillStyle = wxODDEVEN_RULE) const;
//@}
//@{
/**
Gets the bounding box enclosing all points (possibly including control points).
*/
- wxRect2DDouble GetBox();
- void GetBox(wxDouble* x, wxDouble* y, wxDouble* w,
- wxDouble* h);
+ wxRect2DDouble GetBox() const;
+ const void GetBox(wxDouble* x, wxDouble* y, wxDouble* w,
+ wxDouble* h) const;
//@}
//@{
/**
Gets the last point of the current path, (0,0) if not yet set.
*/
- void GetCurrentPoint(wxDouble* x, wxDouble* y);
- wxPoint2DDouble GetCurrentPoint();
+ void GetCurrentPoint(wxDouble* x, wxDouble* y) const;
+ const wxPoint2DDouble GetCurrentPoint() const;
//@}
/**
Returns the native path (CGPathRef for Core Graphics, Path pointer for GDIPlus
and a cairo_path_t pointer for cairo).
*/
- void* GetNativePath();
+ void* GetNativePath() const;
//@{
/**
some deallocations necessary (eg on cairo the native path returned by
GetNativePath is newly allocated each time).
*/
- void UnGetNativePath(void* p);
+ void UnGetNativePath(void* p) const;
};
+
/**
@class wxGraphicsObject
@wxheader{graphics.h}
@library{wxcore}
@category{FIXME}
- @seealso
- wxGraphicsBrush, wxGraphicsPen, wxGraphicsMatrix, wxGraphicsPath
+ @see wxGraphicsBrush, wxGraphicsPen, wxGraphicsMatrix, wxGraphicsPath
*/
class wxGraphicsObject : public wxObject
{
Returns the renderer that was used to create this instance, or @NULL if it has
not been initialized yet
*/
- wxGraphicsRenderer* GetRenderer();
+ wxGraphicsRenderer* GetRenderer() const;
/**
Is this object valid (@false) or still empty (@true)?
*/
- bool IsNull();
+ bool IsNull() const;
};
+
/**
@class wxGraphicsContext
@wxheader{graphics.h}
@library{wxcore}
@category{FIXME}
- @seealso
- wxGraphicsRenderer:: CreateContext
+ @see wxGraphicsRenderer:: CreateContext
*/
class wxGraphicsContext : public wxGraphicsObject
{
//@{
/**
Creates a wxGraphicsContext from a wxWindow.
-
+
@see wxGraphicsRenderer:: CreateContext
*/
wxGraphicsContext* Create(const wxWindowDC& dc);
/**
Creates a native brush from a wxBrush.
*/
- wxGraphicsBrush CreateBrush(const wxBrush& brush);
+ wxGraphicsBrush CreateBrush(const wxBrush& brush) const;
/**
Creates a native graphics font from a wxFont and a text colour.
*/
wxGraphicsFont CreateFont(const wxFont& font,
- const wxColour& col = wxBLACK);
+ const wxColour& col = wxBLACK) const;
/**
Creates a wxGraphicsContext from a native context. This native context must be
eg a CGContextRef for Core Graphics, a Graphics pointer for GDIPlus or a
cairo_t pointer for cairo.
-
+
Creates a wxGraphicsContext from a native window.
-
+
@see wxGraphicsRenderer:: CreateContextFromNativeContext
*/
wxGraphicsContext* CreateFromNative(void* context);
wxDouble x2,
wxDouble y2,
const wxColouramp;c1,
- const wxColouramp;c2);
+ const wxColouramp;c2) const;
/**
Creates a native affine transformation matrix from the passed in values. The
wxDouble c = 0.0,
wxDouble d = 1.0,
wxDouble tx = 0.0,
- wxDouble ty = 0.0);
+ wxDouble ty = 0.0) const;
/**
Creates a native graphics path which is initially empty.
*/
- wxGraphicsPath CreatePath();
+ wxGraphicsPath CreatePath() const;
/**
Creates a native pen from a wxPen.
*/
- wxGraphicsPen CreatePen(const wxPen& pen);
+ wxGraphicsPen CreatePen(const wxPen& pen) const;
/**
Creates a native brush, having a radial gradient originating at (xo,yc) with
wxDouble yc,
wxDouble radius,
const wxColour& oColor,
- const wxColour& cColor);
+ const wxColour& cColor) const;
/**
Draws the bitmap. In case of a mono bitmap, this is treated as a mask and the
@a text to the corresponding character of @e text.
*/
void GetPartialTextExtents(const wxString& text,
- wxArrayDouble& widths);
+ wxArrayDouble& widths) const;
/**
Gets the dimensions of the string using the currently selected font.
void GetTextExtent(const wxString& text, wxDouble* width,
wxDouble* height,
wxDouble* descent,
- wxDouble* externalLeading);
+ wxDouble* externalLeading) const;
/**
Gets the current transformation matrix of this context.
*/
- wxGraphicsMatrix GetTransform();
+ wxGraphicsMatrix GetTransform() const;
/**
Resets the clipping to original shape.
};
+
/**
@class wxGraphicsRenderer
@wxheader{graphics.h}
};
+
/**
@class wxGraphicsBrush
@wxheader{graphics.h}
};
+
/**
@class wxGraphicsFont
@wxheader{graphics.h}
};
+
/**
@class wxGraphicsPen
@wxheader{graphics.h}
};
+
/**
@class wxGraphicsMatrix
@wxheader{graphics.h}
public:
//@{
/**
-
+
*/
void Concat(const wxGraphicsMatrix* t);
void Concat(const wxGraphicsMatrix& t);
*/
void Get(wxDouble* a = NULL, wxDouble* b = NULL, wxDouble* c = NULL,
wxDouble* d = NULL, wxDouble* tx = NULL,
- wxDouble* ty = NULL);
+ wxDouble* ty = NULL) const;
/**
Returns the native representation of the matrix. For CoreGraphics this is a
CFAffineMatrix pointer. For GDIPlus a Matrix Pointer and for Cairo a cairo_matrix_t pointer.
*/
- void* GetNativeMatrix();
+ void* GetNativeMatrix() const;
/**
Inverts the matrix.
/**
Returns @true if the elements of the transformation matrix are equal.
*/
- bool IsEqual(const wxGraphicsMatrix& t);
+ bool IsEqual(const wxGraphicsMatrix& t) const;
/**
Return @true if this is the identity matrix.
*/
- bool IsIdentity();
+ bool IsIdentity() const;
/**
Rotates this matrix (radians).
Applies this matrix to a distance (ie. performs all transforms except
translations)
*/
- void TransformDistance(wxDouble* dx, wxDouble* dy);
+ void TransformDistance(wxDouble* dx, wxDouble* dy) const;
/**
Applies this matrix to a point.
*/
- void TransformPoint(wxDouble* x, wxDouble* y);
+ void TransformPoint(wxDouble* x, wxDouble* y) const;
/**
Translates this matrix.
*/
void Translate(wxDouble dx, wxDouble dy);
};
+
projects / wxWidgets.git / blobdiff