Scribus Developer Documentation - API
logo-pen

Scribus Developer Documentation - API

LineStyle Class Reference

#include <linestyle.h>

Inheritance diagram for LineStyle:

Inheritance graph
[legend]
Collaboration diagram for LineStyle:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 LineStyle ()
 LineStyle (double width, const QString &color, double shade=100)
 LineStyle (const LineStyle &other)
LineStyleoperator= (const LineStyle &other)
virtual void saxx (SaxHandler &handler, const Xml_string &elemtag) const
virtual void saxx (SaxHandler &handler) const
void getNamedResources (ResourceCollection &lists) const
void replaceNamedResources (ResourceCollection &newNames)
QString displayName () const
void update (const StyleContext *b)
bool equiv (const Style &other) const
void applyLineStyle (const LineStyle &other)
void eraseLineStyle (const LineStyle &other)
void setStyle (const LineStyle &other)
void erase ()
QString asString () const
 ATTRDEF (QList< double >, dashes, Dashes, QList< double >()) ATTRDEF(QList< LineStyle >
 QList ()) ATTRDEF(QList< double >
 QList ()) ATTRDEF(QList< LineStyle >
 QList ()) void appendSubline(const LineStyle &subline)
 ATTRDEF (QList< double >, dashes, Dashes, QList< double >()) ATTRDEF(QList< LineStyle >
 QList ()) ATTRDEF(QList< double >
 QList ()) ATTRDEF(QList< LineStyle >
 QList ()) ATTRDEF(QList< double >
 QList ()) ATTRDEF(QList< LineStyle >
 ATTRDEF (QList< double >, dashes, Dashes, QList< double >()) ATTRDEF(QList< LineStyle >

Static Public Member Functions

static void desaxeRules (const Xml_string &prefixPattern, desaxe::Digester &ruleset, Xml_string elemtag=saxxDefaultElem)

Public Attributes

 sublines
 Sublines
 dashes
 Dashes

Static Public Attributes

static const Xml_string saxxDefaultElem


Detailed Description

Definition at line 24 of file linestyle.h.


Constructor & Destructor Documentation

LineStyle::LineStyle (  )  [inline]

Definition at line 28 of file linestyle.h.

LineStyle::LineStyle ( double  width,
const QString &  color,
double  shade = 100 
) [inline]

Definition at line 66 of file linestyle.h.

LineStyle::LineStyle ( const LineStyle other  )  [inline]

Definition at line 141 of file linestyle.h.

References Style::m_contextversion.


Member Function Documentation

LineStyle & LineStyle::operator= ( const LineStyle other  )  [inline]

Definition at line 129 of file linestyle.h.

References Style::m_contextversion.

void LineStyle::desaxeRules ( const Xml_string ,
desaxe::Digester ,
Xml_string  Xml_string = saxxDefaultElem 
) [static]

Fills the digester with rules wich ensure that an object which was saved via saxx() will be reconstructed on top of the digester stack. The prefix pattern shall be used to create patterns which constrain the added rules to this context. Unfortunately there are no virtual static functions, so this is just a dummy serving as a template.

Reimplemented from Style.

Definition at line 252 of file linestyle.cpp.

References desaxe::Digester::addRule().

void LineStyle::saxx ( SaxHandler ,
const Xml_string  
) const [virtual]

Writes an XML representation of this object

Implements SaxIO.

Definition at line 196 of file linestyle.cpp.

References SaxHandler::begin(), SaxHandler::end(), mkXMLName(), Style::name(), Style::parentStyle(), SaxIO::saxx(), and Style::saxxAttributes().

virtual void LineStyle::saxx ( SaxHandler  )  const [inline, virtual]

Writes an XML representation of this object using the default element tag, see below

Implements SaxIO.

Definition at line 115 of file linestyle.h.

void LineStyle::getNamedResources ( ResourceCollection lists  )  const

void LineStyle::replaceNamedResources ( ResourceCollection newNames  ) 

QString LineStyle::displayName (  )  const [virtual]

void LineStyle::update ( const StyleContext b  )  [virtual]

sets a new StyleContext if b is not NULL and then uses the StyleContext to set all inherited attributes to their valid value.

Reimplemented from Style.

Definition at line 101 of file linestyle.cpp.

References Style::parentStyle(), and Style::update().

bool LineStyle::equiv ( const Style other  )  const [virtual]

returns true if both Styles are of the same type, inherit the same attributes, have the same parent, and agree on all attributes which are not inherited. The StyleContext, the name and any inherited attrinutes may be different.

Implements Style.

Definition at line 43 of file linestyle.cpp.

References Style::parent(), and Style::validate().

void LineStyle::applyLineStyle ( const LineStyle other  ) 

Definition at line 21 of file linestyle.cpp.

References Style::applyStyle().

void LineStyle::eraseLineStyle ( const LineStyle other  ) 

Definition at line 32 of file linestyle.cpp.

References Style::eraseStyle(), and Style::validate().

void LineStyle::setStyle ( const LineStyle other  ) 

Definition at line 115 of file linestyle.cpp.

References Style::parent(), Style::setParent(), and Style::validate().

void LineStyle::erase (  )  [inline, virtual]

resets all attributes to their defaults and makes them inherited. name and parent are not affected.

Implements Style.

Definition at line 129 of file linestyle.h.

QString LineStyle::asString (  )  const

Definition at line 70 of file linestyle.cpp.

LineStyle::ATTRDEF ( QList< double >  ,
dashes  ,
Dashes  ,
QList< double >  () 
)

LineStyle::QList (  ) 

setter: sets the attribute's value and clears inherited flag

Type constraints

LineStyle::QList (  ) 

Type constraints

LineStyle::QList (  )  const [inline]

Type constraints

Definition at line 204 of file linestyle.h.

LineStyle::ATTRDEF ( QList< double >  ,
dashes  ,
Dashes  ,
QList< double >  () 
)

LineStyle::QList (  ) 

isInherited: returns true if the attribute is inherited

Type constraints

LineStyle::QList (  ) 

Type constraints

LineStyle::QList (  ) 

isDefined: returns true if the attribute is defined in this style or any parent

Type constraints

LineStyle::QList (  ) 

Type constraints

LineStyle::ATTRDEF ( QList< double >  ,
dashes  ,
Dashes  ,
QList< double >  () 
)


Member Data Documentation

Element tag which is usually used to serialize this object. "" means no elem is created by saxx()

Reimplemented from SaxIO.

Definition at line 111 of file linestyle.h.

Definition at line 167 of file linestyle.h.

Definition at line 167 of file linestyle.h.

Definition at line 200 of file linestyle.h.

Definition at line 200 of file linestyle.h.


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.