TextTool Class Reference

A template tool class. More...

#include <texttool.h>

Inheritance diagram for TextTool:

List of all members.

Public Member Functions
	TextTool ()
	Default Constructor. Other initialisation is done in TextTool::Init which is called by the Tool Manager.
	~TextTool ()
	Destructor (Virtual). Does nothing.
BOOL	Init ()
	Used to check if the Tool was properly constructed.
void	Describe (void *InfoPtr)
	Allows the tool manager to extract information about the tool.
UINT32	GetID ()
void	SelectChange (BOOL isSelected)
	Starts up and closes down the Text tool.
void	OnClick (DocCoord, ClickType, ClickModifiers, Spread *)
	To handle a Mouse Click event for the Text Tool.
void	OnMouseMove (DocCoord PointerPos, Spread *pSpread, ClickModifiers ClickMods)
	To handle a Mouse Move event for the Text Tool.
void	RenderToolBlobs (Spread *, DocRect *)
	Called to render the tool blobs for the text tool.
void	GetRulerOrigin (Spread *, UserCoord *)
	Gives the current tool the chance to change the coordinates displayed on the ruler.
void	RenderRulerBlobs (RulerBase *pRuler, UserRect &UpdateRect, BOOL IsBackground)
	Gives the current tool the chance to render additional blobs on the ruler Is called twice - once before the standard ruler graphics are rendered (to allow additional background to be drawn) and once afterwards.
BOOL	OnRulerClick (UserCoord PointerPos, ClickType Click, ClickModifiers Mods, Spread *pSpread, RulerBase *pRuler)
	Called when the user has clicked on the ruler and we are the current tool.
BOOL	GetRulerStatusLineText (String_256 *pText, UserCoord PointerPos, Spread *pSpread, RulerBase *pRuler)
	Allows the tool to set the status line text for the ruler.
BOOL	OnKeyPress (KeyPress *pKeyPress)
	To handle a keypress event for the Text Tool.
BOOL	GetStatusLineText (String_256 *ptext, Spread *pSpread, DocCoord DocPos, ClickModifiers ClickMods)
	Returns the current status line help string.
BOOL	OnIdle ()
	Called on idle events. Used to update the infobar kern field after typing.
void	LocaleChanged ()
	Called when the machines locale changes. Re-registers the dead keys as their virtual key code may have changed.
BOOL	SelectionHasChanged ()
	Called when the selection has changed. Ensures tool blobs are up-to-date.
virtual BOOL	AreToolBlobsRenderedOnSelection ()
Static Public Member Functions
static BOOL	DelayingUpdate ()
	Let's the caller know if the text-tool has finished mucking about with the document's modified flag.
static TextInfoBarOp *	GetTextInfoBarOp ()
static BOOL	IsCurrentTool ()
Protected Member Functions
void	DisplayStatusBarHelp (DocCoord DocPos, Spread *pSpread, ClickModifiers ClickMods)
	Displays status help string for the given position in the status bar.
void	GetCurrentStatusText (String_256 *ptext, Spread *pSpread, DocCoord DocPos, ClickModifiers ClickMods)
	Selects a suitable string for the status line based on the current location (as input via the parameters).
BOOL	IsPointNearUnselectedTextStory (Spread *, DocCoord, TextStory **, Node **, BOOL)
	To see if a click at the current positon would select a TextStory.
BOOL	IsPointNearNonStoryPath (Spread *, DocCoord, NodePath **, BOOL)
	To see if a click at the current positon should create a story on a path.
BOOL	HandleSingleClick (Spread *, DocCoord, ClickModifiers)
	To handle single click events in the text tool.
BOOL	HandleDoubleClick (Spread *, DocCoord, ClickModifiers)
	To handle double click events in the text tool.
BOOL	HandleTripleClick (Spread *, DocCoord, ClickModifiers)
	To handle triple click events in the text tool.
BOOL	HandleQuadClick (Spread *, DocCoord, ClickModifiers)
	To handle quad click events in the text tool.
BOOL	HandleDragClick (Spread *, DocCoord, ClickModifiers)
	To handle drag events in the text tool.
BOOL	RegisterDeadKeys ()
	Registers all the dead keys virtual codes with the keypress system.
BOOL	RemoveDeadKeys ()
	Deregisters all the dead keys.
BOOL	RegisterAdditionalVirtKey (KeyPress **pKey, TCHAR ch)
	Registers a requirement for a virtual key message with the KeyPress system.
BOOL	HandleSpecialNonStoryKeys (KeyPress *pKeyPress)
	To deal with keys presses that work without a focus story.
BOOL	HandleSpecialStoryAndNonStoryKeys (KeyPress *pKeyPress)
	To handle keypress events that wotk with and without a text focus story.
BOOL	HandleDeadKeys (KeyPress *pKeyPress, WCHAR *pNewUnicode)
	Flags 'dead-keys'. Attempts to apply an accent onto the next character.
BOOL	TestForDeadKey (KeyPress *pKeyPress, KeyPress *pDeadKeypress)
	Flags 'dead-keys'. Attempts to apply an accent onto the next character.
BOOL	HandleSpecialStoryKeys (KeyPress *pKeyPress, TextStory *pStory, CaretNode *pCaret)
	To handle special keypress events that apply at a story and/or caret.
BOOL	IsUsableUnicode (WCHAR CodeValue)
	Central place to filter out unicode greater than 255.
BOOL	ApplyBold ()
	Applies or removes the bold attribute from the current selection or caret.
BOOL	ApplyItalic ()
	Applies or removes the italic attribute from the current selection or caret.
BOOL	IncreaseTrackKern ()
	If there is a text selection then the tracking applied to it is increased by 10/1000's of an em If there is no selection then a kern up of 50/1000 is inserted.
BOOL	DecreaseTrackKern ()
	If there is a text selection then the tracking applied to it is decreased by 10/1000's of an em If there is no selection then a kern down of 50/1000 is inserted.
BOOL	CommonApplyKern (MILLIPOINT ChangeAmmount)
	Applys/increases/descreases the horizontal kern at the caret.
BOOL	CommonApplyTracking (MILLIPOINT ChangeAmmount)
	Applys/increases/descreases the tracking across the selected characters.
BOOL	OnToolSelect ()
	Called to do processing required when text tool is selected.
BOOL	OnToolDeselect ()
	Called to do processing required when text tool is deselected.
BOOL	CreateCursors ()
	Creates all the Text tool cursors.
void	DestroyCursors ()
	Destroys all the Text tool cursors.
Protected Attributes
Cursor *	pcNormalTextCursor
Cursor *	pcBlobTextCursor
Cursor *	pcBlankCursor
Cursor *	pcIndentCursor
Cursor *	pcCurrentCursor
INT32	CurrentCursorID
BOOL	IsBlankCursorUp
BOOL	UpdateAfterTyping
TextStory *	pLastFocusStory
KeyPress *	PreviousDeadKey
KeyPress *	GraveVirtKey
KeyPress *	AcuteVirtKey
KeyPress *	HatVirtKey
KeyPress *	TildeVirtKey
KeyPress *	ColonVirtKey
KeyPress *	AtVirtKey
KeyPress *	CommaVirtKey
KeyPress *	SlashVirtKey
TextToolBlobPosList	m_BlobPosList
Static Protected Attributes
static BOOL	CurrentTool = FALSE
static TextInfoBarOp *	pTextInfoBarOp = NULL
static TCHAR *	FamilyName = _T("Text Tools")
static TCHAR *	ToolName = _T("Text Tool")
static TCHAR *	Purpose = _T("Text manipulation")
static TCHAR *	Author = _T("TextToolTeam")
static BOOL	UseDeadKeys = TRUE
Private Member Functions
	CC_DECLARE_MEMDUMP (TextTool)

---

Detailed Description

A template tool class.

Author:

Mark_Neves (Xara Group Ltd) <camelotdev@xara.com>

Date:

3/10/94

Definition at line 189 of file texttool.h.

---

Constructor & Destructor Documentation

TextTool::TextTool (   )

Default Constructor. Other initialisation is done in TextTool::Init which is called by the Tool Manager. Author: Mark_Goodall (Xara Group Ltd) <camelotdev@xara.com> Date: 3/10/94 See also: TextTool::Init Definition at line 259 of file texttool.cpp. { pcCurrentCursor = NULL; IsBlankCursorUp = FALSE; UpdateAfterTyping = FALSE; PreviousDeadKey = NULL; GraveVirtKey = NULL; AcuteVirtKey = NULL; HatVirtKey = NULL; TildeVirtKey = NULL; ColonVirtKey = NULL; AtVirtKey = NULL; CommaVirtKey = NULL; SlashVirtKey = NULL; pLastFocusStory = NULL; }

TextTool::~TextTool (   )

Destructor (Virtual). Does nothing. Author: Mark_Goodall (Xara Group Ltd) <camelotdev@xara.com> Date: 3/10/94 Definition at line 287 of file texttool.cpp. { pTextInfoBarOp->pTextTool = NULL; TextInfoBarOp::DeInit(); RemoveDeadKeys(); }

---

Member Function Documentation

BOOL TextTool::ApplyBold (   )  [protected]

