KoTextFormat Class Reference
Each character (KoTextStringChar) points to a KoTextFormat that defines the formatting of that character (font, bold, italic, underline, misspelled etc. More...
#include <kotextformat.h>
Collaboration diagram for KoTextFormat:

Public Types | |
enum | Flags { NoFlags, Bold = 1, Italic = 2, Underline = 4, Family = 8, Size = 16, Color = 32, Misspelled = 64, VAlign = 128, StrikeOut = 512, TextBackgroundColor = 1024, ExtendUnderLine = 2048, Language = 4096, ShadowText = 8192, OffsetFromBaseLine = 16384, WordByWord = 32768, Attribute = 65536, Hyphenation = 131072, UnderLineWidth = 262144, Font = Bold | Italic | Underline | Family | Size, Format } |
enum | VerticalAlignment { AlignNormal, AlignSubScript, AlignSuperScript } |
enum | UnderlineType { U_NONE = 0, U_SIMPLE = 1, U_DOUBLE = 2, U_SIMPLE_BOLD = 3, U_WAVE = 4 } |
enum | StrikeOutType { S_NONE = 0, S_SIMPLE = 1, S_DOUBLE = 2, S_SIMPLE_BOLD = 3 } |
enum | UnderlineStyle { U_SOLID = 0, U_DASH = 1, U_DOT = 2, U_DASH_DOT = 3, U_DASH_DOT_DOT = 4 } |
enum | StrikeOutStyle { S_SOLID = 0, S_DASH = 1, S_DOT = 2, S_DASH_DOT = 3, S_DASH_DOT_DOT = 4 } |
enum | AttributeStyle { ATT_NONE = 0, ATT_UPPER = 1, ATT_LOWER = 2, ATT_SMALL_CAPS } |
Public Member Functions | |
KoTextFormat (const QFont &f, const QColor &c, const QString &_language, bool hyphenation, KoTextFormatCollection *parent=0) | |
KoTextFormat (const QFont &_font, VerticalAlignment _valign, const QColor &_color, const QColor &_backGroundColor, const QColor &_underlineColor, KoTextFormat::UnderlineType _underlineType, KoTextFormat::UnderlineStyle _underlineStyle, KoTextFormat::StrikeOutType _strikeOutType, KoTextFormat::StrikeOutStyle _strikeOutStyle, KoTextFormat::AttributeStyle _fontAttribute, const QString &_language, double _relativeTextSize, int _offsetFromBaseLine, bool _wordByWord, bool _hyphenation, double _shadowDistanceX, double _shadowDistanceY, const QColor &shadowColor) | |
KoTextFormat (const KoTextFormat &fm) | |
KoTextFormat & | operator= (const KoTextFormat &fm) |
void | copyFormat (const KoTextFormat &fm, int flags) |
QColor | color () const |
QFont | font () const |
int | pointSize () const |
bool | isMisspelled () const |
VerticalAlignment | vAlign () const |
int | width (const QChar &c) const |
int | width (const QString &str, int pos) const |
int | height () const |
int | ascent () const |
int | descent () const |
int | offsetX () const |
int | offsetY () const |
void | setBold (bool b) |
void | setItalic (bool b) |
void | setUnderline (bool b) |
void | setFamily (const QString &f) |
void | setPointSize (int s) |
void | setFont (const QFont &f) |
void | setColor (const QColor &c) |
void | setMisspelled (bool b) |
void | setVAlign (VerticalAlignment a) |
bool | operator== (const KoTextFormat &f) const |
KoTextFormatCollection * | parent () const |
void | setCollection (KoTextFormatCollection *parent) |
QString | key () const |
void | addRef () |
void | removeRef () |
int | compare (const KoTextFormat &format) const |
void | setStrikeOutType (StrikeOutType _type) |
StrikeOutType | strikeOutType () const |
void | setStrikeOutStyle (StrikeOutStyle _type) |
StrikeOutStyle | strikeOutStyle () const |
void | setTextBackgroundColor (const QColor &) |
QColor | textBackgroundColor () const |
void | setTextUnderlineColor (const QColor &) |
QColor | textUnderlineColor () const |
void | setUnderlineType (UnderlineType _type) |
UnderlineType | underlineType () const |
void | setUnderlineStyle (UnderlineStyle _type) |
UnderlineStyle | underlineStyle () const |
void | setLanguage (const QString &_lang) |
QString | language () const |
void | setHyphenation (bool b) |
bool | hyphenation () const |
void | setUnderLineWidth (double ulw) |
double | underLineWidth () const |
void | setAttributeFont (KoTextFormat::AttributeStyle _att) |
KoTextFormat::AttributeStyle | attributeFont () const |
double | shadowDistanceX () const |
double | shadowDistanceY () const |
QColor | shadowColor () const |
int | shadowX (KoZoomHandler *zh) const |
int | shadowY (KoZoomHandler *zh) const |
void | setShadow (double shadowDistanceX, double shadowDistanceY, const QColor &shadowColor) |
QString | shadowAsCss () const |
void | parseShadowFromCss (const QString &css) |
double | relativeTextSize () const |
void | setRelativeTextSize (double _size) |
int | offsetFromBaseLine () const |
void | setOffsetFromBaseLine (int _offset) |
bool | wordByWord () const |
void | setWordByWord (bool _b) |
bool | doubleUnderline () const |
bool | waveUnderline () const |
bool | underline () const |
bool | strikeOut () const |
bool | doubleStrikeOut () const |
bool | isStrikedOrUnderlined () const |
float | refPointSize () const |
float | screenPointSize (const KoZoomHandler *zh) const |
const QFontMetrics & | refFontMetrics () const |
const QFontMetrics & | screenFontMetrics (const KoZoomHandler *zh) const |
QFont | refFont () const |
QFont | screenFont (const KoZoomHandler *zh) const |
QFont | smallCapsFont (const KoZoomHandler *zh, bool applyZoom) const |
int | charWidth (const KoZoomHandler *zh, bool applyZoom, const KoTextStringChar *c, const KoTextParag *parag, int i) const |
int | charWidthLU (const KoTextStringChar *c, const KoTextParag *parag, int i) const |
void | applyCharStyle (KoCharStyle *_style) |
KoCharStyle * | style () const |
QString | displayedString (const QString &c) const |
void | load (KoOasisContext &context) |
void | save (KoGenStyle &gs, KoSavingContext &context) const |
void | printDebug () |
void | zoomChanged () |
Static Public Member Functions | |
static QString | getKey (const QFont &f, const QColor &c, bool misspelled, VerticalAlignment vAlign) |
static QColor | defaultTextColor (QPainter *painter) |
static QString | shadowAsCss (double shadowDistanceX, double shadowDistanceY, const QColor &shadowColor) |
static QString | underlineStyleToString (UnderlineStyle _lineType) |
static QString | strikeOutStyleToString (StrikeOutStyle _lineType) |
static UnderlineStyle | stringToUnderlineStyle (const QString &_str) |
static StrikeOutStyle | stringToStrikeOutStyle (const QString &_str) |
static QString | attributeFontToString (KoTextFormat::AttributeStyle _attr) |
static AttributeStyle | stringToAttributeFont (const QString &_str) |
static QStringList | underlineTypeList () |
static QStringList | strikeOutTypeList () |
static QStringList | fontAttributeList () |
static QStringList | underlineStyleList () |
static QStringList | strikeOutStyleList () |
Protected Member Functions | |
QChar | displayedChar (QChar c) const |
void | generateKey () |
Friends | |
class | KoTextFormatCollection |
Detailed Description
Each character (KoTextStringChar) points to a KoTextFormat that defines the formatting of that character (font, bold, italic, underline, misspelled etc.).
Formats are stored in KoTextFormatCollection and are shared for all characters with the same format. The API rule is that a const KoTextFormat* is a temporary format (out of collection) and a KoTextFormat* is a format from the collection.
Definition at line 52 of file kotextformat.h.
Constructor & Destructor Documentation
|
A simple text format with some default settings Only used for the default format.
Definition at line 84 of file kotextformat.cc. References QFont::pointSize(). |
|
A complete text format (used by KoFontDia).
Definition at line 129 of file kotextformat.cc. |
Member Function Documentation
|
Return the width of one char (from a string, not necessarily from a paragraph) in LU pixels. Do not call this for custom items, or for complex glyphs. But this can still be used for ' ' (for parag counters), 'x' (for tabs) etc. Definition at line 1307 of file kotextformat.cc. References KoTextZoomHandler::ptToLayoutUnitPt(), and refFontMetrics(). |
|
Return a set of flags showing the differences between this and 'format'.
Definition at line 970 of file kotextformat.cc. References attributeFont(), color(), fn, hyphenation(), QFont::italic(), language(), offsetFromBaseLine(), pointSize(), relativeTextSize(), shadowColor(), shadowDistanceX(), shadowDistanceY(), strikeOutType(), textBackgroundColor(), textUnderlineColor(), underlineStyle(), underlineType(), underLineWidth(), vAlign(), QFont::weight(), and wordByWord(). |
|
Call this when a text color is set to 'invalid', meaning 'whatever the default for the color scheme is'.
Definition at line 1014 of file kotextformat.cc. Referenced by KoVariable::drawCustomItemHelper(). |
|
Return the amount of pixels for the horizontal shadow distance at a given zoom level.
Definition at line 1393 of file kotextformat.cc. References KoZoomHandler::zoomItX(). |
|
Return the amount of pixels for the vertical shadow distance at a given zoom level.
Definition at line 1398 of file kotextformat.cc. References KoZoomHandler::zoomItY(). |
|
Return css string for the shadow, used when saving.
Definition at line 1338 of file kotextformat.cc. Referenced by KoParagLayout::loadParagLayout(), and save(). |
|
Load shadow attributes from a css string, used when loading.
Definition at line 1343 of file kotextformat.cc. References KoUnit::parseValue(). Referenced by load(). |
|
Definition at line 1030 of file kotextformat.cc. Referenced by refFont(). |
|
Definition at line 1021 of file kotextformat.cc. References KoTextZoomHandler::ptToLayoutUnitPt(). Referenced by screenFont(). |
|
Definition at line 1087 of file kotextformat.cc. References refFont(). Referenced by charWidth(), and width(). |
|
Returns the font metrics for the font used at the zoom & resolution given by 'zh'. Despite the name, this is probably valid for printing too. This method takes care of superscript and subscript (smaller font). Definition at line 1074 of file kotextformat.cc. References screenFont(). Referenced by charWidth(). |
|
Definition at line 1038 of file kotextformat.cc. References refPointSize(). Referenced by refFontMetrics(). |
|
Returns the font to be used at the zoom & resolution given by 'zh'. Despite the name, this is probably valid for printing too. This method takes care of superscript and subscript (smaller font). Definition at line 1053 of file kotextformat.cc. References screenPointSize(). Referenced by screenFontMetrics(). |
|
Return the width of one char in one paragraph. Used by KoTextFormatter twice: once for the 100% zoom pointsize (via charWidthLU), and once for the current zoom pointsize. Definition at line 1109 of file kotextformat.cc. References refFontMetrics(), and screenFontMetrics(). Referenced by charWidthLU(). |
|
Return the width of one char in LU pixels. Equivalent to ptToLayoutUnitPt( charWidth( 0L, false, c, parag, i ) ) Definition at line 1300 of file kotextformat.cc. References charWidth(), and KoTextZoomHandler::ptToLayoutUnitPt(). |
|
Load a text format from OASIS XML.
Definition at line 366 of file kotextformat.cc. References KoStyleStack::attributeNS(), KoStyleStack::fontSize(), KoStyleStack::hasAttributeNS(), parseShadowFromCss(), KoStyleStack::setTypeProperties(), and KoOasisContext::styleStack(). Referenced by KoParagStyle::loadStyle(). |
|
Save a text format to OASIS XML.
Definition at line 532 of file kotextformat.cc. References KoSavingContext::addFontFace(), KoGenStyle::addProperty(), KoGenStyle::addPropertyPt(), QFont::italic(), QFont::pointSize(), shadowAsCss(), KoGenStyle::TextType, and QFont::weight(). Referenced by KoParagStyle::saveStyle(). |
The documentation for this class was generated from the following files: