#include <KoTextObject.h>

Inheritance diagram for KoTextFormatInterface:

Public Member Functions
virtual KoTextFormat *	currentFormat () const =0
virtual bool	rtl () const =0
virtual KCommand *	setFormatCommand (const KoTextFormat *format, int flags, bool zoomFont=false)=0
virtual const KoParagLayout *	currentParagLayoutFormat () const =0
virtual KCommand *	setParagLayoutFormatCommand (KoParagLayout *newLayout, int flags, int marginIndex=-1)=0
virtual KCommand *	setChangeCaseOfTextCommand (KoChangeCaseDia::TypeOfCase _type)=0
KoTextDocCommand *	deleteTextCommand (KoTextDocument *textdoc, int id, int index, const TQMemArray< KoTextStringChar > &str, const CustomItemsMap &customItemsMap, const TQValueList< KoParagLayout > &oldParagLayouts)
void	setParagLayoutFormat (KoParagLayout *newLayout, int flags, int marginIndex=-1)
void	setFormat (KoTextFormat *newFormat, int flags, bool zoomFont=false)
KCommand *	setBoldCommand (bool on)
KCommand *	setItalicCommand (bool on)
KCommand *	setUnderlineCommand (bool on)
KCommand *	setDoubleUnderlineCommand (bool on)
KCommand *	setUnderlineColorCommand (const TQColor &color)
KCommand *	setStrikeOutCommand (bool on)
KCommand *	setTextColorCommand (const TQColor &color)
KCommand *	setPointSizeCommand (int s)
KCommand *	setFamilyCommand (const TQString &font)
KCommand *	setTextSubScriptCommand (bool on)
KCommand *	setTextSuperScriptCommand (bool on)
KCommand *	setDefaultFormatCommand ()
KCommand *	setTextBackgroundColorCommand (const TQColor &)
KCommand *	setAlignCommand (int align)
KCommand *	setMarginCommand (TQStyleSheetItem::Margin m, double margin)
KCommand *	setTabListCommand (const KoTabulatorList &tabList)
KCommand *	setBackgroundColorCommand (const TQColor &color)
KCommand *	setCounterCommand (const KoParagCounter &counter)
KCommand *	setLanguageCommand (const TQString &)
KCommand *	setShadowTextCommand (double shadowDistanceX, double shadowDistanceY, const TQColor &shadowColor)
KCommand *	setHyphenationCommand (bool _b)
KCommand *	setFontAttributeCommand (KoTextFormat::AttributeStyle _att)
KCommand *	setRelativeTextSizeCommand (double _size)
KCommand *	setOffsetFromBaseLineCommand (int _offset)
KCommand *	setWordByWordCommand (bool _b)
TQColor	textColor () const
TQFont	textFont () const
TQString	textFontFamily () const
TQString	language () const
TQColor	textBackgroundColor () const
TQColor	textUnderlineColor () const
KoTextFormat::UnderlineType	underlineType () const
KoTextFormat::StrikeOutType	strikeOutType () const
KoTextFormat::UnderlineStyle	underlineStyle () const
KoTextFormat::StrikeOutStyle	strikeOutStyle () const
bool	textUnderline () const
bool	textDoubleUnderline () const
bool	textBold () const
bool	textStrikeOut () const
bool	textItalic () const
bool	textSubScript () const
bool	textSuperScript () const
double	shadowDistanceX () const
double	shadowDistanceY () const
TQColor	shadowColor () const
KoTextFormat::AttributeStyle	fontAttribute () const
double	relativeTextSize () const
int	offsetFromBaseLine () const
bool	wordByWord () const
bool	hyphenation () const

Detailed Description

The KoTextFormatInterface is a pure interface that allows access to the "current text format".

This is implemented by both KoTextObject and KoTextView. For KoTextView, it's the format under the cursor. For KoTextObject, it's the global format. By changing this format and calling setFormat (with the appropriate flags), it's possible to implement "setBold", "setItalic" etc. only once, whether it applies to a text selection or to complete text objects.

Definition at line 48 of file KoTextObject.h.

Constructor & Destructor Documentation

◆ KoTextFormatInterface()

KoTextFormatInterface::KoTextFormatInterface ( )

inline

Definition at line 51 of file KoTextObject.h.

◆ ~KoTextFormatInterface()

virtual KoTextFormatInterface::~KoTextFormatInterface ( )

inlinevirtual

Definition at line 52 of file KoTextObject.h.

Member Function Documentation

◆ currentFormat()

virtual KoTextFormat * KoTextFormatInterface::currentFormat ( ) const

pure virtual

Interface for accessing the current format.

Implemented in KoTextObject, and KoTextView.

◆ currentParagLayoutFormat()

virtual const KoParagLayout * KoTextFormatInterface::currentParagLayoutFormat ( ) const

pure virtual

Interface for accessing the current parag layout.

Implemented in KoTextObject, and KoTextView.

◆ deleteTextCommand()

KoTextDocCommand * KoTextFormatInterface::deleteTextCommand	(	KoTextDocument *	textdoc,
		int	id,
		int	index,
		const TQMemArray< KoTextStringChar > &	str,
		const CustomItemsMap &	customItemsMap,
		const TQValueList< KoParagLayout > &	oldParagLayouts )

Definition at line 2805 of file KoTextObject.cpp.

◆ fontAttribute()

KoTextFormat::AttributeStyle KoTextFormatInterface::fontAttribute ( ) const

Definition at line 2589 of file KoTextObject.cpp.

◆ hyphenation()

bool KoTextFormatInterface::hyphenation ( ) const

Definition at line 2609 of file KoTextObject.cpp.

◆ language()

TQString KoTextFormatInterface::language ( ) const

Definition at line 2647 of file KoTextObject.cpp.

◆ offsetFromBaseLine()

int KoTextFormatInterface::offsetFromBaseLine ( ) const

Definition at line 2599 of file KoTextObject.cpp.

◆ relativeTextSize()

double KoTextFormatInterface::relativeTextSize ( ) const

Definition at line 2594 of file KoTextObject.cpp.

◆ setAlignCommand()

KCommand * KoTextFormatInterface::setAlignCommand ( int align )

Definition at line 2693 of file KoTextObject.cpp.

◆ setBoldCommand()

KCommand * KoTextFormatInterface::setBoldCommand ( bool on )

Definition at line 2461 of file KoTextObject.cpp.

◆ setCounterCommand()

KCommand * KoTextFormatInterface::setCounterCommand ( const KoParagCounter & counter )

Definition at line 2789 of file KoTextObject.cpp.

◆ setDefaultFormatCommand()

KCommand * KoTextFormatInterface::setDefaultFormatCommand ( )

Definition at line 2679 of file KoTextObject.cpp.

◆ setDoubleUnderlineCommand()

KCommand * KoTextFormatInterface::setDoubleUnderlineCommand ( bool on )

Definition at line 2489 of file KoTextObject.cpp.

◆ setFamilyCommand()

KCommand * KoTextFormatInterface::setFamilyCommand ( const TQString & font )

Definition at line 2517 of file KoTextObject.cpp.

◆ setFontAttributeCommand()

KCommand * KoTextFormatInterface::setFontAttributeCommand ( KoTextFormat::AttributeStyle _att )

Definition at line 2715 of file KoTextObject.cpp.

◆ setFormatCommand()

virtual KCommand * KoTextFormatInterface::setFormatCommand	(	const KoTextFormat *	format,
		int	flags,
		bool	zoomFont = false )

pure virtual

Interface for setting the modified format.

Parameters

format	can be a temporary format
zoomFont	set to true if the font size was used-specified (e.g. in KoFontDia)
flags	see enum KoTextFormat::Flags

Implemented in KoTextObject, and KoTextView.

◆ setHyphenationCommand()

KCommand * KoTextFormatInterface::setHyphenationCommand ( bool _b )

Definition at line 2700 of file KoTextObject.cpp.

◆ setItalicCommand()

KCommand * KoTextFormatInterface::setItalicCommand ( bool on )

Definition at line 2468 of file KoTextObject.cpp.

◆ setLanguageCommand()

KCommand * KoTextFormatInterface::setLanguageCommand ( const TQString & _lang )

