Scribus Developer Documentation - API
logo-pen

Scribus Developer Documentation - API

VGradientEx Class Reference

#include <vgradientex.h>

Collaboration diagram for VGradientEx:

Collaboration graph
[legend]

List of all members.

Public Types

enum  Type { linear = 0, radial = 1, conic = 2 }
enum  RepeatMethod { none = 0, reflect = 1, repeat = 2 }

Public Member Functions

 VGradientEx (VGradientEx::Type type=linear)
 VGradientEx (const VGradientEx &gradient)
 VGradientEx (const VGradient &gradient, ScribusDoc &doc)
 ~VGradientEx ()
VGradientExoperator= (const VGradientEx &gradient)
VGradientEx::Type type () const
void setType (VGradientEx::Type type)
VGradientEx::RepeatMethod repeatMethod () const
void setRepeatMethod (VGradientEx::RepeatMethod repeatMethod)
const QList< VColorStopEx * > colorStops () const
void addStop (const VColorStopEx &colorStop)
void addStop (const ScColor &color, double rampPoint, double midPoint, double opa, QString name="", int shade=100)
void removeStop (VColorStopEx &colorStop)
void removeStop (uint n)
void clearStops ()
uint Stops ()
FPoint origin () const
void setOrigin (const FPoint &origin)
FPoint focalPoint () const
void setFocalPoint (const FPoint &focalPoint)
FPoint vector () const
void setVector (const FPoint &vector)
void transform (const QMatrix &m)

Protected Member Functions

int compareItems (const VColorStopEx *item1, const VColorStopEx *item2) const
void inSort (VColorStopEx *d)

Protected Attributes

QList< VColorStopEx * > m_colorStops

Private Attributes

VGradientEx::Type m_type: 2
VGradientEx::RepeatMethod m_repeatMethod: 2
FPoint m_origin
FPoint m_focalPoint
FPoint m_vector


Detailed Description

Definition at line 80 of file vgradientex.h.


Member Enumeration Documentation

Enumerator:
linear 
radial 
conic 

Definition at line 85 of file vgradientex.h.

Enumerator:
none 
reflect 
repeat 

Definition at line 92 of file vgradientex.h.


Constructor & Destructor Documentation

VGradientEx::VGradientEx ( VGradientEx::Type  type = linear  ) 

Definition at line 60 of file vgradientex.cpp.

References addStop(), reflect, setOrigin(), setRepeatMethod(), and setVector().

VGradientEx::VGradientEx ( const VGradientEx gradient  ) 

VGradientEx::VGradientEx ( const VGradient gradient,
ScribusDoc doc 
)

VGradientEx::~VGradientEx (  ) 

Definition at line 130 of file vgradientex.cpp.

References clearStops().


Member Function Documentation

VGradientEx & VGradientEx::operator= ( const VGradientEx gradient  ) 

VGradientEx::Type VGradientEx::type (  )  const [inline]

void VGradientEx::setType ( VGradientEx::Type  type  )  [inline]

VGradientEx::RepeatMethod VGradientEx::repeatMethod (  )  const [inline]

Definition at line 109 of file vgradientex.h.

void VGradientEx::setRepeatMethod ( VGradientEx::RepeatMethod  repeatMethod  )  [inline]

Definition at line 110 of file vgradientex.h.

Referenced by VGradientEx().

const QList< VColorStopEx * > VGradientEx::colorStops (  )  const

void VGradientEx::addStop ( const VColorStopEx colorStop  ) 

Definition at line 148 of file vgradientex.cpp.

References inSort().

Referenced by VGradientEx().

void VGradientEx::addStop ( const ScColor color,
double  rampPoint,
double  midPoint,
double  opa,
QString  name = "",
int  shade = 100 
)

Definition at line 154 of file vgradientex.cpp.

References inSort().

void VGradientEx::removeStop ( VColorStopEx colorStop  ) 

Definition at line 166 of file vgradientex.cpp.

References m_colorStops.

void VGradientEx::removeStop ( uint  n  ) 

Definition at line 172 of file vgradientex.cpp.

References m_colorStops.

void VGradientEx::clearStops (  ) 

Definition at line 141 of file vgradientex.cpp.

References m_colorStops.

Referenced by operator=(), VGradientEx(), and ~VGradientEx().

uint VGradientEx::Stops (  )  [inline]

FPoint VGradientEx::origin (  )  const [inline]

void VGradientEx::setOrigin ( const FPoint origin  )  [inline]

FPoint VGradientEx::focalPoint (  )  const [inline]

void VGradientEx::setFocalPoint ( const FPoint focalPoint  )  [inline]

FPoint VGradientEx::vector (  )  const [inline]

void VGradientEx::setVector ( const FPoint vector  )  [inline]

void VGradientEx::transform ( const QMatrix &  m  ) 

Definition at line 177 of file vgradientex.cpp.

References m_focalPoint, m_origin, m_vector, FPoint::x(), and FPoint::y().

int VGradientEx::compareItems ( const VColorStopEx item1,
const VColorStopEx item2 
) const [protected]

Definition at line 40 of file vgradientex.cpp.

References VColorStopEx::rampPoint.

Referenced by inSort().

void VGradientEx::inSort ( VColorStopEx d  )  [protected]

Definition at line 48 of file vgradientex.cpp.

References compareItems(), and m_colorStops.

Referenced by addStop().


Member Data Documentation

Definition at line 132 of file vgradientex.h.

Referenced by clearStops(), colorStops(), inSort(), operator=(), removeStop(), and VGradientEx().

Definition at line 138 of file vgradientex.h.

Referenced by operator=(), and VGradientEx().

Definition at line 139 of file vgradientex.h.

Referenced by operator=(), and VGradientEx().

Definition at line 142 of file vgradientex.h.

Referenced by operator=(), transform(), and VGradientEx().

Definition at line 143 of file vgradientex.h.

Referenced by operator=(), transform(), and VGradientEx().

Definition at line 144 of file vgradientex.h.

Referenced by operator=(), transform(), and VGradientEx().


The documentation for this class was generated from the following files:
Created with personalized Doxygen. This is documentation for GPL software Scribus - Open Source Desktop Publishing.