Scribus Developer Documentation - API
logo-pen

Scribus Developer Documentation - API

charstyle.h File Reference

#include "style.h"
#include "charstyle.attrdefs.cxx"

Include dependency graph for charstyle.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

class  StyleFlag
class  CharStyle

Defines

#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT)
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT)
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT)   attr_TYPE attr_GETTER() const { validate(); return m_##attr_NAME; }
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT)   void set##attr_NAME(attr_TYPE v) { m_##attr_NAME = v; inh_##attr_NAME = false; }
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT)   void reset##attr_NAME() { m_##attr_NAME = attr_DEFAULT; inh_##attr_NAME = true; }
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT)   bool isInh##attr_NAME() const { return inh_##attr_NAME; }
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT)
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT)
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT)
#define ATTRDEF(attr_TYPE, attr_GETTER, attr_NAME, attr_DEFAULT)

Enumerations

enum  StyleFlagValue {
  ScStyle_Default = 0, ScStyle_Superscript = 1, ScStyle_Subscript = 2, ScStyle_Outline = 4,
  ScStyle_Underline = 8, ScStyle_Strikethrough = 16, ScStyle_AllCaps = 32, ScStyle_SmallCaps = 64,
  ScStyle_HyphenationPossible = 128, ScStyle_Shadowed = 256, ScStyle_UnderlineWords = 512, ScStyle_Reserved01 = 1024,
  ScStyle_DropCap = 2048, ScStyle_SuppressSpace = 4096, ScStyle_SmartHyphenVisible = 8192, ScStyle_StartOfLine = 16384,
  ScStyle_UserStyles = 1919, ScStyle_None = 65535
}


Define Documentation

#define ATTRDEF ( attr_TYPE,
attr_GETTER,
attr_NAME,
attr_DEFAULT   ) 

Value:

m_##attr_NAME = other.m_##attr_NAME; \
    inh_##attr_NAME = other.inh_##attr_NAME;
getter: validates and returns the attribute's value

Definition at line 459 of file charstyle.h.

#define ATTRDEF ( attr_TYPE,
attr_GETTER,
attr_NAME,
attr_DEFAULT   ) 

Value:

m_##attr_NAME = other.m_##attr_NAME; \
    inh_##attr_NAME = other.inh_##attr_NAME;
getter: validates and returns the attribute's value

Definition at line 459 of file charstyle.h.

#define ATTRDEF ( attr_TYPE,
attr_GETTER,
attr_NAME,
attr_DEFAULT   ) 

Value:

attr_TYPE m_##attr_NAME; \
    bool inh_##attr_NAME;
getter: validates and returns the attribute's value

Definition at line 459 of file charstyle.h.

#define ATTRDEF ( attr_TYPE,
attr_GETTER,
attr_NAME,
attr_DEFAULT   ) 

Value:

bool isDef##attr_NAME() const { \
        if ( !inh_##attr_NAME ) return true; \
        const CharStyle * par = dynamic_cast<const CharStyle*>(parentStyle()); \
        return par && par->isDef##attr_NAME(); \
    }
getter: validates and returns the attribute's value

Definition at line 459 of file charstyle.h.

#define ATTRDEF ( attr_TYPE,
attr_GETTER,
attr_NAME,
attr_DEFAULT   )     bool isInh##attr_NAME() const { return inh_##attr_NAME; }

getter: validates and returns the attribute's value

Definition at line 459 of file charstyle.h.

#define ATTRDEF ( attr_TYPE,
attr_GETTER,
attr_NAME,
attr_DEFAULT   )     void reset##attr_NAME() { m_##attr_NAME = attr_DEFAULT; inh_##attr_NAME = true; }

getter: validates and returns the attribute's value

Definition at line 459 of file charstyle.h.

#define ATTRDEF ( attr_TYPE,
attr_GETTER,
attr_NAME,
attr_DEFAULT   )     void set##attr_NAME(attr_TYPE v) { m_##attr_NAME = v; inh_##attr_NAME = false; }

getter: validates and returns the attribute's value

Definition at line 459 of file charstyle.h.

#define ATTRDEF ( attr_TYPE,
attr_GETTER,
attr_NAME,
attr_DEFAULT   )     attr_TYPE attr_GETTER() const { validate(); return m_##attr_NAME; }

getter: validates and returns the attribute's value

Definition at line 459 of file charstyle.h.

#define ATTRDEF ( attr_TYPE,
attr_GETTER,
attr_NAME,
attr_DEFAULT   ) 

Value:

m_##attr_NAME = attr_DEFAULT; \
        inh_##attr_NAME = true;
getter: validates and returns the attribute's value

Definition at line 459 of file charstyle.h.

#define ATTRDEF ( attr_TYPE,
attr_GETTER,
attr_NAME,
attr_DEFAULT   ) 

Value:

m_##attr_NAME = attr_DEFAULT; \
        inh_##attr_NAME = true;
getter: validates and returns the attribute's value

Definition at line 459 of file charstyle.h.


Enumeration Type Documentation

Enumerator:
ScStyle_Default 
ScStyle_Superscript 
ScStyle_Subscript 
ScStyle_Outline 
ScStyle_Underline 
ScStyle_Strikethrough 
ScStyle_AllCaps 
ScStyle_SmallCaps 
ScStyle_HyphenationPossible 
ScStyle_Shadowed 
ScStyle_UnderlineWords 
ScStyle_Reserved01 
ScStyle_DropCap 
ScStyle_SuppressSpace 
ScStyle_SmartHyphenVisible 
ScStyle_StartOfLine 
ScStyle_UserStyles 
ScStyle_None 

Definition at line 24 of file charstyle.h.

Created with personalized Doxygen. This is documentation for GPL software Scribus - Open Source Desktop Publishing.