Pen Class Reference

#include <gdipluspen.h>

Inheritance diagram for Pen:

Collaboration diagram for Pen:

Public Member Functions
	Pen (const Brush *brush, REAL width=1.0f)
	Pen (const Color &color, REAL width=1.0f)
	~Pen ()
Pen *	Clone ()
PenAlignment	GetAlignment ()
Brush *	GetBrush ()
Status	GetColor (Color *color)
Status	GetCompoundArray (REAL *compoundArray, INT count)
INT	GetCompoundArrayCount ()
Status	GetCustomEndCap (CustomLineCap *customCap)
Status	GetCustomStartCap (CustomLineCap *customCap)
DashCap	GetDashCap ()
REAL	GetDashOffset ()
Status	GetDashPattern (REAL *dashArray, INT count)
INT	GetDashPatternCount ()
DashStyle	GetDashStyle ()
LineCap	GetEndCap ()
Status	GetLastStatus () const
LineJoin	GetLineJoin ()
REAL	GetMiterLimit ()
PenType	GetPenType ()
LineCap	GetStartCap ()
Status	GetTransform (Matrix *matrix)
REAL	GetWidth ()
Status	MultiplyTransform (Matrix *matrix, MatrixOrder order=MatrixOrderPrepend)
Status	ResetTransform ()
Status	RotateTransform (REAL angle, MatrixOrder order=MatrixOrderPrepend)
Status	ScaleTransform (REAL sx, REAL sy, MatrixOrder order=MatrixOrderPrepend)
Status	SetAlignment (PenAlignment penAlignment)
Status	SetBrush (const Brush *brush)
Status	SetColor (const Color &color)
Status	SetCompoundArray (const REAL *compoundArray, INT count)
Status	SetCustomEndCap (const CustomLineCap *customCap)
Status	SetCustomStartCap (const CustomLineCap *customCap)
Status	SetDashCap (DashCap dashCap)
Status	SetDashOffset (REAL dashOffset)
Status	SetDashPattern (const REAL *dashArray, INT count)
Status	SetDashStyle (DashStyle dashStyle)
Status	SetEndCap (LineCap endCap)
Status	SetLineCap (LineCap startCap, LineCap endCap, DashCap dashCap)
Status	SetLineJoin (LineJoin lineJoin)
Status	SetMiterLimit (REAL miterLimit)
Status	SetStartCap (LineCap startCap)
Status	SetTransform (const Matrix *matrix)
Status	SetWidth (REAL width)
Status	TranslateTransform (REAL dx, REAL dy, MatrixOrder order=MatrixOrderPrepend)
Public Member Functions inherited from GdiplusBase
void	operator delete (void *in_pVoid)
void	operator delete[] (void *in_pVoid)
void *	operator new (size_t in_size)
void *	operator new[] (size_t in_size)

Protected Member Functions
Status	SetStatus (Status status) const
	Pen (GpPen *pen, Status status)
VOID	SetNativePen (GpPen *pen)

Protected Attributes
GpPen *	nativePen
Status	lastStatus

Private Member Functions
	Pen (const Pen &)
Pen &	operator= (const Pen &)

Friends
class	Graphics
class	GraphicsPath
GpPen *&	getNat (const Pen *pen)

Detailed Description

Definition at line 22 of file gdipluspen.h.

Constructor & Destructor Documentation

Pen() [1/4]

Pen::Pen ( const Brush *  brush, REAL  width = 1.0f  )

inline

Definition at line 28 of file gdipluspen.h.

                                               : nativePen(NULL)
    {
        lastStatus = DllExports::GdipCreatePen2(getNat(brush), width, UnitWorld, &nativePen);
    }

Pen() [2/4]

Pen::Pen ( const Color &  color, REAL  width = 1.0f  )

inline

Definition at line 33 of file gdipluspen.h.

                                               : nativePen(NULL)
    {
        lastStatus = DllExports::GdipCreatePen1(color.GetValue(), width, UnitWorld, &nativePen);
    }

~Pen()

Pen::~Pen ( )

inline

Definition at line 38 of file gdipluspen.h.

    {
        DllExports::GdipDeletePen(nativePen);
    }

Pen() [3/4]

Pen::Pen ( GpPen *  pen, Status  status  )

inlineprotected

Definition at line 370 of file gdipluspen.h.

                                   : nativePen(pen), lastStatus(status)
    {
    }

Pen() [4/4]

Pen::Pen ( const Pen &  )

private

Member Function Documentation

Clone()

Pen * Pen::Clone ( )

inline

Definition at line 44 of file gdipluspen.h.

    {
        GpPen *clonePen = NULL;
        SetStatus(DllExports::GdipClonePen(nativePen, &clonePen));
        if (lastStatus != Ok)
            return NULL;
        Pen *newPen = new Pen(clonePen, lastStatus);
        if (!newPen)
            DllExports::GdipDeletePen(clonePen);
        return newPen;
    }

GetAlignment()

PenAlignment Pen::GetAlignment ( )

inline

Definition at line 57 of file gdipluspen.h.

    {
        PenAlignment penAlignment;
        SetStatus(DllExports::GdipGetPenMode(nativePen, &penAlignment));
        return penAlignment;
    }

GetBrush()

Brush * Pen::GetBrush ( )

inline

Definition at line 65 of file gdipluspen.h.

    {
        // FIXME
        return NULL;
    }

GetColor()

Status Pen::GetColor ( Color *  color )

inline

Definition at line 72 of file gdipluspen.h.

    {
        if (!color)
            return SetStatus(InvalidParameter);
 
        ARGB argb;
        SetStatus(DllExports::GdipGetPenColor(nativePen, &argb));
        color->SetValue(argb);
        return lastStatus;
    }

GetCompoundArray()

Status Pen::GetCompoundArray ( REAL *  compoundArray, INT  count  )

inline

Definition at line 84 of file gdipluspen.h.

    {
        if (!compoundArray || count <= 0)
            return SetStatus(InvalidParameter);
#if 1
        return SetStatus(NotImplemented);
#else
        return SetStatus(DllExports::GdipGetPenCompoundArray(nativePen, compoundArray, count));
#endif
    }

GetCompoundArrayCount()

INT Pen::GetCompoundArrayCount ( )

inline

Definition at line 96 of file gdipluspen.h.

    {
        INT count = 0;
        SetStatus(DllExports::GdipGetPenCompoundCount(nativePen, &count));
        return count;
    }

GetCustomEndCap()

Status Pen::GetCustomEndCap ( CustomLineCap *  customCap )

inline

Definition at line 104 of file gdipluspen.h.

    {
        if (!customCap)
            return SetStatus(InvalidParameter);
 
        return SetStatus(DllExports::GdipGetPenCustomEndCap(nativePen, &getNat(customCap)));
    }

GetCustomStartCap()

Status Pen::GetCustomStartCap ( CustomLineCap *  customCap )

inline

Definition at line 113 of file gdipluspen.h.

    {
        if (!customCap)
            return SetStatus(InvalidParameter);
 
        return SetStatus(DllExports::GdipGetPenCustomStartCap(nativePen, &getNat(customCap)));
    }

GetDashCap()

DashCap Pen::GetDashCap ( )

inline

Definition at line 122 of file gdipluspen.h.

    {
        DashCap dashCap;
        SetStatus(DllExports::GdipGetPenDashCap197819(nativePen, &dashCap));
        return dashCap;
    }

GetDashOffset()

REAL Pen::GetDashOffset ( )

inline

Definition at line 130 of file gdipluspen.h.

    {
        REAL offset;
        SetStatus(DllExports::GdipGetPenDashOffset(nativePen, &offset));
        return offset;
    }

GetDashPattern()

Status Pen::GetDashPattern ( REAL *  dashArray, INT  count  )

inline

Definition at line 138 of file gdipluspen.h.

    {
        if (dashArray == NULL || count <= 0)
            return SetStatus(InvalidParameter);
 
        return SetStatus(DllExports::GdipGetPenDashArray(nativePen, dashArray, count));
    }

GetDashPatternCount()

INT Pen::GetDashPatternCount ( )

inline

Definition at line 147 of file gdipluspen.h.

    {
        INT count = 0;
        SetStatus(DllExports::GdipGetPenDashCount(nativePen, &count));
        return count;
    }

GetDashStyle()

DashStyle Pen::GetDashStyle ( )

inline

Definition at line 155 of file gdipluspen.h.

    {
        DashStyle dashStyle;
        SetStatus(DllExports::GdipGetPenDashStyle(nativePen, &dashStyle));
        return dashStyle;
    }

GetEndCap()

LineCap Pen::GetEndCap ( )

inline

Definition at line 163 of file gdipluspen.h.

    {
        LineCap endCap;
        SetStatus(DllExports::GdipGetPenEndCap(nativePen, &endCap));
        return endCap;
    }

GetLastStatus()

Status Pen::GetLastStatus ( ) const

inline

Definition at line 171 of file gdipluspen.h.

    {
        return lastStatus;
    }

GetLineJoin()

LineJoin Pen::GetLineJoin ( )

inline

Definition at line 177 of file gdipluspen.h.

    {
        LineJoin lineJoin;
        SetStatus(DllExports::GdipGetPenLineJoin(nativePen, &lineJoin));
        return lineJoin;
    }

GetMiterLimit()

REAL Pen::GetMiterLimit ( )

inline

