#include <KoTextFormat.h>
|
| 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
, AlignCustom
} |
| |
| 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
} |
| |
|
| | KoTextFormat (const TQFont &f, const TQColor &c, const TQString &_language, bool hyphenation, KoTextFormatCollection *parent=0) |
| |
| | KoTextFormat (const TQFont &_font, VerticalAlignment _valign, const TQColor &_color, const TQColor &_backGroundColor, const TQColor &_underlineColor, KoTextFormat::UnderlineType _underlineType, KoTextFormat::UnderlineStyle _underlineStyle, KoTextFormat::StrikeOutType _strikeOutType, KoTextFormat::StrikeOutStyle _strikeOutStyle, KoTextFormat::AttributeStyle _fontAttribute, const TQString &_language, double _relativeTextSize, int _offsetFromBaseLine, bool _wordByWord, bool _hyphenation, double _shadowDistanceX, double _shadowDistanceY, const TQColor &shadowColor) |
| |
| | KoTextFormat (const KoTextFormat &fm) |
| |
| KoTextFormat & | operator= (const KoTextFormat &fm) |
| |
| void | copyFormat (const KoTextFormat &fm, int flags) |
| |
| TQColor | color () const |
| |
| TQFont | font () const |
| |
| int | pointSize () const |
| |
| bool | isMisspelled () const |
| |
| VerticalAlignment | vAlign () const |
| |
| int | width (const TQChar &c) const |
| |
|
int | width (const TQString &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 TQString &f) |
| |
| void | setPointSize (int s) |
| |
| void | setFont (const TQFont &f) |
| |
| void | setColor (const TQColor &c) |
| |
| void | setMisspelled (bool b) |
| |
| void | setVAlign (VerticalAlignment a) |
| |
| bool | operator== (const KoTextFormat &f) const |
| |
| KoTextFormatCollection * | parent () const |
| |
| void | setCollection (KoTextFormatCollection *parent) |
| |
| TQString | 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 TQColor &) |
| |
| TQColor | textBackgroundColor () const |
| |
| void | setTextUnderlineColor (const TQColor &) |
| |
| TQColor | textUnderlineColor () const |
| |
| void | setUnderlineType (UnderlineType _type) |
| |
| UnderlineType | underlineType () const |
| |
| void | setUnderlineStyle (UnderlineStyle _type) |
| |
| UnderlineStyle | underlineStyle () const |
| |
| void | setLanguage (const TQString &_lang) |
| |
| TQString | 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 |
| |
| TQColor | shadowColor () const |
| |
| int | shadowX (KoTextZoomHandler *zh) const |
| |
| int | shadowY (KoTextZoomHandler *zh) const |
| |
| void | setShadow (double shadowDistanceX, double shadowDistanceY, const TQColor &shadowColor) |
| |
| TQString | shadowAsCss () const |
| |
| void | parseShadowFromCss (const TQString &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 KoTextZoomHandler *zh) const |
| |
| const TQFontMetrics & | refFontMetrics () const |
| |
| const TQFontMetrics & | screenFontMetrics (const KoTextZoomHandler *zh) const |
| |
| TQFont | refFont () const |
| |
| TQFont | screenFont (const KoTextZoomHandler *zh) const |
| |
| TQFont | smallCapsFont (const KoTextZoomHandler *zh, bool applyZoom) const |
| |
| int | charWidth (const KoTextZoomHandler *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 |
| |
| TQString | displayedString (const TQString &c) const |
| |
| void | load (KoOasisContext &context) |
| |
| void | save (KoGenStyle &gs, KoSavingContext &context, KoTextFormat *refFormat=0) const |
| |
| void | printDebug () |
| |
| void | zoomChanged () |
| |
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.
◆ AttributeStyle
| enum KoTextFormat::AttributeStyle |
◆ Flags
◆ StrikeOutStyle
| enum KoTextFormat::StrikeOutStyle |
◆ StrikeOutType
| enum KoTextFormat::StrikeOutType |
◆ UnderlineStyle
| enum KoTextFormat::UnderlineStyle |
◆ UnderlineType
| enum KoTextFormat::UnderlineType |
◆ VerticalAlignment
| enum KoTextFormat::VerticalAlignment |
◆ KoTextFormat() [1/4]
| KoTextFormat::KoTextFormat |
( |
| ) |
|
◆ ~KoTextFormat()
| KoTextFormat::~KoTextFormat |
( |
| ) |
|
◆ KoTextFormat() [2/4]
| KoTextFormat::KoTextFormat |
( |
const TQFont & |
f, |
|
|
const TQColor & |
c, |
|
|
const TQString & |
_language, |
|
|
bool |
hyphenation, |
|
|
KoTextFormatCollection * |
parent = 0 |
|
) |
| |
A simple text format with some default settings Only used for the default format.
Definition at line 85 of file KoTextFormat.cpp.
◆ KoTextFormat() [3/4]
| KoTextFormat::KoTextFormat |
( |
const TQFont & |
_font, |
|
|
VerticalAlignment |
_valign, |
|
|
const TQColor & |
_color, |
|
|
const TQColor & |
_backGroundColor, |
|
|
const TQColor & |
_underlineColor, |
|
|
KoTextFormat::UnderlineType |
_underlineType, |
|
|
KoTextFormat::UnderlineStyle |
_underlineStyle, |
|
|
KoTextFormat::StrikeOutType |
_strikeOutType, |
|
|
KoTextFormat::StrikeOutStyle |
_strikeOutStyle, |
|
|
KoTextFormat::AttributeStyle |
_fontAttribute, |
|
|
const TQString & |
_language, |
|
|
double |
_relativeTextSize, |
|
|
int |
_offsetFromBaseLine, |
|
|
bool |
_wordByWord, |
|
|
bool |
_hyphenation, |
|
|
double |
_shadowDistanceX, |
|
|
double |
_shadowDistanceY, |
|
|
const TQColor & |
shadowColor |
|
) |
| |
◆ KoTextFormat() [4/4]
◆ addRef()
| void KoTextFormat::addRef |
( |
| ) |
|
◆ applyCharStyle()
| void KoTextFormat::applyCharStyle |
( |
KoCharStyle * |
_style | ) |
|
◆ ascent()
| int KoTextFormat::ascent |
( |
| ) |
const |
◆ attributeFont()
| KoTextFormat::AttributeStyle KoTextFormat::attributeFont |
( |
| ) |
const |
|
inline |
◆ attributeFontToString()
| TQString KoTextFormat::attributeFontToString |
( |
KoTextFormat::AttributeStyle |
_attr | ) |
|
|
static |
◆ charWidth()
| int KoTextFormat::charWidth |
( |
const KoTextZoomHandler * |
zh, |
|
|
bool |
applyZoom, |
|
|
const KoTextStringChar * |
c, |
|
|
const KoTextParag * |
parag, |
|
|
int |
i |
|
) |
| const |
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 1179 of file KoTextFormat.cpp.
◆ charWidthLU()
| int KoTextFormat::charWidthLU |
( |
const KoTextStringChar * |
c, |
|
|
const KoTextParag * |
parag, |
|
|
int |
i |
|
) |
| const |
Return the width of one char in LU pixels.
Equivalent to ptToLayoutUnitPt( charWidth( 0L, false, c, parag, i ) )
Definition at line 1370 of file KoTextFormat.cpp.
◆ color()
| TQColor KoTextFormat::color |
( |
| ) |
const |
|
inline |
◆ compare()
| int KoTextFormat::compare |
( |
const KoTextFormat & |
format | ) |
const |
Return a set of flags showing the differences between this and 'format'.
Definition at line 1040 of file KoTextFormat.cpp.
◆ copyFormat()
| void KoTextFormat::copyFormat |
( |
const KoTextFormat & |
fm, |
|
|
int |
flags |
|
) |
| |
◆ defaultTextColor()
| TQColor KoTextFormat::defaultTextColor |
( |
TQPainter * |
painter | ) |
|
|
static |
Call this when a text color is set to 'invalid', meaning 'whatever the default for the color scheme is'.
Definition at line 1084 of file KoTextFormat.cpp.
◆ descent()
| int KoTextFormat::descent |
( |
| ) |
const |
◆ displayedChar()
| TQChar KoTextFormat::displayedChar |
( |
TQChar |
c | ) |
const |
|
protected |
◆ displayedString()
| TQString KoTextFormat::displayedString |
( |
const TQString & |
c | ) |
const |
◆ doubleStrikeOut()
| bool KoTextFormat::doubleStrikeOut |
( |
| ) |
const |
|
inline |
◆ doubleUnderline()
| bool KoTextFormat::doubleUnderline |
( |
| ) |
const |
|
inline |
◆ font()
| TQFont KoTextFormat::font |
( |
| ) |
const |
|
inline |
◆ fontAttributeList()
| TQStringList KoTextFormat::fontAttributeList |
( |
| ) |
|
|
static |
◆ generateKey()
| void KoTextFormat::generateKey |
( |
| ) |
|
|
protected |
◆ getKey()
| TQString KoTextFormat::getKey |
( |
const TQFont & |
f, |
|
|
const TQColor & |
c, |
|
|
bool |
misspelled, |
|
|
VerticalAlignment |
vAlign |
|
) |
| |
|
static |
◆ height()
| int KoTextFormat::height |
( |
| ) |
const |
◆ hyphenation()
| bool KoTextFormat::hyphenation |
( |
| ) |
const |
|
inline |
◆ isMisspelled()
| bool KoTextFormat::isMisspelled |
( |
| ) |
const |
|
inline |
◆ isStrikedOrUnderlined()
| bool KoTextFormat::isStrikedOrUnderlined |
( |
| ) |
const |
|
inline |
◆ key()
| TQString KoTextFormat::key |
( |
| ) |
const |
◆ language()
| TQString KoTextFormat::language |
( |
| ) |
const |
|
inline |
◆ load()
◆ offsetFromBaseLine()
| int KoTextFormat::offsetFromBaseLine |
( |
| ) |
const |
|
inline |
◆ offsetX()
| int KoTextFormat::offsetX |
( |
| ) |
const |
◆ offsetY()
| int KoTextFormat::offsetY |
( |
| ) |
const |
◆ operator=()
◆ operator==()
| bool KoTextFormat::operator== |
( |
const KoTextFormat & |
f | ) |
const |
|
inline |
◆ parent()
| KoTextFormatCollection * KoTextFormat::parent |
( |
| ) |
const |
|
inline |
◆ parseShadowFromCss()
| void KoTextFormat::parseShadowFromCss |
( |
const TQString & |
css | ) |
|
Load shadow attributes from a css string, used when loading.
Definition at line 1413 of file KoTextFormat.cpp.
◆ pointSize()
| int KoTextFormat::pointSize |
( |
| ) |
const |
|
inline |
◆ printDebug()
| void KoTextFormat::printDebug |
( |
| ) |
|
◆ refFont()
| TQFont KoTextFormat::refFont |
( |
| ) |
const |
- Returns
- the reference font, i.e. with the size specified by the user. This is used at text layout time (e.g. kotextformatter)
Definition at line 1108 of file KoTextFormat.cpp.
◆ refFontMetrics()
| const TQFontMetrics & KoTextFormat::refFontMetrics |
( |
| ) |
const |
- Returns
- the metrics for the reference font, i.e. with the size specified by the user. This is the one used during formatting, independently from the zoom level. This method takes care of superscript and subscript (smaller font).
Definition at line 1157 of file KoTextFormat.cpp.
◆ refPointSize()
| float KoTextFormat::refPointSize |
( |
| ) |
const |
- Returns
- the reference point size, i.e. the size specified by the user. This is the one used during formatting, independently from the zoom level. This method takes care of superscript and subscript (smaller font).
Definition at line 1100 of file KoTextFormat.cpp.
◆ relativeTextSize()
| double KoTextFormat::relativeTextSize |
( |
| ) |
const |
|
inline |
◆ removeRef()
| void KoTextFormat::removeRef |
( |
| ) |
|
◆ save()
Save a text format to OASIS XML Only saves what differs from @refFormat, if set.
Definition at line 541 of file KoTextFormat.cpp.
◆ screenFont()
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 1123 of file KoTextFormat.cpp.
◆ screenFontMetrics()
| const TQFontMetrics & KoTextFormat::screenFontMetrics |
( |
const KoTextZoomHandler * |
zh | ) |
const |
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 1144 of file KoTextFormat.cpp.
◆ screenPointSize()
- Returns
- the point size to use on screen, given
zh This method takes care of superscript and subscript (smaller font).
Definition at line 1091 of file KoTextFormat.cpp.
◆ setAttributeFont()
| void KoTextFormat::setAttributeFont |
( |
KoTextFormat::AttributeStyle |
_att | ) |
|
◆ setBold()
| void KoTextFormat::setBold |
( |
bool |
b | ) |
|
◆ setCollection()
| void KoTextFormat::setCollection |
( |
KoTextFormatCollection * |
parent | ) |
|
|
inline |
◆ setColor()
| void KoTextFormat::setColor |
( |
const TQColor & |
c | ) |
|
◆ setFamily()
| void KoTextFormat::setFamily |
( |
const TQString & |
f | ) |
|
◆ setFont()
| void KoTextFormat::setFont |
( |
const TQFont & |
f | ) |
|
◆ setHyphenation()
| void KoTextFormat::setHyphenation |
( |
bool |
b | ) |
|
◆ setItalic()
| void KoTextFormat::setItalic |
( |
bool |
b | ) |
|
◆ setLanguage()
| void KoTextFormat::setLanguage |
( |
const TQString & |
_lang | ) |
|
◆ setMisspelled()
| void KoTextFormat::setMisspelled |
( |
bool |
b | ) |
|
◆ setOffsetFromBaseLine()
| void KoTextFormat::setOffsetFromBaseLine |
( |
int |
_offset | ) |
|
◆ setPointSize()
| void KoTextFormat::setPointSize |
( |
int |
s | ) |
|
◆ setRelativeTextSize()
| void KoTextFormat::setRelativeTextSize |
( |
double |
_size | ) |
|
◆ setShadow()
| void KoTextFormat::setShadow |
( |
double |
shadowDistanceX, |
|
|
double |
shadowDistanceY, |
|
|
const TQColor & |
shadowColor |
|
) |
| |
◆ setStrikeOutStyle()
| void KoTextFormat::setStrikeOutStyle |
( |
StrikeOutStyle |
_type | ) |
|
◆ setStrikeOutType()
| void KoTextFormat::setStrikeOutType |
( |
StrikeOutType |
_type | ) |
|
◆ setTextBackgroundColor()
| void KoTextFormat::setTextBackgroundColor |
( |
const TQColor & |
_col | ) |
|
◆ setTextUnderlineColor()
| void KoTextFormat::setTextUnderlineColor |
( |
const TQColor & |
_col | ) |
|
◆ setUnderline()
| void KoTextFormat::setUnderline |
( |
bool |
b | ) |
|
◆ setUnderlineStyle()
| void KoTextFormat::setUnderlineStyle |
( |
UnderlineStyle |
_type | ) |
|
◆ setUnderlineType()
| void KoTextFormat::setUnderlineType |
( |
UnderlineType |
_type | ) |
|
◆ setUnderLineWidth()
| void KoTextFormat::setUnderLineWidth |
( |
double |
ulw | ) |
|
◆ setVAlign()
| void KoTextFormat::setVAlign |
( |
VerticalAlignment |
a | ) |
|
◆ setWordByWord()
| void KoTextFormat::setWordByWord |
( |
bool |
_b | ) |
|
◆ shadowAsCss() [1/2]
| TQString KoTextFormat::shadowAsCss |
( |
| ) |
const |
Return css string for the shadow, used when saving.
Definition at line 1408 of file KoTextFormat.cpp.
◆ shadowAsCss() [2/2]
| TQString KoTextFormat::shadowAsCss |
( |
double |
shadowDistanceX, |
|
|
double |
shadowDistanceY, |
|
|
const TQColor & |
shadowColor |
|
) |
| |
|
static |
◆ shadowColor()
| TQColor KoTextFormat::shadowColor |
( |
| ) |
const |
◆ shadowDistanceX()
| double KoTextFormat::shadowDistanceX |
( |
| ) |
const |
|
inline |
◆ shadowDistanceY()
| double KoTextFormat::shadowDistanceY |
( |
| ) |
const |
|
inline |
◆ shadowX()
Return the amount of pixels for the horizontal shadow distance at a given zoom level.
Definition at line 1463 of file KoTextFormat.cpp.
◆ shadowY()
Return the amount of pixels for the vertical shadow distance at a given zoom level.
Definition at line 1468 of file KoTextFormat.cpp.
◆ smallCapsFont()
| TQFont KoTextFormat::smallCapsFont |
( |
const KoTextZoomHandler * |
zh, |
|
|
bool |
applyZoom |
|
) |
| const |
◆ strikeOut()
| bool KoTextFormat::strikeOut |
( |
| ) |
const |
|
inline |
◆ strikeOutStyle()
| StrikeOutStyle KoTextFormat::strikeOutStyle |
( |
| ) |
const |
|
inline |
◆ strikeOutStyleList()
| TQStringList KoTextFormat::strikeOutStyleList |
( |
| ) |
|
|
static |
◆ strikeOutStyleToString()
| TQString KoTextFormat::strikeOutStyleToString |
( |
KoTextFormat::StrikeOutStyle |
_lineType | ) |
|
|
static |
◆ strikeOutType()
| StrikeOutType KoTextFormat::strikeOutType |
( |
| ) |
const |
|
inline |
◆ strikeOutTypeList()
| TQStringList KoTextFormat::strikeOutTypeList |
( |
| ) |
|
|
static |
◆ stringToAttributeFont()
| KoTextFormat::AttributeStyle KoTextFormat::stringToAttributeFont |
( |
const TQString & |
_str | ) |
|
|
static |
◆ stringToStrikeOutStyle()
| KoTextFormat::StrikeOutStyle KoTextFormat::stringToStrikeOutStyle |
( |
const TQString & |
_str | ) |
|
|
static |
◆ stringToUnderlineStyle()
| KoTextFormat::UnderlineStyle KoTextFormat::stringToUnderlineStyle |
( |
const TQString & |
_str | ) |
|
|
static |
◆ style()
◆ textBackgroundColor()
| TQColor KoTextFormat::textBackgroundColor |
( |
| ) |
const |
|
inline |
◆ textUnderlineColor()
| TQColor KoTextFormat::textUnderlineColor |
( |
| ) |
const |
|
inline |
◆ underline()
| bool KoTextFormat::underline |
( |
| ) |
const |
|
inline |
◆ underlineStyle()
| UnderlineStyle KoTextFormat::underlineStyle |
( |
| ) |
const |
|
inline |
◆ underlineStyleList()
| TQStringList KoTextFormat::underlineStyleList |
( |
| ) |
|
|
static |
◆ underlineStyleToString()
| TQString KoTextFormat::underlineStyleToString |
( |
KoTextFormat::UnderlineStyle |
_lineType | ) |
|
|
static |
◆ underlineType()
| UnderlineType KoTextFormat::underlineType |
( |
| ) |
const |
|
inline |
◆ underlineTypeList()
| TQStringList KoTextFormat::underlineTypeList |
( |
| ) |
|
|
static |
◆ underLineWidth()
| double KoTextFormat::underLineWidth |
( |
| ) |
const |
|
inline |
◆ vAlign()
| KoTextFormat::VerticalAlignment KoTextFormat::vAlign |
( |
| ) |
const |
|
inline |
◆ waveUnderline()
| bool KoTextFormat::waveUnderline |
( |
| ) |
const |
|
inline |
◆ width()
| int KoTextFormat::width |
( |
const TQChar & |
c | ) |
const |
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 1377 of file KoTextFormat.cpp.
◆ wordByWord()
| bool KoTextFormat::wordByWord |
( |
| ) |
const |
|
inline |
◆ zoomChanged()
| void KoTextFormat::zoomChanged |
( |
| ) |
|
Called when the zoom or resolution changes.
Definition at line 48 of file KoTextFormat.cpp.
◆ KoTextFormatCollection
| friend class KoTextFormatCollection |
|
friend |
The documentation for this class was generated from the following files:
|