Scribus
Open source desktop publishing at your fingertips
ParagraphStyle Class Reference
Inheritance diagram for ParagraphStyle:
Collaboration diagram for ParagraphStyle:

Classes

struct  TabRecord
 

Public Types

enum  LineSpacingMode { FixedLineSpacing = 0, AutomaticLineSpacing = 1, BaselineGridLineSpacing = 2 }
 
enum  AlignmentType {
  Leftaligned = 0, Centered = 1, Rightaligned = 2, Justified = 3,
  Extended = 4
}
 
enum  OpticalMarginType {
  OM_None = 0, OM_LeftProtruding = 1, OM_RightProtruding = 2, OM_LeftHangingPunct = 4,
  OM_RightHangingPunct = 8, OM_Default = OM_RightProtruding + OM_LeftHangingPunct + OM_RightHangingPunct
}
 
enum  HyphenationMode { NoHyphenation = 0, ManualHyphenation = 1, AutomaticHyphenation = 2 }
 

Public Member Functions

 ParagraphStyle (const ParagraphStyle &other)
 
ParagraphStyleoperator= (const ParagraphStyle &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 setContext (const StyleContext *context)
 
void update (const StyleContext *)
 
bool equiv (const Style &other) const
 
void applyStyle (const ParagraphStyle &other)
 
void eraseStyle (const ParagraphStyle &other)
 
void setStyle (const ParagraphStyle &other)
 
void erase ()
 
StyleContextcharStyleContext ()
 
const StyleContextcharStyleContext () const
 
CharStylecharStyle ()
 
const CharStylecharStyle () const
 
void breakImplicitCharStyleInheritance (bool val=true)
 
void repairImplicitCharStyleInheritance ()
 
 ATTRDEF (QString, bulletStr, BulletStr, QString(QChar(0x2022))) ATTRDEF(QString
 
 QString (QChar(0x2022))) void appendTabValue(const TabRecord &tab)
 
 ATTRDEF (QString, bulletStr, BulletStr, QString(QChar(0x2022))) ATTRDEF(QString
 
 QString (QChar(0x2022))) ATTRDEF(QString
 
- Public Member Functions inherited from Style
 Style (StyleContext *b, QString n)
 
Styleoperator= (const Style &o)
 
 Style (const Style &o)
 
void saxxAttributes (Xml_attr &attr) const
 
void setDefaultStyle (bool ids)
 
bool isDefaultStyle () const
 
QString name () const
 
void setName (const QString &n)
 
bool hasName () const
 
QString parent () const
 
void setParent (const QString &p)
 
bool hasParent () const
 
const StyleparentStyle () const
 
const StyleContextcontext () const
 
void validate () const
 
QString shortcut () const
 
void setShortcut (const QString &shortcut)
 
virtual bool operator== (const Style &other) const
 
virtual bool operator!= (const Style &other) const
 
void applyStyle (const Style &other)
 
void eraseStyle (const Style &other)
 

Static Public Member Functions

static void desaxeRules (const Xml_string &prefixPattern, desaxe::Digester &ruleset, Xml_string elemtag=saxxDefaultElem)
 
- Static Public Member Functions inherited from Style
template<class SUBSTYLE >
static void desaxeRules (const Xml_string &prefixPattern, desaxe::Digester &ruleset, Xml_string elemtag)
 
- Static Public Member Functions inherited from SaxIO
static void desaxeRules (const Xml_string &, desaxe::Digester &, const Xml_string=saxxDefaultElem)
 

Public Attributes

 bulletStr
 
 BulletStr
 
QString(QChar(0x2022))) private bool cstyleContextIsInh
 
CharStyle cstyle
 

Static Public Attributes

static const Xml_string saxxDefaultElem
 
- Static Public Attributes inherited from Style
static const QString INHERIT_PARENT = "\n"
 
- Static Public Attributes inherited from SaxIO
static const Xml_string saxxDefaultElem
 

Additional Inherited Members

- Protected Attributes inherited from Style
bool m_isDefaultStyle
 
QString m_name
 
const StyleContextm_context
 
int m_contextversion
 
QString m_parent
 
QString m_shortcut
 

Member Function Documentation

ParagraphStyle::ATTRDEF ( QString  ,
bulletStr  ,
BulletStr  ,
QString(QChar(0x2022))   
)

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

ParagraphStyle::ATTRDEF ( QString  ,
bulletStr  ,
BulletStr  ,
QString(QChar(0x2022))   
)

isInherited: returns true if the attriute is inherited

void ParagraphStyle::breakImplicitCharStyleInheritance ( bool  val = true)

Normally the context for charStyle() is parentStyle()->charStyleContext() Use this method to break that relation and set charStyle()'s context manually

bool ParagraphStyle::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.

void ParagraphStyle::erase ( )
inlinevirtual

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

Implements Style.

ParagraphStyle::QString ( QChar(0x2022)  )

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

void ParagraphStyle::repairImplicitCharStyleInheritance ( )

used internally to establish the implicit relation charStyle().context() == parentStyle()->charStyleContext() Done implicitly in setContext(), update(), operator= and breakImplicitCharStyleInheritance()

void ParagraphStyle::saxx ( SaxHandler ,
const Xml_string &   
) const
virtual

Writes an XML representation of this object

Implements SaxIO.

virtual void ParagraphStyle::saxx ( SaxHandler ) const
inlinevirtual

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

Implements SaxIO.

void ParagraphStyle::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.


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