Definition at line 2798 of file KoTextObject.cpp.

◆ setMarginCommand()

KCommand * KoTextFormatInterface::setMarginCommand	(	TQStyleSheetItem::Margin	m,
		double	margin )

Definition at line 2775 of file KoTextObject.cpp.

◆ setOffsetFromBaseLineCommand()

KCommand * KoTextFormatInterface::setOffsetFromBaseLineCommand ( int _offset )

Definition at line 2729 of file KoTextObject.cpp.

◆ setParagLayoutFormatCommand()

virtual KCommand * KoTextFormatInterface::setParagLayoutFormatCommand	(	KoParagLayout *	newLayout,
		int	flags,
		int	marginIndex = -1 )

pure virtual

Interface for changing the paragraph layout.

Parameters

newLayout	pointer to the new layout to apply
flags	one of the KoParagLayout flags
marginIndex	type of margin. Only used if flags==KoParagLayout::Margins

Implemented in KoTextObject, and KoTextView.

◆ setPointSizeCommand()

KCommand * KoTextFormatInterface::setPointSizeCommand ( int s )

Definition at line 2510 of file KoTextObject.cpp.

◆ setRelativeTextSizeCommand()

KCommand * KoTextFormatInterface::setRelativeTextSizeCommand ( double _size )

Definition at line 2722 of file KoTextObject.cpp.

◆ setShadowTextCommand()

KCommand * KoTextFormatInterface::setShadowTextCommand	(	double	shadowDistanceX,
		double	shadowDistanceY,
		const TQColor &	shadowColor )

Definition at line 2708 of file KoTextObject.cpp.

◆ setStrikeOutCommand()

KCommand * KoTextFormatInterface::setStrikeOutCommand ( bool on )

Definition at line 2496 of file KoTextObject.cpp.

◆ setTabListCommand()

KCommand * KoTextFormatInterface::setTabListCommand ( const KoTabulatorList & tabList )

Definition at line 2782 of file KoTextObject.cpp.

◆ setTextBackgroundColorCommand()

KCommand * KoTextFormatInterface::setTextBackgroundColorCommand ( const TQColor & col )

Definition at line 2503 of file KoTextObject.cpp.

◆ setTextColorCommand()

KCommand * KoTextFormatInterface::setTextColorCommand ( const TQColor & color )

Definition at line 2652 of file KoTextObject.cpp.

◆ setTextSubScriptCommand()

KCommand * KoTextFormatInterface::setTextSubScriptCommand ( bool on )

Definition at line 2659 of file KoTextObject.cpp.

◆ setTextSuperScriptCommand()

KCommand * KoTextFormatInterface::setTextSuperScriptCommand ( bool on )

Definition at line 2669 of file KoTextObject.cpp.

◆ setUnderlineColorCommand()

KCommand * KoTextFormatInterface::setUnderlineColorCommand ( const TQColor & color )

Definition at line 2482 of file KoTextObject.cpp.

◆ setUnderlineCommand()

KCommand * KoTextFormatInterface::setUnderlineCommand ( bool on )

Definition at line 2475 of file KoTextObject.cpp.

◆ setWordByWordCommand()

KCommand * KoTextFormatInterface::setWordByWordCommand ( bool _b )

Definition at line 2736 of file KoTextObject.cpp.

◆ shadowColor()

TQColor KoTextFormatInterface::shadowColor ( ) const

Definition at line 2584 of file KoTextObject.cpp.

◆ shadowDistanceX()

double KoTextFormatInterface::shadowDistanceX ( ) const

Definition at line 2574 of file KoTextObject.cpp.

◆ shadowDistanceY()

double KoTextFormatInterface::shadowDistanceY ( ) const

Definition at line 2579 of file KoTextObject.cpp.

◆ strikeOutStyle()

KoTextFormat::StrikeOutStyle KoTextFormatInterface::strikeOutStyle ( ) const

Definition at line 2629 of file KoTextObject.cpp.

◆ strikeOutType()

KoTextFormat::StrikeOutType KoTextFormatInterface::strikeOutType ( ) const

Definition at line 2619 of file KoTextObject.cpp.

◆ textBackgroundColor()

TQColor KoTextFormatInterface::textBackgroundColor ( ) const

Definition at line 2524 of file KoTextObject.cpp.

◆ textBold()

bool KoTextFormatInterface::textBold ( ) const

Definition at line 2549 of file KoTextObject.cpp.

◆ textColor()

TQColor KoTextFormatInterface::textColor ( ) const

Definition at line 2534 of file KoTextObject.cpp.

◆ textDoubleUnderline()

bool KoTextFormatInterface::textDoubleUnderline ( ) const

Definition at line 2544 of file KoTextObject.cpp.

◆ textFont()

TQFont KoTextFormatInterface::textFont ( ) const

Definition at line 2634 of file KoTextObject.cpp.

◆ textFontFamily()

TQString KoTextFormatInterface::textFontFamily ( ) const

Definition at line 2642 of file KoTextObject.cpp.

◆ textItalic()

bool KoTextFormatInterface::textItalic ( ) const

Definition at line 2559 of file KoTextObject.cpp.

◆ textStrikeOut()

bool KoTextFormatInterface::textStrikeOut ( ) const

Definition at line 2554 of file KoTextObject.cpp.

◆ textSubScript()

bool KoTextFormatInterface::textSubScript ( ) const

Definition at line 2564 of file KoTextObject.cpp.

◆ textSuperScript()

bool KoTextFormatInterface::textSuperScript ( ) const

Definition at line 2569 of file KoTextObject.cpp.

◆ textUnderline()

bool KoTextFormatInterface::textUnderline ( ) const

Definition at line 2539 of file KoTextObject.cpp.

◆ textUnderlineColor()

TQColor KoTextFormatInterface::textUnderlineColor ( ) const

Definition at line 2529 of file KoTextObject.cpp.

◆ underlineStyle()

KoTextFormat::UnderlineStyle KoTextFormatInterface::underlineStyle ( ) const

Definition at line 2624 of file KoTextObject.cpp.

◆ underlineType()

KoTextFormat::UnderlineType KoTextFormatInterface::underlineType ( ) const

Definition at line 2614 of file KoTextObject.cpp.

◆ wordByWord()

bool KoTextFormatInterface::wordByWord ( ) const

Definition at line 2604 of file KoTextObject.cpp.

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

lib

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ KoTextFormatInterface()

◆ ~KoTextFormatInterface()

Member Function Documentation

◆ currentFormat()

◆ currentParagLayoutFormat()

◆ deleteTextCommand()

◆ fontAttribute()

◆ hyphenation()

◆ language()

◆ offsetFromBaseLine()

◆ relativeTextSize()

◆ setAlignCommand()

◆ setBoldCommand()

◆ setCounterCommand()

◆ setDefaultFormatCommand()

◆ setDoubleUnderlineCommand()

◆ setFamilyCommand()

◆ setFontAttributeCommand()

◆ setFormatCommand()

◆ setHyphenationCommand()

◆ setItalicCommand()

◆ setLanguageCommand()

◆ setMarginCommand()

◆ setOffsetFromBaseLineCommand()

◆ setParagLayoutFormatCommand()

◆ setPointSizeCommand()

◆ setRelativeTextSizeCommand()

◆ setShadowTextCommand()

◆ setStrikeOutCommand()

◆ setTabListCommand()

◆ setTextBackgroundColorCommand()

◆ setTextColorCommand()

◆ setTextSubScriptCommand()

◆ setTextSuperScriptCommand()

◆ setUnderlineColorCommand()

◆ setUnderlineCommand()

◆ setWordByWordCommand()

◆ shadowColor()

◆ shadowDistanceX()

◆ shadowDistanceY()

◆ strikeOutStyle()

◆ strikeOutType()

◆ textBackgroundColor()

◆ textBold()

◆ textColor()

◆ textDoubleUnderline()

◆ textFont()

◆ textFontFamily()

◆ textItalic()

◆ textStrikeOut()

◆ textSubScript()

◆ textSuperScript()

◆ textUnderline()

◆ textUnderlineColor()

◆ underlineStyle()

◆ underlineType()

◆ wordByWord()

lib

lib