Definition at line 185 of file gdipluspen.h.

    {
        REAL miterLimit;
        SetStatus(DllExports::GdipGetPenMiterLimit(nativePen, &miterLimit));
        return miterLimit;
    }

GetPenType()

PenType Pen::GetPenType ( )

inline

Definition at line 193 of file gdipluspen.h.

    {
        PenType type;
        SetStatus(DllExports::GdipGetPenFillType(nativePen, &type));
        return type;
    }

GetStartCap()

LineCap Pen::GetStartCap ( )

inline

Definition at line 201 of file gdipluspen.h.

    {
        LineCap startCap;
        SetStatus(DllExports::GdipGetPenStartCap(nativePen, &startCap));
        return startCap;
    }

GetTransform()

Status Pen::GetTransform ( Matrix *  matrix )

inline

Definition at line 209 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipGetPenTransform(nativePen, getNat(matrix)));
    }

GetWidth()

REAL Pen::GetWidth ( )

inline

Definition at line 215 of file gdipluspen.h.

    {
        REAL width;
        SetStatus(DllExports::GdipGetPenWidth(nativePen, &width));
        return width;
    }

MultiplyTransform()

Status Pen::MultiplyTransform ( Matrix *  matrix, MatrixOrder  order = MatrixOrderPrepend  )

inline

Definition at line 223 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipMultiplyPenTransform(nativePen, getNat(matrix), order));
    }

operator=()

Pen & Pen::operator= ( const Pen &  )

private

ResetTransform()

Status Pen::ResetTransform ( )

inline

Definition at line 229 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipResetPenTransform(nativePen));
    }

RotateTransform()

Status Pen::RotateTransform ( REAL  angle, MatrixOrder  order = MatrixOrderPrepend  )

inline

Definition at line 235 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipRotatePenTransform(nativePen, angle, order));
    }

ScaleTransform()

Status Pen::ScaleTransform ( REAL  sx, REAL  sy, MatrixOrder  order = MatrixOrderPrepend  )

inline

Definition at line 241 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipScalePenTransform(nativePen, sx, sy, order));
    }

SetAlignment()

Status Pen::SetAlignment ( PenAlignment  penAlignment )

inline

Definition at line 247 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipSetPenMode(nativePen, penAlignment));
    }

SetBrush()

Status Pen::SetBrush ( const Brush *  brush )

inline

Definition at line 253 of file gdipluspen.h.

    {
        GpBrush *theBrush = brush ? getNat(brush) : NULL;
        return SetStatus(DllExports::GdipSetPenBrushFill(nativePen, theBrush));
    }

SetColor()

Status Pen::SetColor ( const Color &  color )

inline

Definition at line 260 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipSetPenColor(nativePen, color.GetValue()));
    }

SetCompoundArray()

Status Pen::SetCompoundArray ( const REAL *  compoundArray, INT  count  )

inline

Definition at line 266 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipSetPenCompoundArray(nativePen, compoundArray, count));
    }

SetCustomEndCap()

Status Pen::SetCustomEndCap ( const CustomLineCap *  customCap )

inline

Definition at line 272 of file gdipluspen.h.

    {
        GpCustomLineCap *cap = customCap ? getNat(customCap) : NULL;
        return SetStatus(DllExports::GdipSetPenCustomEndCap(nativePen, cap));
    }

SetCustomStartCap()

Status Pen::SetCustomStartCap ( const CustomLineCap *  customCap )

inline

Definition at line 279 of file gdipluspen.h.

    {
        GpCustomLineCap *cap = customCap ? getNat(customCap) : NULL;
        return SetStatus(DllExports::GdipSetPenCustomStartCap(nativePen, cap));
    }

SetDashCap()

Status Pen::SetDashCap ( DashCap  dashCap )

inline

Definition at line 286 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipSetPenDashCap197819(nativePen, dashCap));
    }

SetDashOffset()

Status Pen::SetDashOffset ( REAL  dashOffset )

inline

Definition at line 292 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipSetPenDashOffset(nativePen, dashOffset));
    }

SetDashPattern()

Status Pen::SetDashPattern ( const REAL *  dashArray, INT  count  )

inline

Definition at line 298 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipSetPenDashArray(nativePen, dashArray, count));
    }

SetDashStyle()

Status Pen::SetDashStyle ( DashStyle  dashStyle )

inline

Definition at line 304 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipSetPenDashStyle(nativePen, dashStyle));
    }

SetEndCap()

Status Pen::SetEndCap ( LineCap  endCap )

inline

Definition at line 310 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipSetPenEndCap(nativePen, endCap));
    }

SetLineCap()

Status Pen::SetLineCap ( LineCap  startCap, LineCap  endCap, DashCap  dashCap  )

inline

Definition at line 316 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipSetPenLineCap197819(nativePen, startCap, endCap, dashCap));
    }

SetLineJoin()

Status Pen::SetLineJoin ( LineJoin  lineJoin )

inline

Definition at line 322 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipSetPenLineJoin(nativePen, lineJoin));
    }

SetMiterLimit()

Status Pen::SetMiterLimit ( REAL  miterLimit )

inline

Definition at line 328 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipSetPenMiterLimit(nativePen, miterLimit));
    }

SetNativePen()

VOID Pen::SetNativePen ( GpPen *  pen )

inlineprotected

Definition at line 375 of file gdipluspen.h.

    {
        nativePen = pen;
    }

SetStartCap()

Status Pen::SetStartCap ( LineCap  startCap )

inline

Definition at line 334 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipSetPenStartCap(nativePen, startCap));
    }

SetStatus()

Status Pen::SetStatus ( Status  status ) const

inlineprotected

Definition at line 363 of file gdipluspen.h.

    {
        if (status != Ok)
            lastStatus = status;
        return status;
    }

Referenced by Clone(), GetAlignment(), GetColor(), GetCompoundArray(), GetCompoundArrayCount(), GetCustomEndCap(), GetCustomStartCap(), GetDashCap(), GetDashOffset(), GetDashPattern(), GetDashPatternCount(), GetDashStyle(), GetEndCap(), GetLineJoin(), GetMiterLimit(), GetPenType(), GetStartCap(), GetTransform(), GetWidth(), MultiplyTransform(), ResetTransform(), RotateTransform(), ScaleTransform(), SetAlignment(), SetBrush(), SetColor(), SetCompoundArray(), SetCustomEndCap(), SetCustomStartCap(), SetDashCap(), SetDashOffset(), SetDashPattern(), SetDashStyle(), SetEndCap(), SetLineCap(), SetLineJoin(), SetMiterLimit(), SetStartCap(), SetTransform(), SetWidth(), and TranslateTransform().

SetTransform()

Status Pen::SetTransform ( const Matrix *  matrix )

inline

Definition at line 340 of file gdipluspen.h.

    {
        GpMatrix *mat = matrix ? getNat(matrix) : NULL;
        return SetStatus(DllExports::GdipSetPenTransform(nativePen, mat));
    }

SetWidth()

Status Pen::SetWidth ( REAL  width )

inline

Definition at line 347 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipSetPenWidth(nativePen, width));
    }

TranslateTransform()

Status Pen::TranslateTransform ( REAL  dx, REAL  dy, MatrixOrder  order = MatrixOrderPrepend  )

inline

Definition at line 353 of file gdipluspen.h.

    {
        return SetStatus(DllExports::GdipTranslatePenTransform(nativePen, dx, dy, order));
    }

Friends And Related Function Documentation

getNat

GpPen *& getNat ( const Pen *  pen )

friend

Definition at line 388 of file gdipluspen.h.

    {
        return const_cast<Pen *>(pen)->nativePen;
    }

Referenced by GetCustomEndCap(), GetCustomStartCap(), GetTransform(), MultiplyTransform(), Pen(), SetBrush(), SetCustomEndCap(), SetCustomStartCap(), and SetTransform().

Graphics

friend class Graphics

friend

Definition at line 25 of file gdipluspen.h.

GraphicsPath

friend class GraphicsPath

friend

Definition at line 26 of file gdipluspen.h.

Member Data Documentation

lastStatus

Status Pen::lastStatus

mutableprotected

Definition at line 360 of file gdipluspen.h.

Referenced by Clone(), GetColor(), GetLastStatus(), Pen(), and SetStatus().

nativePen

GpPen* Pen::nativePen

protected

Definition at line 359 of file gdipluspen.h.

Referenced by Clone(), GetAlignment(), GetColor(), GetCompoundArray(), GetCompoundArrayCount(), GetCustomEndCap(), GetCustomStartCap(), GetDashCap(), GetDashOffset(), GetDashPattern(), GetDashPatternCount(), GetDashStyle(), GetEndCap(), GetLineJoin(), GetMiterLimit(), GetPenType(), GetStartCap(), GetTransform(), GetWidth(), MultiplyTransform(), Pen(), ResetTransform(), RotateTransform(), ScaleTransform(), SetAlignment(), SetBrush(), SetColor(), SetCompoundArray(), SetCustomEndCap(), SetCustomStartCap(), SetDashCap(), SetDashOffset(), SetDashPattern(), SetDashStyle(), SetEndCap(), SetLineCap(), SetLineJoin(), SetMiterLimit(), SetNativePen(), SetStartCap(), SetTransform(), SetWidth(), TranslateTransform(), and ~Pen().

---

The documentation for this class was generated from the following file:

• sdk/include/psdk/gdipluspen.h