Applies or removes the bold attribute from the current selection or caret. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 20/04/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE/FALSE for success/failure Definition at line 1709 of file texttool.cpp. { AttrTxtBold* ApplyBoldAttrib = new AttrTxtBold(); BOOL Success = ApplyBoldAttrib != NULL; if (Success) { // See wether bold is currently on or off across the selection AttrTxtBold* CurrentBoldAttrib = NULL; SelRange::CommonAttribResult AttrRes = GetApplication()->FindSelection()-> FindCommonAttribute(CC_RUNTIME_CLASS(AttrTxtBold), (NodeAttribute **)&CurrentBoldAttrib); if (AttrRes == SelRange::ATTR_COMMON) ApplyBoldAttrib->Value.BoldOn = !(CurrentBoldAttrib->Value.BoldOn); else ApplyBoldAttrib->Value.BoldOn = TRUE; // Apply the new bold attribute to the selection AttributeManager::AttributeSelected(ApplyBoldAttrib, NULL); } return Success; }

BOOL TextTool::ApplyItalic (   )  [protected]

Applies or removes the italic attribute from the current selection or caret. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 20/04/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE/FALSE for success/failure Definition at line 1745 of file texttool.cpp. { AttrTxtItalic* ApplyItalicAttrib = new AttrTxtItalic(); BOOL Success = ApplyItalicAttrib != NULL; if (Success) { // See wether italic is currently on or off across the selection AttrTxtItalic* CurrentItalicAttrib = NULL; SelRange::CommonAttribResult AttrRes = GetApplication()->FindSelection()-> FindCommonAttribute(CC_RUNTIME_CLASS(AttrTxtItalic), (NodeAttribute **)&CurrentItalicAttrib); if (AttrRes == SelRange::ATTR_COMMON) ApplyItalicAttrib->Value.ItalicOn = !(CurrentItalicAttrib->Value.ItalicOn); else ApplyItalicAttrib->Value.ItalicOn = TRUE; // Apply the new italic attribute to the selection AttributeManager::AttributeSelected(ApplyItalicAttrib, NULL); } return Success; }

virtual BOOL TextTool::AreToolBlobsRenderedOnSelection (   )  [inline, virtual]

Reimplemented from Tool_v1. Definition at line 233 of file texttool.h. {return TRUE;}

TextTool::CC_DECLARE_MEMDUMP (  TextTool   )  [private]

BOOL TextTool::CommonApplyKern (  MILLIPOINT  ChangeAmmount  )  [protected]

Applys/increases/descreases the horizontal kern at the caret. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 21/04/95 Parameters: ChangeAmmount  - ammount to increase/decrease the kern at the caret by [INPUTS] -  [OUTPUTS] Returns: TRUE/FALSE for success/failure Definition at line 1884 of file texttool.cpp. { MILLIPOINT NewKernVal = ChangeAmmount; // Get the current kern ammount - check the node to the left of the caret TextStory* pStory = TextStory::GetFocusStory(); CaretNode* pCaret = NULL; if (pStory != NULL) pCaret = pStory->GetCaret(); if (pCaret != NULL) { VisibleTextNode* LastNode = pCaret->FindPrevAbstractTextCharInStory(); if ((LastNode != NULL) && IS_A(LastNode, KernCode)) NewKernVal += (((KernCode*)LastNode)->GetValue()).x; } // Invoke an operation to apply the kern OpDescriptor* OpDesc = OpDescriptor::FindOpDescriptor(CC_RUNTIME_CLASS(OpTextKern)); if (OpDesc != NULL) { OpParam param(NewKernVal,0); OpDesc->Invoke(&param); } return TRUE; }

BOOL TextTool::CommonApplyTracking (  MILLIPOINT  ChangeAmmount  )  [protected]

Applys/increases/descreases the tracking across the selected characters. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 21/04/95 Parameters: ChangeAmmount  - ammount to increase/decrease the tracking by [INPUTS] -  [OUTPUTS] Returns: TRUE/FALSE for success/failure Definition at line 1847 of file texttool.cpp. { // Create a new attribute to apply (will replace any existing) AttrTxtTracking* ApplyTrackingAttrib = new AttrTxtTracking(); BOOL Success = (ApplyTrackingAttrib != NULL); if (Success) { // Get the current tracking ammount across the selection AttrTxtTracking* CurrentTrackingAttrib = NULL; SelRange::CommonAttribResult AttrRes = GetApplication()->FindSelection()-> FindCommonAttribute(CC_RUNTIME_CLASS(AttrTxtTracking), (NodeAttribute **)&CurrentTrackingAttrib); if (AttrRes == SelRange::ATTR_COMMON) ApplyTrackingAttrib->Value.Tracking = CurrentTrackingAttrib->Value.Tracking + ChangeAmmount; else ApplyTrackingAttrib->Value.Tracking = ChangeAmmount; // Apply the increased attribute to the selection AttributeManager::AttributeSelected(ApplyTrackingAttrib, NULL); } return Success; }

BOOL TextTool::CreateCursors (   )  [protected]

Creates all the Text tool cursors. Author: Mark_Goodall (Xara Group Ltd) <camelotdev@xara.com> Date: 3/10/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if all the Text tool cursors have been successfully created See also: - Definition at line 460 of file texttool.cpp. { // This tool has just been selected. Create the cursors. pcNormalTextCursor = new Cursor(this, _R(IDC_TEXTTOOLBLOBCURSOR)); pcBlobTextCursor = new Cursor(this, _R(IDC_TEXTTOOLCURSOR)); pcIndentCursor = new Cursor(this, _R(IDC_TEXTTOOLINDENTCURSOR)); pcBlankCursor = new Cursor(this, _R(IDC_TEXTTOOLBLANKCURSOR)); if ( pcNormalTextCursor==NULL || !pcNormalTextCursor->IsValid() || pcBlobTextCursor==NULL || !pcBlobTextCursor->IsValid() || pcIndentCursor==NULL || !pcIndentCursor->IsValid() || pcBlankCursor==NULL || !pcBlankCursor->IsValid() ) { DestroyCursors(); return FALSE; } else return TRUE; }

BOOL TextTool::DecreaseTrackKern (   )  [protected]

If there is a text selection then the tracking applied to it is decreased by 10/1000's of an em If there is no selection then a kern down of 50/1000 is inserted. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 20/04/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE/FALSE for success/failure Definition at line 1816 of file texttool.cpp. { // Get pointers to focus story and its caret TextStory* pStory = TextStory::GetFocusStory(); ERROR3IF(pStory == NULL, "DecreaseTrackKern called without a focus story!"); BOOL Success = TRUE; if (pStory != NULL) { if (pStory->GetSelectionEnd() == NULL) Success = CommonApplyKern(-50); else Success = CommonApplyTracking(-10); } return Success; }

BOOL TextTool::DelayingUpdate (   )  [static]

Let's the caller know if the text-tool has finished mucking about with the document's modified flag. Author: Justin_Flude (Xara Group Ltd) <camelotdev@xara.com> Date: 19/9/96 Returns: TRUE if the text tool is saving up any updates to do when it is idle, FALSE if it isn't or if the text tool is not the current tool. See also: CCamSrvrItem::QueryTypeAhead Definition at line 1950 of file texttool.cpp. { // Is the text tool the current tool? Tool* pTool = Tool::GetCurrent(); if (!pTool || pTool->GetID() != TOOLID_TEXT) return FALSE; // Is it saving up some updates? return ((TextTool*) pTool)->UpdateAfterTyping; }

void TextTool::Describe (  void *  InfoPtr  )  [virtual]

Allows the tool manager to extract information about the tool. Author: Mark_Goodall (Xara Group Ltd) <camelotdev@xara.com> Date: 3/10/94 Parameters: InfoPtr  - A pointer to a tool info block. It is passed cast to void* as [INPUTS] the version of the tool is unknown at this point. Later versions of the Tool class may have more items in this block, that this tool will not use InfoPtr  - The structure pointed to by InfoPtr will have had all the info [OUTPUTS] that this version of the Tool knows about Reimplemented from Tool_v1. Definition at line 392 of file texttool.cpp. { // Cast structure into the latest one we understand. ToolInfo_v1 *Info = (ToolInfo_v1 *) InfoPtr; Info->InfoVersion = 1; Info->InterfaceVersion = GetToolInterfaceVersion(); // You should always have this line. // These are all arbitrary at present. Info->Version = 1; Info->ID = GetID(); Info->TextID = _R(IDS_TEXT_TOOL); Info->Family = FamilyName; Info->Name = ToolName; Info->Purpose = Purpose; Info->Author = Author; Info->BubbleID = _R(IDBBL_TEXT_TOOLBOX); // Text tool is associated with the BaseTextClass attribute group Info->CurrentAttributeGroup = CC_RUNTIME_CLASS(BaseTextClass); }

void TextTool::DestroyCursors (   )  [protected]

Destroys all the Text tool cursors. Author: Mark_Goodall (Xara Group Ltd) <camelotdev@xara.com> Date: 3/10/94 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - See also: - Definition at line 496 of file texttool.cpp. { if (pcNormalTextCursor != NULL) delete pcNormalTextCursor; if (pcBlobTextCursor != NULL) delete pcBlobTextCursor; if (pcIndentCursor != NULL) delete pcIndentCursor; if (pcBlankCursor != NULL) delete pcBlankCursor; }

void TextTool::DisplayStatusBarHelp (  DocCoord  DocPos, Spread *  pSpread, ClickModifiers  ClickMods )  [protected]

Displays status help string for the given position in the status bar. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 12/12/94 Parameters: DocPos  - the document coordinate of the point to display help on [INPUTS] pSpread - pointer to the spread containing DocPos ClickMods - the current click modifiers -  [OUTPUTS] Returns: - See also: TextTool::GetCurrentStatusText Definition at line 1600 of file texttool.cpp. { String_256 StatusMsg(""); // Get a string from the underlying help function and display it. GetCurrentStatusText(&StatusMsg, pSpread, DocPos, ClickMods); GetApplication()->UpdateStatusBarText(&StatusMsg); }

void TextTool::GetCurrentStatusText (  String_256 *  ptext, Spread *  pSpread, DocCoord  DocPos, ClickModifiers  ClickMods )  [protected]

Selects a suitable string for the status line based on the current location (as input via the parameters). Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 12/12/94 Parameters: pSpread  points to a spread [INPUTS] DocPos points to a point in a document ClickMods are the current click modifiers Updates  the string in ptext [OUTPUTS] Returns: - See also: TextTool::GetStatusLineText, TextTool::DisplayStatusBarHelp Definition at line 1654 of file texttool.cpp. { // If nothing is detected, we are over the document INT32 IDToUse = _R(IDS_TEXTTOOL_OVERDOCUMENT); // Is the caret in the focus story selected (ie, can the user type?) if (TextStory::GetFocusStory()!=NULL && TextStory::GetFocusStory()->GetCaret()!=NULL && TextStory::GetFocusStory()->GetCaret()->IsSelected()) { IDToUse = _R(IDS_TEXTTOOL_OVERDOCUMENTC); } // Are we over a story or a path for a new story? TextStory* pTextStoryToSelect = NULL; if (IsPointNearUnselectedTextStory(pSpread, DocPos, &pTextStoryToSelect, NULL, TRUE)) { if (pTextStoryToSelect != NULL) IDToUse = _R(IDS_TEXTTOOL_OVERTEXTSTORY); } else { NodePath* pPath = NULL; if (IsPointNearNonStoryPath(pSpread, DocPos, &pPath, TRUE)) IDToUse = _R(IDS_TEXTTOOL_OVERNODEPATH); } // See if we are near any story path indent blobs BOOL LeftBlob = TRUE; TextStory* pFoundStory = NULL; if (!m_BlobPosList.FindBlobStory(pSpread, DocPos, &LeftBlob, &pFoundStory)) InformError(); else if (pFoundStory != NULL) { if (pFoundStory->GetTextPath() != NULL) IDToUse = _R(IDS_TEXTTOOL_DRAGPATHINDENT); else IDToUse = _R(IDS_TEXTTOOL_DRAGSTORYWIDTH); } ptext->Load(IDToUse); }

UINT32 TextTool::GetID (  void   )  [inline, virtual]

Reimplemented from Tool_v1. Definition at line 200 of file texttool.h. { return TOOLID_TEXT; };

void TextTool::GetRulerOrigin (  Spread *  pSpread, UserCoord *  pOrigin )  [virtual]

Gives the current tool the chance to change the coordinates displayed on the ruler. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 30/Jun/2006 Parameters: pSpread  - the spread for which the ruler is displayed [INPUTS] pOffsets  - the desired origin shift in user space (is initialised to 0,0) [OUTPUTS] Reimplemented from Tool_v1. Definition at line 974 of file texttool.cpp. { if (TextInfoBarOp::IsRulerOriginClaimed()) { pOrigin->x = TextInfoBarOp::GetRulerOrigin(); } }

BOOL TextTool::GetRulerStatusLineText (  String_256 *  pText, UserCoord  PointerPos, Spread *  pSpread, RulerBase *  pRuler )  [virtual]

Allows the tool to set the status line text for the ruler. Author: Martin Wuerthner <xara@mw-software.com> Date: 25/07/06 Parameters: PointerPos  - user coordinates of click on ruler (relative to origin set by tool) [INPUTS] pSpread - pointer to spread upon which click occurred pRuler - pointer to ruler which generated click Status  line text written to pText (if returning TRUE) [OUTPUTS] Returns: TRUE if the text has been set Reimplemented from Tool_v1. Definition at line 1038 of file texttool.cpp. { if (!TextInfoBarOp::IsRulerOriginClaimed()) return FALSE; return TextInfoBarOp::GetRulerStatusLineText(pText, PointerPos, pSpread, pRuler); }

BOOL TextTool::GetStatusLineText (  String_256 *  ptext, Spread *  pSpread, DocCoord  DocPos, ClickModifiers  ClickMods )  [virtual]

Returns the current status line help string. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 12/12/94 Parameters: ptest  - pointer to a string [INPUTS] pSpread points to a spread DocPos points to a point in a document ClickMods are the current click modifiers Updates  the string in ptext [OUTPUTS] Returns: TRUE if the string was updates (FALSE if not updated) See also: TextTool::GetCurrentStatusText, Tool_v1::GetStatusLineText Reimplemented from Tool_v1. Definition at line 1628 of file texttool.cpp. { // We can call the underlying help function to get a string and return the result. GetCurrentStatusText(ptext, pSpread, DocPos, ClickMods); return TRUE; }

static TextInfoBarOp* TextTool::GetTextInfoBarOp (   )  [inline, static]

Definition at line 226 of file texttool.h. { return pTextInfoBarOp; }

BOOL TextTool::HandleDeadKeys (  KeyPress *  pKeyPress, WCHAR *  pNewUnicode )  [protected]

Flags 'dead-keys'. Attempts to apply an accent onto the next character. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 10/10/95 Parameters: pKeyPress  - points to the keypress object [INPUTS] pNewUnicode  contains the unicode value of the keypress, possibly changed to [OUTPUTS] an accented version of the pressed key. Returns: TRUE if keypress used, FALSE if not Definition at line 2098 of file texttool.cpp. { BOOL UsedKey = FALSE; *pNewUnicode = pKeyPress->GetUnicode(); // WCHAR OldUnicode = *pNewUnicode; if (!UseDeadKeys) return FALSE; // Is this a dead key? if ( TestForDeadKey(pKeyPress, GraveVirtKey) || TestForDeadKey(pKeyPress, AcuteVirtKey) || TestForDeadKey(pKeyPress, HatVirtKey) || TestForDeadKey(pKeyPress, TildeVirtKey) || TestForDeadKey(pKeyPress, ColonVirtKey) || TestForDeadKey(pKeyPress, AtVirtKey) || TestForDeadKey(pKeyPress, SlashVirtKey) || TestForDeadKey(pKeyPress, CommaVirtKey) ) { UsedKey = TRUE; } // This isn't a dead key, was the previous? if (!UsedKey && (PreviousDeadKey != NULL) && IsUsableUnicode(pKeyPress->GetUnicode()) ) { // Get a pointer to the appropiate accent map UINT32* pMapArrays = NULL; if (PreviousDeadKey == GraveVirtKey) pMapArrays = GraveArray; else if (PreviousDeadKey == AcuteVirtKey) pMapArrays = AcuteArray; else if (PreviousDeadKey == HatVirtKey) pMapArrays = HatArray; else if (PreviousDeadKey == TildeVirtKey) pMapArrays = TildeArray; else if (PreviousDeadKey == ColonVirtKey) pMapArrays = ColonArray; else if (PreviousDeadKey == AtVirtKey) pMapArrays = AtArray; else if (PreviousDeadKey == SlashVirtKey) pMapArrays = SlashArray; else if (PreviousDeadKey == CommaVirtKey) pMapArrays = CommaArray; else { ERROR3("Unknown dead key"); pMapArrays = NULL; } // See if the pressed key maps onto an accented version if (pMapArrays != NULL) { BOOL Found = FALSE; while (!Found && (*pMapArrays != 0)) { if (*pMapArrays == (UINT32)(*pNewUnicode)) { *pNewUnicode = *(pMapArrays+1); Found = TRUE; } pMapArrays += 2; } } PreviousDeadKey = 0; UsedKey = FALSE; } return UsedKey; }

BOOL TextTool::HandleDoubleClick (  Spread *  pSpread, DocCoord  ClickPos, ClickModifiers  ClickMods )  [protected]

To handle double click events in the text tool. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 15/02/95 Parameters: pSpread  - The spread in which the click occurred [INPUTS] ClickPos - The DocCoord of the point where the mouse was clicked ClickMods - The state of the various modifiers at the time of the click Returns: FALSE if an error occurs during processing See also: TextTool::OnClick Definition at line 666 of file texttool.cpp. { BOOL Success = TRUE; // Select the word at the caret if ((TextStory::GetFocusStory() != NULL) && !ClickMods.Constrain && !ClickMods.Adjust) { OpTextCaret* pOp = new OpTextCaret(); if (pOp != NULL) pOp->DoSelectWordAtCaret(); else Success = FALSE; } return Success; }

BOOL TextTool::HandleDragClick (  Spread *  pSpread, DocCoord  ClickPos, ClickModifiers  ClickMods )  [protected]

To handle drag events in the text tool. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 15/02/95 Parameters: pSpread  - The spread in which the click occurred [INPUTS] ClickPos - The DocCoord of the point where the mouse was clicked ClickMods - The state of the various modifiers at the time of the click Returns: FALSE if an error occurs during processing See also: TextTool::OnClick Definition at line 746 of file texttool.cpp. { return TRUE; }

BOOL TextTool::HandleQuadClick (  Spread *  pSpread, DocCoord  ClickPos, ClickModifiers  ClickMods )  [protected]

To handle quad click events in the text tool. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 22/12/95 Parameters: pSpread  - The spread in which the click occurred [INPUTS] ClickPos - The DocCoord of the point where the mouse was clicked ClickMods - The state of the various modifiers at the time of the click Returns: FALSE if an error occurs during processing See also: TextTool::OnClick Definition at line 724 of file texttool.cpp. { return TRUE; }

BOOL TextTool::HandleSingleClick (  Spread *  pSpread, DocCoord  ClickPos, ClickModifiers  ClickMods )  [protected]

To handle single click events in the text tool. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 15/02/95 Parameters: pSpread  - The spread in which the click occurred [INPUTS] ClickPos - The DocCoord of the point where the mouse was clicked ClickMods - The state of the various modifiers at the time of the click Returns: FALSE if an error occurs during processing See also: TextTool::OnClick Definition at line 584 of file texttool.cpp. { Node* pHitObject = NULL; TextStory* pTextStoryToSelect = NULL; // Is the click over an indent blob? BOOL BlobIsLeft = TRUE; TextStory* pFoundStory = NULL; if (!m_BlobPosList.FindBlobStory(pSpread, ClickPos, &BlobIsLeft, &pFoundStory)) return FALSE; if (pFoundStory != NULL) { if (!m_BlobPosList.RenderAndRemove(pFoundStory)) return FALSE; // Invoke a operation to drag the indent position OpDragStoryIndent* pOp = NULL; if (BlobIsLeft) { if (pFoundStory->GetTextPath() != NULL) pOp = new OpDragStoryPathLeftIndent; else pOp = new OpDragStoryNonPathLeftIndent; } else { if (pFoundStory->GetTextPath() != NULL) pOp = new OpDragStoryPathRightIndent; else pOp = new OpDragStoryNonPathRightIndent; } if (pOp==NULL) return FALSE; else return pOp->DoDrag(ClickPos, pSpread, ClickMods, pFoundStory); } else if ( IsPointNearUnselectedTextStory(pSpread, ClickPos, &pTextStoryToSelect, &pHitObject, FALSE) ) { // Position the caret with a story, and drag selection OpTextSelection* pOp = new OpTextSelection; if (pOp == NULL) return FALSE; else return pOp->DoDrag(ClickPos, pSpread, ClickMods, pHitObject); } else { // Create a new text story OpCreateTextObject* pOpCreateTextObject = new OpCreateTextObject; if (pOpCreateTextObject == NULL) return FALSE; else { NodePath* pPath = NULL; IsPointNearNonStoryPath(pSpread, ClickPos, &pPath, FALSE); if (pPath != NULL) pOpCreateTextObject->DoImmediate(pSpread, ClickPos, pPath, ClickMods); else pOpCreateTextObject->DoDrag(pSpread, ClickPos, ClickMods); } } return TRUE; }

BOOL TextTool::HandleSpecialNonStoryKeys (  KeyPress *  pKeyPress  )  [protected]

To deal with keys presses that work without a focus story. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 24/08/95 Parameters: pKeyPress  - pointer to a keypress object [INPUTS] Returns: TRUE if it used the keypress, FALSE otherwise See also: TextTool::HandleSpecialStoryKeys, TextTool::HandleSpecialStoryAndNonStoryKeys Definition at line 1297 of file texttool.cpp. { ERROR3IF(pKeyPress == NULL, "KeyPress pointer was NULL"); if (pKeyPress == NULL) return FALSE; BOOL UsedTheKeypress = FALSE; switch (pKeyPress->GetVirtKey()) { case CAMKEY(UP): case CAMKEY(DOWN): case CAMKEY(LEFT): case CAMKEY(RIGHT): UsedTheKeypress = TRUE; // Just eat the keypress break; } TRACEUSER("wuerthne", _T("HandleSpecialNonStoryKeys returns %d"), UsedTheKeypress); return UsedTheKeypress; }

BOOL TextTool::HandleSpecialStoryAndNonStoryKeys (  KeyPress *  pKeyPress  )  [protected]

To handle keypress events that wotk with and without a text focus story. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 1/06/95 Parameters: pKeyPress  - pointer to a keypress object [INPUTS] Returns: TRUE if it handled the keypress, FALSE otherwise See also: TextTool::HandleSpecialStoryKeys, TextTool::HandleSpecialNonStoryKeys Definition at line 1248 of file texttool.cpp. { ERROR3IF(pKeyPress == NULL, "KeyPress pointer was NULL"); if (pKeyPress == NULL) return FALSE; if (pKeyPress->IsChar()) return FALSE; // only use non-char events for hotkeys BOOL UsedTheKeypress = FALSE; BOOL Errored = FALSE; switch (pKeyPress->GetVirtKey()) { case CAMKEY(B): // Apply/Remove bold to/from the selection if (pKeyPress->IsConstrain() && !pKeyPress->IsAdjust() ) { UsedTheKeypress = TRUE; Errored = !ApplyBold(); } break; case CAMKEY(I): // Apply/Remove italic to/from the selection if (pKeyPress->IsConstrain() && !pKeyPress->IsAdjust() ) { UsedTheKeypress = TRUE; Errored = !ApplyItalic(); } break; } if (Errored) InformError(); TRACEUSER("wuerthne", _T("HandleSpecialStoryAndNonStoryKeys returns %d"), UsedTheKeypress); return UsedTheKeypress; }

BOOL TextTool::HandleSpecialStoryKeys (  KeyPress *  pKeyPress, TextStory *  pStory, CaretNode *  pCaret )  [protected]

To handle special keypress events that apply at a story and/or caret. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 1/06/95 Parameters: pKeyPress  - pointer to a keypress object [INPUTS] pStory - points to the story with the caret pCaret - points to the caret Returns: TRUE if it handled the keypress, FALSE otherwise See also: TextTool::HandleSpecialNonStoryKeys Definition at line 1333 of file texttool.cpp. { TRACEUSER("wuerthne", _T("HandleSpecialStoryKeys %d"), pKeyPress->GetVirtKey()); ERROR3IF(pKeyPress == NULL, "KeyPress pointer was NULL"); ERROR3IF(pStory == NULL, "Story pointer was NULL"); ERROR3IF(pCaret == NULL, "Caret pointer was NULL"); if ((pKeyPress == NULL) || (pStory == NULL) || (pCaret == NULL)) return FALSE; BOOL IsNonCharEvent = !pKeyPress->IsChar(); // only use non-char events for hotkeys, but eat char events matching our hotkeys BOOL UsedTheKeypress = FALSE; BOOL Errored = FALSE; switch (pKeyPress->GetVirtKey()) { case CAMKEY(HOME): // Move caret to start of line if (IsNonCharEvent) { OpTextCaret* pOp = new OpTextCaret(); if (pOp != NULL) pOp->DoMoveCaretHome(pKeyPress->IsAdjust(), pKeyPress->IsConstrain()); else Errored = TRUE; } UsedTheKeypress = TRUE; break; case CAMKEY(END): // Move caret to end of line if (IsNonCharEvent) { OpTextCaret* pOp = new OpTextCaret(); if (pOp != NULL) pOp->DoMoveCaretEnd(pKeyPress->IsAdjust(), pKeyPress->IsConstrain()); else Errored = TRUE; } UsedTheKeypress = TRUE; break; case CAMKEY(BACK): // delete character before caret, or selected chars if either exists if (IsNonCharEvent && (pStory->GetSelectionEnd() || pCaret->FindPrevVTNInStory() != NULL)) { OpTextFormat* pOp = new OpTextFormat(); if (pOp != NULL) pOp->DoDeleteChar(OpTextFormat::BACKSPACE); else Errored = TRUE; } UsedTheKeypress = TRUE; break; case CAMKEY(DELETE): // delete character before caret, or selected chars if either exists if (IsNonCharEvent && (pStory->GetSelectionEnd() || pCaret->FindNextVTNInStory() != pStory->FindLastVTN())) { OpTextFormat* pOp = new OpTextFormat(); if (pOp != NULL) pOp->DoDeleteChar(OpTextFormat::DEL); else Errored = TRUE; } UsedTheKeypress = TRUE; break; case CAMKEY(LEFT): // Move/Select caret left one word/character if (IsNonCharEvent) { TRACEUSER("wuerthne", _T("caret left")); OpTextCaret* pOp = new OpTextCaret(); if (pOp != NULL) pOp->DoMoveCaretLeft(pKeyPress->IsAdjust(), pKeyPress->IsConstrain()); else Errored = TRUE; } UsedTheKeypress = TRUE; break; case CAMKEY(RIGHT): // Move/Select caret right one word/character if (IsNonCharEvent) { OpTextCaret* pOp = new OpTextCaret(); if (pOp != NULL) pOp->DoMoveCaretRight(pKeyPress->IsAdjust(), pKeyPress->IsConstrain()); else Errored = TRUE; } UsedTheKeypress = TRUE; break; case CAMKEY(UP): // Move/Select caret up a line if (IsNonCharEvent) { OpTextCaret* pOp = new OpTextCaret(); if (pOp != NULL) pOp->DoMoveCaretUp(pKeyPress->IsAdjust()); else Errored = TRUE; } UsedTheKeypress = TRUE; break; case CAMKEY(DOWN): // Move/Select caret down a line if (IsNonCharEvent) { OpTextCaret* pOp = new OpTextCaret(); if (pOp != NULL) pOp->DoMoveCaretDown(pKeyPress->IsAdjust()); else Errored = TRUE; } UsedTheKeypress = TRUE; break; case CAMKEY(C): // Swap case (was Control-W, now Control-Shift-C) if (pKeyPress->IsConstrain() && pKeyPress->IsAdjust() ) { if (IsNonCharEvent && TextStory::GetFocusStory()->GetCaret()->FindNextTextCharInStory() != NULL) { OpTextFormat* pOp = new OpTextFormat(); if (pOp != NULL) { pOp->DoSwapCase(); } else Errored = TRUE; } UsedTheKeypress = TRUE; } break; case CAMKEY(A): // Select all in the focus story, if there is one if (pKeyPress->IsConstrain() && !pKeyPress->IsAdjust()) { if (IsNonCharEvent) { OpTextSelection* pOp = new OpTextSelection(); if (pOp != NULL) Errored = !pOp->DoSelectAllText(TextStory::GetFocusStory()); else Errored = TRUE; } UsedTheKeypress = TRUE; } break; case CAMKEY(V): // Paste text from the clipboard into a selected text story if (pKeyPress->IsConstrain() && !pKeyPress->IsAdjust()) { if (IsNonCharEvent) { // is there a focus story? OpTextPaste* pOp = new OpTextPaste(); if (pOp != NULL) pOp->Do(NULL); } UsedTheKeypress = TRUE; } break; case CAMKEY(L): // Select all text on the line with the caret if (pKeyPress->IsConstrain() && !pKeyPress->IsAdjust()) { TextLine* pLine = (TextLine*)TextStory::GetFocusStory()->GetCaret()->FindParent(CC_RUNTIME_CLASS(TextLine)); if (pLine != NULL) { if (IsNonCharEvent) { OpTextSelection* pOp = new OpTextSelection(); if (pOp != NULL) Errored = !pOp->DoSelectLineText(); else Errored = TRUE; } UsedTheKeypress = TRUE; } } break; case CAMKEY(EQUALS): // Increase kerning/tracking if (pKeyPress->IsConstrain() && !pKeyPress->IsAdjust() ) { UsedTheKeypress = TRUE; Errored = IsNonCharEvent ? !IncreaseTrackKern() : FALSE; } break; case CAMKEY(MINUS): // Decrease kerning/tracking if (pKeyPress->IsConstrain() && !pKeyPress->IsAdjust() ) { UsedTheKeypress = TRUE; Errored = IsNonCharEvent ? !DecreaseTrackKern() : FALSE; } break; case CAMKEY(RETURN): // Create a new TextLine and move the caret to it. if (!pKeyPress->IsAlternative() && !pKeyPress->IsConstrain()) { if (IsNonCharEvent) { OpTextFormat* pOp = new OpTextFormat(); if (pOp != NULL) Errored = !pOp->DoReturn(OpTextFormat::INSERT); else Errored = TRUE; } UsedTheKeypress = TRUE; } break; case CAMKEY(TAB): if (!pKeyPress->IsAlternative() && !pKeyPress->IsConstrain()) { if (IsNonCharEvent) { /* Create a tab node */ OpTextFormat* pOp = new OpTextFormat(); if (pOp != NULL) Errored = !pOp->DoTab(); else Errored = TRUE; } UsedTheKeypress = TRUE; } break; case CAMKEY(ESCAPE): // Deselect the caret and select the text story if (!pKeyPress->IsAlternative() && !pKeyPress->IsConstrain()) { if (IsNonCharEvent) { pCaret->DeSelect(TRUE); pStory->Select(TRUE); GetApplication()->FindSelection()->Update(TRUE); } UsedTheKeypress = TRUE; // Remove the focus story if it was empty Errored = IsNonCharEvent ? !OpDeleteTextStory::RemoveEmptyFocusStory() : FALSE; } break; } if (Errored) InformError(); return UsedTheKeypress; }

BOOL TextTool::HandleTripleClick (  Spread *  pSpread, DocCoord  ClickPos, ClickModifiers  ClickMods )  [protected]

To handle triple click events in the text tool. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 15/02/95 Parameters: pSpread  - The spread in which the click occurred [INPUTS] ClickPos - The DocCoord of the point where the mouse was clicked ClickMods - The state of the various modifiers at the time of the click Returns: FALSE if an error occurs during processing See also: TextTool::OnClick Definition at line 695 of file texttool.cpp. { ERROR2IF(TextStory::GetFocusStory()==NULL, FALSE, "No focus story"); ERROR2IF(TextStory::GetFocusStory()->GetCaret()==NULL, FALSE, "No caret in focus story"); TextLine* pLine = (TextLine*)TextStory::GetFocusStory()->GetCaret()->FindParent(CC_RUNTIME_CLASS(TextLine)); ERROR2IF(pLine==NULL, FALSE, "Caret didn't have a parent TextLine"); OpTextSelection* pOp = new OpTextSelection(); if (pOp != NULL) return pOp->DoSelectLineText(); else return FALSE; }

BOOL TextTool::IncreaseTrackKern (   )  [protected]

If there is a text selection then the tracking applied to it is increased by 10/1000's of an em If there is no selection then a kern up of 50/1000 is inserted. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 20/04/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE/FALSE for success/failure Definition at line 1783 of file texttool.cpp. { // Get pointers to focus story and its caret TextStory* pStory = TextStory::GetFocusStory(); ERROR3IF(pStory == NULL, "IncreaseTrackKern called without a focus story!"); BOOL Success = TRUE; if (pStory != NULL) { if (pStory->GetSelectionEnd() == NULL) Success = CommonApplyKern(50); else Success = CommonApplyTracking(10); } return Success; }

BOOL TextTool::Init (  void   )  [virtual]

Used to check if the Tool was properly constructed. Author: Mark_Goodall (Xara Group Ltd) <camelotdev@xara.com> Date: 3/10/94 Returns: FALSE if it does not want to be created, TRUE otherwise See also: TextTool::TextTool Reimplemented from Tool_v1. Definition at line 309 of file texttool.cpp. { // Declare all your ops here and only succeed if all declarations succeed BOOL ok = TRUE; // Register CreateTextObjectOp ok = ok && OpCreateTextObject::Init(); ok = ok && OpTextSelection::Init(); ok = ok && OpDeleteTextStory::Init(); ok = ok && OpReverseStoryPath::Init(); ok = ok && OpApplyJustificationToStory::Init(); ok = ok && OpTextPaste::Init(); ok = ok && OpTogglePrintTextAsShapes::Init(); ok = ok && OpDragStoryNonPathLeftIndent::Init(); ok = ok && OpDragStoryNonPathRightIndent::Init(); ok = ok && OpDragStoryPathLeftIndent::Init(); ok = ok && OpDragStoryPathRightIndent::Init(); ok = ok && OpAffectFontChange::Init(); ok = ok && TextInfoBarOp::Init(); // static initialisation // This section reads in the infobar definition and creates an instance of // TextInfoBarOp. Also pTextInfoBarOp, the ptr to the tool's infobar, is set up // after the infobar is successfully read and created. if (ok) { #if 0 CCResTextFile file; // Resource File TextInfoBarOpCreate BarCreate; // Object that creates TextInfoBarOp objects ok = file.open(_R(IDM_TEXT_BAR), _R(IDT_INFO_BAR_RES)); // Open resource if (ok) ok = DialogBarOp::ReadBarsFromFile(file,BarCreate); // Read and create info bar if (ok) file.close(); // Close resource ENSURE(ok,"Unable to load Textbar.ini from resource\n"); if (ok) { // Info bar now exists. Now get a pointer to it String_32 str = String_32(_R(IDS_TEXTTOOL_INFOBARNAME)); DialogBarOp* pDialogBarOp = DialogBarOp::FindDialogBarOp(str); ok = (pDialogBarOp != NULL); if (ok) ok = pDialogBarOp->IsKindOf(CC_RUNTIME_CLASS(TextInfoBarOp)); if (ok) pTextInfoBarOp = (TextInfoBarOp*)pDialogBarOp; ENSURE(ok,"Error finding the Text tool info bar"); } #endif pTextInfoBarOp = new TextInfoBarOp(); ok = (pTextInfoBarOp != NULL); ENSURE(ok,"Error finding the Text tool info bar"); } // Read preference settings GetApplication()->DeclareSection(_T("TextTool"),1); GetApplication()->DeclarePref(_T("TextTool"),_T("UseDeadKeys"), &UseDeadKeys, 0, 1); // Read deadkey virtual key codes for the current driver if (ok) ok = RegisterDeadKeys(); return (ok); }

static BOOL TextTool::IsCurrentTool (   )  [inline, static]

Definition at line 228 of file texttool.h. { return CurrentTool; }

BOOL TextTool::IsPointNearNonStoryPath (  Spread *  pSpread, DocCoord  PointerPos, NodePath **  pHitPath, BOOL  AllowInterrupts )  [protected]

To see if a click at the current positon should create a story on a path. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 17/02/95 Parameters: pSpread  - The spread in which the point is in [INPUTS] PointerPos - The DocCoord of the point where the mouse has moved to AllowInterrupts - TRUE to stop the hit detection if the mouse moves pHitPath  will point to the NodePath the pointer is over, or NULL [OUTPUTS] Returns: TRUE if the pointer is over an NodePath, FALSE if not See also: TextTool::IsPointNearUnselectedTextStory Definition at line 893 of file texttool.cpp. { Node* pInterrupt; NodeRenderableInk* pObject = NULL; *pHitPath = NULL; if (AllowInterrupts) pObject = NodeRenderableInk::FindSimpleAtPoint(pSpread, PointerPos, NULL, &pInterrupt); else pObject = NodeRenderableInk::FindSimpleAtPoint(pSpread, PointerPos); // If its a NodePath that isn't already a story path if (pObject != NULL) { Node* pParent = pObject->FindParent(); ObjChangeParam ChangeData(OBJCHANGE_STARTING, ObjChangeFlags(TRUE), pObject, NULL); if (IS_A(pObject, NodePath) && pObject->IsSelected() && /* It must be a selected path */ (pParent != NULL) && !IS_A(pParent, TextStory) && /* It's not already in a story */ pObject->AllowOp(&ChangeData, FALSE) ) /* And the path is happy with being deleted */ { // Only allows clicks on the edge of the path (not the inside of filled shapes) NodePath* pPath = (NodePath*)pObject; INT32 PathSlot = 0; if (pPath->InkPath.PointCloseToLine(PointerPos, &PathSlot)) { *pHitPath = (NodePath*)pObject; return TRUE; } } } return FALSE; }

BOOL TextTool::IsPointNearUnselectedTextStory (  Spread *  pSpread, DocCoord  ClickPos, TextStory **  pTS, Node **  pHitObject, BOOL  AllowInterrupts )  [protected]

To see if a click at the current positon would select a TextStory. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 17/02/95 Parameters: PointerPos  - The DocCoord of the point where the mouse has moved to [INPUTS] pSpread - The spread in which the move occurred AllowInterrupts - TRUE to stop the hit detection if the mouse moves pTS  will point to the TextStory to select, or NULL [OUTPUTS] pHitObject will point the the object under the pointer, or NULL (Set to NULL if not interested about objects) Returns: TRUE if the pointer is over an text story. FALSE if not See also: TextTool::IsPointNearNonStoryPath Definition at line 776 of file texttool.cpp. { Node* pInterrupt; NodeRenderableInk* pObject = NULL; if (AllowInterrupts) pObject = NodeRenderableInk::FindSimpleAtPoint(pSpread, ClickPos, NULL, &pInterrupt); else pObject = NodeRenderableInk::FindSimpleAtPoint(pSpread, ClickPos); // The text tool has always ignored the compound node structure of the document // and allowed a text object to be selected inside any amount of nested nodes. // This is actually useful most of the time but we can't allow /anything/ to be // edited inside a locked effect because the changes will not be seen while // the locked effect's own bitmap is being rendered... NodeRenderableInk* pCompound = NodeRenderableInk::FindCompoundFromSimple(pObject); if (pCompound && pCompound->IsEffect() && ((NodeEffect*)pCompound)->IsLockedEffect()) return FALSE; *pTS = NULL; if (pHitObject!=NULL) *pHitObject = NULL; // BODGE - lets assume the char is a child of the line of the story if (pObject != NULL) { if (pObject->IsAVisibleTextNode()) { if (pHitObject!=NULL) *pHitObject = pObject; *pTS = (TextStory*)(pObject->FindParent()->FindParent()); return TRUE; } } // We didn't find anything via hittesting. Now scan the stories on this spread to see // if we are over blank areas of the story. Node* pNode = pSpread->FindFirstDepthFirst(); while (pNode != NULL) { if (pNode->IsABaseTextClass() && IS_A(pNode, TextStory)) { // Check to see if the point is within the bounds of the story TextStory* pStory = (TextStory*)pNode; DocRect StoryBounds = pStory->GetBoundingRect(TRUE); if (StoryBounds.ContainsCoord(ClickPos)) { // Story must not be on a path and must be on an unlocked layer, and not in a mould Layer* pLayer = (Layer*)pStory->FindParent(CC_RUNTIME_CLASS(Layer)); NodeMould* pMould = (NodeMould*)pStory->FindParent(CC_RUNTIME_CLASS(NodeMould)); if (pLayer!=NULL && pMould==NULL && pStory->GetTextPath()==NULL && !pLayer->IsLocked()) { // If the client wants the object then we have to do more work if (pHitObject!=NULL) { VisibleTextNode* pNearObject = NULL; BOOL ToLeft = FALSE; if (!pStory->GetCharacterAtPoint(TRUE, ClickPos, &pNearObject, &ToLeft)) { InformError(); return FALSE; } else { if (pNearObject != NULL) { *pHitObject = pNearObject; *pTS = pStory; return TRUE; } } } else { // Get untransformed story bounds and point DocRect UTStory = pStory->GetUTStoryBounds(); DocCoord UTPoint = ClickPos; Matrix StoryMat = pStory->GetStoryMatrix(); StoryMat=StoryMat.Inverse(); StoryMat.transform(&UTPoint); if (UTStory.ContainsCoord(UTPoint)) { *pTS=pStory; return TRUE; } } } } } pNode = pNode->FindNextDepthFirst(pSpread); } return FALSE; }

BOOL TextTool::IsUsableUnicode (  WCHAR  CodeValue  )  [protected]

Central place to filter out unicode greater than 255. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 10/10/95 Parameters: CodeValue  - a number representing a unicode character [INPUTS] -  [OUTPUTS] Returns: TRUE if the text tool accepts the character, FALSE if it dosen't Definition at line 2212 of file texttool.cpp. { return ( ((CodeValue>=32) && (CodeValue<=126)) || ((CodeValue>=128) && (CodeValue<=255)) ); }

void TextTool::LocaleChanged (   )

Called when the machines locale changes. Re-registers the dead keys as their virtual key code may have changed. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: - Definition at line 2230 of file texttool.cpp. { RemoveDeadKeys(); if (!RegisterDeadKeys()) InformError(); }

void TextTool::OnClick (  DocCoord  PointerPos, ClickType  Click, ClickModifiers  ClickMods, Spread *  pSpread )  [virtual]

To handle a Mouse Click event for the Text Tool. Author: Mark_Goodall (Xara Group Ltd) <camelotdev@xara.com> Date: 3/10/94 Parameters: PointerPos  - The DocCoord of the point where the mouse button was clicked [INPUTS] Click - Describes the type of click that was detected. ClickMods - Indicates which buttons caused the click and which modifers were pressed at the same time pSpread - The spread in which the click happened Returns: - See also: Tool::MouseClick; ClickType; ClickModifiers; TextTool::HandleSingleClick; TextTool::HandleDoubleClick; TextTool::HandleDragClick Reimplemented from Tool_v1. Definition at line 525 of file texttool.cpp. { if (ClickMods.Menu) return; // Don't do anything if the user clicked the Menu button if (IsBlankCursorUp) return; DocView* pDocView = DocView::GetSelected(); if (pDocView == NULL) { ERROR3("No selected doc view!"); } else { BOOL Success = TRUE; switch (Click) { case CLICKTYPE_SINGLE: if (pDocView->IsSingleClickReallyTriple()) Success = HandleTripleClick(pSpread, PointerPos, ClickMods); else Success = HandleSingleClick(pSpread, PointerPos, ClickMods); break; case CLICKTYPE_DOUBLE: if (pDocView->IsSingleClickReallyQuad()) Success = HandleQuadClick(pSpread, PointerPos, ClickMods); else Success = HandleDoubleClick(pSpread, PointerPos, ClickMods); break; case CLICKTYPE_DRAG: Success = HandleDragClick(pSpread, PointerPos, ClickMods); break; default: break; } if (!Success) InformError(); } }

BOOL TextTool::OnIdle (   )  [virtual]

Called on idle events. Used to update the infobar kern field after typing. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 25/08/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE/FALSE for more/no more idles needed Reimplemented from Tool_v1. Definition at line 1924 of file texttool.cpp. { if (UpdateAfterTyping) { if (!pTextInfoBarOp->UpdateFieldsAfterTyping()) InformError(); UpdateAfterTyping = FALSE; } return FALSE; }

BOOL TextTool::OnKeyPress (  KeyPress *  pKeyPress  )  [virtual]

To handle a keypress event for the Text Tool. > BOOL TextTool::OnKeyPress(KeyPress* pKeyPress) Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 13/02/95 Parameters: pKeyPress  - pointer to a keypress object [INPUTS] Returns: TRUE if it handled the keypress, FALSE otherwise See also: - Reimplemented from Tool_v1. Definition at line 1058 of file texttool.cpp. { TRACEUSER( "wuerthne", _T("TextTool::OnKeyPress, IsChar=%d IsRelease=%d VirtKey=%d\n"), pKeyPress->IsChar(), pKeyPress->IsRelease(), pKeyPress->GetVirtKey() ); // NB - each keypress casues three events: // (1) a key down event (IsChar() = FALSE, IsRelease() = FALSE) - which may not have the // correct Unicode char value because it has not been through the IM yet // (2) a char event (IsChar() = TRUE, IsRelease() = FALSE) - with the correct Unicode // char but with different values for GetVirtKey (e.g., Ctrl+char is reported as // a ctrl code) // (3) a release event (IsChar() = FALSE, IsRelease() = TRUE) // Our strategy is to use the key down event for shortcuts, to use the char events for // actual input and to ignore the release events. Care must be taken to swallow enough // events, e.g., though cursor movement is handled using the key down event, the // corresponding char event must be swallowed, too, otherwise the reported Unicode // character ends up being inserted in the text object. Finally, all non-char events // we do not swallow here will be processed by the hotkey system. // Filter out all key release events if (pKeyPress->IsRelease()) { TRACEUSER( "wuerthne", _T("Release\n") ); if (GetApplication()->FindSelection()->IsSelRangeGagged()) { GetApplication()->FindSelection()->SetGag(FALSE); GetApplication()->FindSelection()->Update(TRUE); } return FALSE; } // Deal with keypresses that don't dosen't depend on a focus story if (HandleSpecialStoryAndNonStoryKeys(pKeyPress)) { TRACEUSER( "wuerthne", _T("SpecialStoryAndNonStoryKeys\n") ); return TRUE; } // See if a caret has been selected without updating the focus story if (TextStory::GetFocusStory() == NULL) { SelRange* pSelection = GetApplication()->FindSelection(); Node* pNode = pSelection->FindFirst(); while (pNode != NULL) { if (IS_A(pNode,CaretNode)) { TextStory::SetFocusStory((TextStory*)pNode->FindParent(CC_RUNTIME_CLASS(TextStory))); break; } pNode = pSelection->FindNext(pNode); } } // We need a focus story do handle a keypress if (TextStory::GetFocusStory() == NULL) { TRACEUSER( "wuerthne", _T("GetFocusStory\n") ); return HandleSpecialNonStoryKeys(pKeyPress); } // Just to be safe let's see if the TextStory has a selected caret or selected region if ( !(TextStory::GetFocusStory()->GetCaret()->IsSelected()) && (TextStory::GetFocusStory()->GetSelectionEnd() == NULL) ) { TextStory::SetFocusStory(NULL); return HandleSpecialNonStoryKeys(pKeyPress); } // Now clear out all selections from other stories/objects SelRange* Selection = GetApplication()->FindSelection(); Node* pNode = Selection->FindFirst(); while (pNode != NULL) { if (pNode->IsAnObject()) { if (!pNode->IsABaseTextClass()) ((NodeRenderableInk*)pNode)->DeSelect(TRUE); else { if (!IS_A(pNode,TextStory)) { TextStory* pParentStory = (TextStory*)pNode->FindParent(CC_RUNTIME_CLASS(TextStory)); if (pParentStory != TextStory::GetFocusStory()) ((NodeRenderableInk*)pNode)->DeSelect(TRUE); } } } pNode = Selection->FindNext(pNode); } // First see if this is a special meaning key if (HandleSpecialStoryKeys(pKeyPress, TextStory::GetFocusStory(), TextStory::GetFocusStory()->GetCaret())) { TRACEUSER( "wuerthne", _T("HandleSpecialStoryKeys\n") ); return TRUE; } // finally, only proper text input remaining, so we only want Char events if( !pKeyPress->IsChar() ) { TRACEUSER("wuerthne", _T("not char")); // We own all keys that don't have constrain or alt pressed and aren't extended chars if( !pKeyPress->IsConstrain() && !pKeyPress->IsAlternative() && !pKeyPress->IsExtended() ) return true; return pKeyPress->GetUnicode() == _T(' '); // always claim the Space key (tool switch) } // temporary fix: do not allow function keys to insert funny Unicode characters // (e.g., F8 to select text tool inserts an s circumflex character if (pKeyPress->GetVirtKey() >= CAMKEY(F1) && pKeyPress->GetVirtKey() <= CAMKEY(F12)) return FALSE; if ( (!pKeyPress->IsAlternative()) || // Alt not down (pKeyPress->IsAlternative() && pKeyPress->IsExtended()) || // Right alt down (pKeyPress->IsAlternative() && pKeyPress->IsConstrain()) ) // Ctrl & left alt down { WCHAR UnicodeValue = pKeyPress->GetUnicode(); TRACEUSER("wuerthne", _T("UnicodeValue from keypress event = %04x %d"), UnicodeValue, pKeyPress->IsExtended() ); // Extanded keys shouldn't produce a character if (HandleDeadKeys(pKeyPress, &UnicodeValue) || pKeyPress->IsExtended()) return TRUE; else { if ( (UnicodeValue>=32) && ((UnicodeValue < CAMELOT_UNICODE_BASE) || (UnicodeValue > CAMELOT_UNICODE_LAST))) { #ifndef EXCLUDE_FROM_XARALX if ((UnicodeValue < 256) /*&& !TextManager::IsUnicodeCompleteOS()*/) UnicodeValue = UnicodeManager::MultiByteToUnicode(UnicodeValue); #endif // Display a blank cursor (thus hiding the pointer), but only if the pointer // is over the current document window if (!IsBlankCursorUp) { DocView* pDocView = DocView::GetSelected(); if (pDocView != NULL) { OilCoord DummyPos; CCamView* pCCamView = pDocView->GetConnectionToOilView(); if (pCCamView && pCCamView->GetCurrentMousePos(&DummyPos)) { // mouse is over document window pcCurrentCursor = pcBlankCursor; CursorStack::GSetTop(pcCurrentCursor, CurrentCursorID); IsBlankCursorUp = TRUE; } } } // Create EditTextOp OpTextFormat* pOp = new OpTextFormat(); if (pOp != NULL) { TRACEUSER("jlh92", _T("inserting Unicode char %04x"), UnicodeValue); pOp->DoInsertChar(UnicodeValue, OpTextFormat::INSERT); UpdateAfterTyping = TRUE; return TRUE; } } else TRACEUSER( "jlh92", _T("Rejected\n" ) ); } } TRACEUSER("wuerthne", _T("TextTool::OnKeyPress returns FALSE")); return FALSE; }

void TextTool::OnMouseMove (  DocCoord  PointerPos, Spread *  pSpread, ClickModifiers  ClickMods )  [virtual]

To handle a Mouse Move event for the Text Tool. Author: Mark_Goodall (Xara Group Ltd) <camelotdev@xara.com> Date: 3/10/94 Parameters: PointerPos  - The DocCoord of the point where the mouse has moved to [INPUTS] pSpread - The spread in which the move occurred ClickMods - The state of the various modifiers at the time of the mouse move Returns: TRUE if it handled the Click, FALSE otherwise See also: Tool::MouseClick; ClickType; ClickModifiers Reimplemented from Tool_v1. Definition at line 941 of file texttool.cpp. { // Display status bar text for the current position DisplayStatusBarHelp(PointerPos, pSpread, ClickMods); IsBlankCursorUp = FALSE; // Cursor changing over characters NodePath* pPath = NULL; TextStory* pTextStoryToSelect = NULL; Cursor* DisplayCur = pcNormalTextCursor; // Are we over text to put a caret in OR near a path to click to start a story on? if ( IsPointNearUnselectedTextStory(pSpread, PointerPos, &pTextStoryToSelect, NULL, TRUE) || IsPointNearNonStoryPath(pSpread, PointerPos, &pPath, TRUE) ) { DisplayCur = pcBlobTextCursor; } // See if we are near any story path indent blobs TextStory* pFoundStory = NULL; if (!m_BlobPosList.FindBlobStory(pSpread, PointerPos, NULL, &pFoundStory)) InformError(); else if (pFoundStory != NULL) DisplayCur = pcIndentCursor; // Display that cursor! if ( (DisplayCur != pcCurrentCursor) && (DisplayCur != NULL) ) { pcCurrentCursor = DisplayCur; CursorStack::GSetTop(pcCurrentCursor, CurrentCursorID); } }

BOOL TextTool::OnRulerClick (  UserCoord  PointerPos, ClickType  Click, ClickModifiers  Mods, Spread *  pSpread, RulerBase *  pRuler )  [virtual]

Called when the user has clicked on the ruler and we are the current tool. Author: Martin Wuerthner <xara@mw-software.com> Date: 07/07/06 Parameters: PointerPos  - user coordinates of click on ruler (relative to origin set by tool) [INPUTS] Click - Type of click enum Mods - Modifier flags struct pSpread - pointer to spread upon which click occurred pRuler - pointer to ruler which generated click Returns: TRUE to claim the click Reimplemented from Tool_v1. Definition at line 1015 of file texttool.cpp. { if (!TextInfoBarOp::IsRulerOriginClaimed()) return FALSE; return TextInfoBarOp::OnRulerClick(PointerPos, Click, Mods, pSpread, pRuler); }

BOOL TextTool::OnToolDeselect (   )  [protected]

Called to do processing required when text tool is deselected. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 3/1/96 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: FALSE if an error occured, TRUE if tool deselected ok Definition at line 2371 of file texttool.cpp. { BOOL ok = TRUE; // Remove the info bar from view by deleting the actual underlying window pTextInfoBarOp->Delete(); // Destroy the tool's cursors, if they exist, having stopped displaying them if (pcCurrentCursor != NULL) { CursorStack::GPop(CurrentCursorID); pcCurrentCursor = NULL; CurrentCursorID = 0; } DestroyCursors(); // If a caret is selected alone then select its parent text story instead GetApplication()->FindSelection()->SetGag(FALSE); TextStory* pTS = TextStory::GetFocusStory(); if (pTS != NULL) { // Move the selection up // If the caret is selected and there is no other selection CaretNode* pCaret = pTS->GetCaret(); VisibleTextNode* pSel = pTS->GetSelectionEnd(); if (pCaret->IsSelected() && pSel==NULL) { pCaret->DeSelect(TRUE); pTS->Select(TRUE); GetApplication()->FindSelection()->Update(TRUE); } ok = OpDeleteTextStory::RemoveEmptyFocusStory(); } // render off the tool blobs if (m_BlobPosList.GetBlobSpread()!=NULL) m_BlobPosList.RenderAndRemoveAll(); // ensure any tool object blobs are removed. BlobManager* BlobMgr = GetApplication()->GetBlobManager(); if (BlobMgr != NULL) { BlobStyle bsRemoves; bsRemoves.ToolObject = TRUE; BlobMgr->RemoveInterest(bsRemoves); } // Clear the focus, remembering what it was for possible later reselection pLastFocusStory = TextStory::GetFocusStory(); TextStory::SetFocusStory(NULL); // make sure the ruler is redrawn if we had claimed it TextInfoBarOp::ReleaseRuler(); CurrentTool = FALSE; return ok; }

BOOL TextTool::OnToolSelect (   )  [protected]

Called to do processing required when text tool is selected. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 3/1/96 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: FALSE if an error occured, TRUE if tool selected ok Definition at line 2249 of file texttool.cpp. { BOOL ok = TRUE; // Create the tools cursors ok = CreateCursors(); if (ok) { CurrentCursorID = CursorStack::GPush(pcNormalTextCursor, FALSE); pcCurrentCursor = pcNormalTextCursor; IsBlankCursorUp = FALSE; } else pcCurrentCursor = NULL; // This tool is now the current one CurrentTool = TRUE; UpdateAfterTyping = FALSE; PreviousDeadKey = 0; // Say which blobs should be displayed BlobManager* BlobMgr = GetApplication()->GetBlobManager(); if (BlobMgr != NULL) { // Decide which blobs we will display BlobStyle MyBlobs; MyBlobs.Object = TRUE; // Tell the blob manager BlobMgr->ToolInterest(MyBlobs); } // Render on the tool blobs if (ok) ok = m_BlobPosList.BuildFromSelection(); if (ok && m_BlobPosList.GetBlobSpread()!=NULL) BlobMgr->RenderToolBlobsOn(this, m_BlobPosList.GetBlobSpread(), NULL); // Create and display the tool's info bar if (ok) ok = pTextInfoBarOp->Create(); pTextInfoBarOp->pTextTool = this; // Alias the paste operation OpDescriptor* pOpDesc = OpDescriptor::FindOpDescriptor(OPTOKEN_PASTE); pOpDesc->AliasOperation(CC_RUNTIME_CLASS(OpTextPaste),NULL,0); // Ensure the dead key mappings are correct LocaleChanged(); // Give the input focus to the story with a subselection, as long as it is the only sub-selected story SelRange* pSelRange = GetApplication()->FindSelection(); Node* pSel = pSelRange->FindFirst(); // BOOL SelectedVTN = FALSE; TextStory* pSelStory = NULL; while (pSel != NULL) { // if it's a text object get the story it is in TextStory* pParentStory = NULL; if (pSel->IsABaseTextClass()) { if (IS_A(pSel,TextStory)) pParentStory = (TextStory*)pSel; else pParentStory = (TextStory*)pSel->FindParent(CC_RUNTIME_CLASS(TextStory)); } if (pSelStory==NULL) { // Set the selected story pointer if (pSel->IsAVisibleTextNode()) pSelStory = pParentStory; } else { // See if we have found two selected stories if (pSelStory!=pParentStory) { pSelStory = NULL; break; } } pSel = pSelRange->FindNext(pSel); } if (pSelStory != NULL) TextStory::SetFocusStory(pSelStory); // See if there is just one selected TextStory and give it the focus // if it had the focus when we left the tool last time. Also selected the caret within it if ((pLastFocusStory!= NULL) && (pSelStory==NULL) && (GetApplication()->FindSelection()->Count()==1)) { Node* pSelected = GetApplication()->FindSelection()->FindFirst(); if (IS_A(pSelected,TextStory) && (pSelected == pLastFocusStory)) { TextStory* pTS = (TextStory*)pSelected; CaretNode* pCaret = pTS->GetCaret(); if (pCaret != NULL) { pTS->DeSelect(TRUE); pCaret->Select(TRUE); TextStory::SetFocusStory(pTS); GetApplication()->FindSelection()->Update(TRUE); } } } return ok; }

BOOL TextTool::RegisterAdditionalVirtKey (  KeyPress **  pKey, TCHAR  ch )  [protected]

Registers a requirement for a virtual key message with the KeyPress system. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 11/10/95 Parameters: pKey  - pointer to a KeyPress object [INPUTS] ch - Unicode value of the required Virtual Key pKey  is the KeyPress object representing the virtual key [OUTPUTS] Definition at line 2074 of file texttool.cpp. { BOOL ok = TRUE; *pKey = KeyPress::ConstructVK(ch); ok = (*pKey != NULL); if (ok) ok = KeyPress::AddVirtualKeyCode((*pKey)->GetVirtKey(), (*pKey)->GetUnicode()); return ok; }

BOOL TextTool::RegisterDeadKeys (   )  [protected]

Registers all the dead keys virtual codes with the keypress system. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE/FALSE for success/failure See also: TextTool::RemoveDeadKeys Definition at line 1973 of file texttool.cpp. { BOOL ok = TRUE; if (UseDeadKeys) { if (ok) ok = RegisterAdditionalVirtKey(&GraveVirtKey, (TCHAR)('`')); if (ok) ok = RegisterAdditionalVirtKey(&AcuteVirtKey, (TCHAR)0x27); // Single Quote if (ok) ok = RegisterAdditionalVirtKey(&TildeVirtKey, (TCHAR)('~')); if (ok) ok = RegisterAdditionalVirtKey(&HatVirtKey, (TCHAR)('^')); if (ok) ok = RegisterAdditionalVirtKey(&ColonVirtKey, (TCHAR)(':')); if (ok) ok = RegisterAdditionalVirtKey(&AtVirtKey, (TCHAR)('@')); if (ok) ok = RegisterAdditionalVirtKey(&CommaVirtKey, (TCHAR)(',')); if (ok) ok = RegisterAdditionalVirtKey(&SlashVirtKey, (TCHAR)('/')); } return ok; }

BOOL TextTool::RemoveDeadKeys (   )  [protected]

Deregisters all the dead keys. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 12/10/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE See also: TextTool::RegisterDeadKeys Definition at line 2013 of file texttool.cpp. { if (GraveVirtKey != NULL) { KeyPress::RemoveVirtualKeyCode(GraveVirtKey->GetVirtKey(), GraveVirtKey->GetUnicode()); delete GraveVirtKey; } if (AcuteVirtKey != NULL) { KeyPress::RemoveVirtualKeyCode(AcuteVirtKey->GetVirtKey(), AcuteVirtKey->GetUnicode()); delete AcuteVirtKey; } if (TildeVirtKey != NULL) { KeyPress::RemoveVirtualKeyCode(TildeVirtKey->GetVirtKey(), TildeVirtKey->GetUnicode()); delete TildeVirtKey; } if (HatVirtKey != NULL) { KeyPress::RemoveVirtualKeyCode(HatVirtKey->GetVirtKey(), HatVirtKey->GetUnicode()); delete HatVirtKey; } if (ColonVirtKey != NULL) { KeyPress::RemoveVirtualKeyCode(ColonVirtKey->GetVirtKey(), ColonVirtKey->GetUnicode()); delete ColonVirtKey; } if (AtVirtKey != NULL) { KeyPress::RemoveVirtualKeyCode(AtVirtKey->GetVirtKey(), AtVirtKey->GetUnicode()); delete AtVirtKey; } if (CommaVirtKey != NULL) { KeyPress::RemoveVirtualKeyCode(CommaVirtKey->GetVirtKey(), CommaVirtKey->GetUnicode()); delete CommaVirtKey; } if (SlashVirtKey != NULL) { KeyPress::RemoveVirtualKeyCode(SlashVirtKey->GetVirtKey(), SlashVirtKey->GetUnicode()); delete SlashVirtKey; } return TRUE; }

void TextTool::RenderRulerBlobs (  RulerBase *  pRuler, UserRect &  UpdateRect, BOOL  IsBackground )  [virtual]

Gives the current tool the chance to render additional blobs on the ruler Is called twice - once before the standard ruler graphics are rendered (to allow additional background to be drawn) and once afterwards. Author: Martin Wuerthner <xara@mw-software.com> Date: 07/07/06 Parameters: pRuler  - the ruler that is currently being redrawn [INPUTS] UpdateRect - the rectangle to be updated in user coordinates (with the tool origin applied) IsBackground - whether this is the call before drawing the main blobs or the call after rendering the main blobs Reimplemented from Tool_v1. Definition at line 982 of file texttool.cpp. { // we only draw onto the horizontal ruler and only if we have claimed it if (!TextInfoBarOp::IsRulerOriginClaimed()) return; // draw the highlighted background or the blobs if (IsBackground) { TextInfoBarOp::HighlightRulerSection(pRuler, UpdateRect); } else { TextInfoBarOp::RenderRulerBlobs(pRuler, UpdateRect); } }

void TextTool::RenderToolBlobs (  Spread *  pSpread, DocRect *  pClipRect )  [virtual]

Called to render the tool blobs for the text tool. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 5/2/96 Parameters: pSpread  - the spread to render blobs on [INPUTS] pClipRect - blob rendering clipping rectangle, NULL for no clipping -  [OUTPUTS] Returns: - Reimplemented from Tool_v1. Definition at line 2443 of file texttool.cpp. { m_BlobPosList.RenderAllBlobs(pSpread, pClipRect); // ARGH! We may need to do this! Phil (15/12/2003) // See old implementation of RenderToolBlobsOff below. // if (!bRenderingOn) // m_BlobPosList.DeleteAll(); }

void TextTool::SelectChange (  BOOL  isSelected  )  [virtual]

Starts up and closes down the Text tool. Author: Mark_Goodall (Xara Group Ltd) <camelotdev@xara.com> Date: 3/10/94 Parameters: isSelected  - TRUE = tool has been selected [INPUTS] FALSE = tool has been deselected -  [OUTPUTS] Returns: - Errors: Debug warning if creating the cursor fails. See also: - Reimplemented from Tool_v1. Definition at line 431 of file texttool.cpp. { BOOL ok = TRUE; if (isSelected) ok = OnToolSelect(); else ok = OnToolDeselect(); if (!ok) InformError(); }

BOOL TextTool::SelectionHasChanged (  void   )

Called when the selection has changed. Ensures tool blobs are up-to-date. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 5/2/96 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if all ok, FALSE if error occured Definition at line 2465 of file texttool.cpp. { BOOL ok = TRUE; // Render the old blobs off if (ok) ok = m_BlobPosList.RenderAllBlobs(); // Reconstruct the list of blobs if (ok) ok = m_BlobPosList.BuildFromSelection(); // Render the new blobs on if (ok) ok = m_BlobPosList.RenderAllBlobs(); return ok; }

BOOL TextTool::TestForDeadKey (  KeyPress *  pKeyPress, KeyPress *  pDeadKeyPress )  [protected]

Flags 'dead-keys'. Attempts to apply an accent onto the next character. Author: Peter_Arnold (Xara Group Ltd) <camelotdev@xara.com> Date: 11/10/95 Parameters: pKeyPress  - points to the current keypress object [INPUTS] pDeadKeyPress - points to a know dead key to test against [OUTPUTS]  Returns: TRUE if keypress used, FALSE if not Definition at line 2182 of file texttool.cpp. { if ( pDeadKeyPress != NULL && pDeadKeyPress->GetVirtKey() != CAMKEY(CC_NONE) && !pDeadKeyPress->IsConstrain() && pKeyPress->IsConstrain() && pDeadKeyPress->IsAdjust() == pKeyPress->IsAdjust() && pDeadKeyPress->IsAlternative() == pKeyPress->IsAlternative() && pDeadKeyPress->GetVirtKey() == pKeyPress->GetVirtKey() ) { PreviousDeadKey = pDeadKeyPress; return TRUE; } else return FALSE; }

---

Member Data Documentation

KeyPress* TextTool::AcuteVirtKey [protected]

Definition at line 302 of file texttool.h.

KeyPress* TextTool::AtVirtKey [protected]

Definition at line 306 of file texttool.h.

TCHAR * TextTool::Author = _T("TextToolTeam") [static, protected]

Definition at line 290 of file texttool.h.

KeyPress* TextTool::ColonVirtKey [protected]

Definition at line 305 of file texttool.h.

KeyPress* TextTool::CommaVirtKey [protected]

Definition at line 307 of file texttool.h.

INT32 TextTool::CurrentCursorID [protected]

Definition at line 283 of file texttool.h.

BOOL TextTool::CurrentTool = FALSE [static, protected]

Definition at line 272 of file texttool.h.

TCHAR * TextTool::FamilyName = _T("Text Tools") [static, protected]

Definition at line 287 of file texttool.h.

KeyPress* TextTool::GraveVirtKey [protected]

Definition at line 301 of file texttool.h.

KeyPress* TextTool::HatVirtKey [protected]

Definition at line 303 of file texttool.h.

BOOL TextTool::IsBlankCursorUp [protected]

Definition at line 284 of file texttool.h.

TextToolBlobPosList TextTool::m_BlobPosList [protected]

Definition at line 311 of file texttool.h.

Cursor* TextTool::pcBlankCursor [protected]

Definition at line 279 of file texttool.h.

Cursor* TextTool::pcBlobTextCursor [protected]

Definition at line 278 of file texttool.h.

Cursor* TextTool::pcCurrentCursor [protected]

Definition at line 281 of file texttool.h.

Cursor* TextTool::pcIndentCursor [protected]

Definition at line 280 of file texttool.h.

Cursor* TextTool::pcNormalTextCursor [protected]

Definition at line 277 of file texttool.h.

TextStory* TextTool::pLastFocusStory [protected]

Definition at line 294 of file texttool.h.

KeyPress* TextTool::PreviousDeadKey [protected]

Definition at line 300 of file texttool.h.

TextInfoBarOp * TextTool::pTextInfoBarOp = NULL [static, protected]

Definition at line 274 of file texttool.h.

TCHAR * TextTool::Purpose = _T("Text manipulation") [static, protected]

Definition at line 289 of file texttool.h.

KeyPress* TextTool::SlashVirtKey [protected]

Definition at line 308 of file texttool.h.

KeyPress* TextTool::TildeVirtKey [protected]

Definition at line 304 of file texttool.h.

TCHAR * TextTool::ToolName = _T("Text Tool") [static, protected]

Definition at line 288 of file texttool.h.

BOOL TextTool::UpdateAfterTyping [protected]

Definition at line 292 of file texttool.h.

BOOL TextTool::UseDeadKeys = TRUE [static, protected]

Definition at line 297 of file texttool.h.

---

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

• tools/texttool.h (r1785/r1535)
• tools/texttool.cpp (r1785/r1656)

---