svx::SpellPortion Struct Reference

contains a portion of text that has the same language attributes applied and belongs to the same script type. More...

#include <SpellPortions.hxx>

Collaboration diagram for svx::SpellPortion:

Public Member Functions
	SpellPortion ()

Public Attributes
OUString	sText
	contains the text of the portion. More...
css::uno::Reference< css::linguistic2::XSpellAlternatives >	xAlternatives
	for wrong words this reference is filled with the error information otherwise it's an empty reference More...
css::uno::Reference< css::linguistic2::XProofreader >	xGrammarChecker
	provides access to the grammar checker interface More...
OUString	sDialogTitle
	contains the proposed dialog title if the proof reading component provides one. More...
css::linguistic2::SingleProofreadingError	aGrammarError
	contains the grammar error information More...
LanguageType	eLanguage
	contains the language applied to the text. More...
bool	bIsField
	Marks the portion as field, footnote symbol or any other special content that should be protected against unintentional deletion. More...
bool	bIsHidden
	Marks the portion hidden content that should not be touched by spell checking and not be removed like redlines. More...
bool	bIsGrammarError
	determines whether the error type is a grammar error More...
bool	bIgnoreThisError
	marks portion as to-be-ignored. More...

Detailed Description

contains a portion of text that has the same language attributes applied and belongs to the same script type.

Definition at line 39 of file SpellPortions.hxx.

Constructor & Destructor Documentation

SpellPortion()

svx::SpellPortion::SpellPortion ( )

inline

Definition at line 76 of file SpellPortions.hxx.

References aGrammarError, and LANGUAGE_DONTKNOW.

Member Data Documentation

aGrammarError

css::linguistic2::SingleProofreadingError svx::SpellPortion::aGrammarError

contains the grammar error information

Definition at line 56 of file SpellPortions.hxx.

Referenced by SpellPortion().

bIgnoreThisError

bool svx::SpellPortion::bIgnoreThisError

marks portion as to-be-ignored.

This is a return parameter.

Definition at line 74 of file SpellPortions.hxx.

bIsField

bool svx::SpellPortion::bIsField

Marks the portion as field, footnote symbol or any other special content that should be protected against unintentional deletion.

Definition at line 63 of file SpellPortions.hxx.

Referenced by ImpEditEngine::AddPortion().

bIsGrammarError

bool svx::SpellPortion::bIsGrammarError

determines whether the error type is a grammar error

Definition at line 71 of file SpellPortions.hxx.

bIsHidden

bool svx::SpellPortion::bIsHidden

Marks the portion hidden content that should not be touched by spell checking and not be removed like redlines.

The creator of the portions has to take care for them.

Definition at line 68 of file SpellPortions.hxx.

eLanguage

LanguageType svx::SpellPortion::eLanguage

contains the language applied to the text.

It has to match the script type.

Definition at line 59 of file SpellPortions.hxx.

Referenced by ImpEditEngine::AddPortion().

sDialogTitle

OUString svx::SpellPortion::sDialogTitle

contains the proposed dialog title if the proof reading component provides one.

Definition at line 53 of file SpellPortions.hxx.

sText

OUString svx::SpellPortion::sText

contains the text of the portion.

Definition at line 43 of file SpellPortions.hxx.

Referenced by ImpEditEngine::AddPortion().

xAlternatives

css::uno::Reference< css::linguistic2::XSpellAlternatives> svx::SpellPortion::xAlternatives

for wrong words this reference is filled with the error information otherwise it's an empty reference

Definition at line 47 of file SpellPortions.hxx.

Referenced by ImpEditEngine::AddPortion().

xGrammarChecker

css::uno::Reference< css::linguistic2::XProofreader > svx::SpellPortion::xGrammarChecker

provides access to the grammar checker interface

Definition at line 50 of file SpellPortions.hxx.

---

The documentation for this struct was generated from the following file:

• SpellPortions.hxx