The Thot Tool Kit API

1 Introduction to the document model

1.1 Logical structure

1.2 Presentation

2 Tool kit structure

2.1 Structure of this manual

2.2 Libraries

2.2.1 Thot Kernel library

2.2.2 Thot Editor library

3 Using the Thot tool kit

3.1 Errors

3.2 Include files

3.3 Buffers

3.4 Naming conventions

4 Types used by the Thot editing tool kit

5 Initialization

5.1 Constructors

5.1.1 TtaInitialize

5.1.2 TtaQuit

5.1.3 TtaInitializeAppRegistry

5.1.4 TtaSaveAppRegistry

5.2 Modificators

5.2.1 TtaSetApplicationQuit

6 Application

6.1 Constructors

6.1.1 TtaGetMemory

6.1.2 TtaFreeMemory

6.1.3 TtaGetEnvString

6.1.4 TtaGetDefEnvString

6.1.5 TtaGetEnvInt

6.1.6 TtaGetDefEnvInt

6.1.7 TtaGetEnvBoolean

6.1.8 TtaGetDefEnvBoolean

6.1.9 TtaIsBlank

6.1.10 TtaSkipBlanks

6.2 Modificators

6.2.1 TtaSetErrorMessages

6.2.2 TtaSetEnvString

6.2.3 TtaSetDefEnvString

6.2.4 TtaSetEnvInt

6.2.5 TtaSetEnvBoolean

6.3 Accessors

6.3.1 TtaGetVersion

6.3.2 TtaGetErrorCode

6.3.3 TtaGetStrError

7 Interface

7.1 Constructors

7.1.1 TtaSetCallback

7.1.2 TtaHandlePendingEvents

7.1.3 TtaHandleOneEvent

7.1.4 TtaAddButton

7.1.5 TtaAddTextZone

7.2 Accessors

7.2.1 TtaGetCurrentDisplay

7.2.2 TtaGetScreenDepth

7.2.3 TtaClickAnElement

7.3 Modificators

7.3.1 TtaChangeButton

7.3.2 TtaSetTextZone

7.3.3 TtaSetMenuOff

7.3.4 TtaSetMenuOn

7.3.5 TtaSetActionOff

7.3.6 TtaSetActionOn

7.3.7 TtaSetToggleItem

7.3.8 TtaSetCursorWatch

7.3.9 TtaResetCursor

8 Messages

8.1 Constructors

8.1.1 TtaGetMessageTable

8.2 Accessors

8.2.1 TtaGetMessage

8.2.2 TtaDisplaySimpleMessage

8.2.3 TtaDisplayMessage

9 Dialogue

9.1 Constructors

9.1.1 TtaSetCallback

9.1.2 TtaSetBackup

9.1.3 TtaSetDocStatusUpdate

9.1.4 TtaNewForm

9.1.5 TtaNewSheet

9.1.6 TtaNewDialogSheet

9.1.7 TtaNewSubmenu

9.1.8 TtaNewIconMenu

9.1.9 TtaNewToggleMenu

9.1.10 TtaNewSelector

9.1.11 TtaNewLabel

9.1.12 TtaNewTextForm

9.1.13 TtaNewNumberForm

9.1.14 TtaDestroyDialogue

9.1.15 TtaListDirectory

9.1.16 TtaIsSuffixFileIn

9.2 Modificators

9.2.1 TtaSetMenuForm

9.2.2 TtaSetToggleMenu

9.2.3 TtaSetTextForm

9.2.4 TtaShowDialogue

9.2.5 TtaUnmapDialogue

10 Documents and schemas

10.1 Constructors

10.1.1 TtaNewDocument

10.1.2 TtaOpenDocument

10.1.3 TtaSaveDocument

10.1.4 TtaExportDocument

10.1.5 TtaCloseDocument

10.1.6 TtaRemoveDocument

10.1.7 TtaSetDocumentPath

10.1.8 TtaAppendDocumentPath

10.1.9 TtaSetSchemaPath

10.2 Modificators

10.2.1 TtaNewNature

10.2.2 TtaNewSchemaExtension

10.2.3 TtaRemoveSchemaExtension

10.2.4 TtaSetPSchema

10.2.5 TtaSetDocumentDirectory

10.2.6 TtaSetDocumentName

10.2.7 TtaSetDocumentAccessMode

10.2.8 TtaSetDocumentBackUpInterval

10.2.9 TtaSetNotificationMode

10.2.10 TtaSetDocumentModified

10.2.11 TtaSetDocumentUnmodified

10.2.12 TtaSetDocumentUnupdated

10.3 Accessors

10.3.1 TtaGetSchemaExtension

10.3.2 TtaGetDocumentName

10.3.3 TtaGetDocumentFromName

10.3.4 TtaGetDocumentSSchema

10.3.5 TtaGetSSchemaName

10.3.6 TtaGetPSchemaName

10.3.7 TtaGetDocumentDirectory

10.3.8 TtaGetSSchema

10.3.9 TtaSameSSchemas

10.3.10 TtaGiveSchemasOfDocument

10.3.11 TtaNextSchemaExtension

10.3.12 TtaNextNature

10.3.13 TtaIsDocumentModified

10.3.14 TtaIsDocumentUpdated

10.3.15 TtaGetDocumentBackUpInterval

10.3.16 TtaGetDocumentAccessMode

10.3.17 TtaGetNotificationMode

10.3.18 TtaGetDocumentPath

10.3.19 TtaGetSchemaPath

10.3.20 TtaGetDocumentOfSavedElements

11 Tree structures

11.1 Constructors

11.1.1 TtaNewElement

11.1.2 TtaNewTree

11.1.3 TtaCopyTree

11.1.4 TtaCreateDescent

11.1.5 TtaCreateDescentWithContent

11.1.6 TtaDeleteTree

11.1.7 TtaAttachNewTree

11.1.8 TtaExportTree

11.2 Modificators

11.2.1 TtaInsertSibling

11.2.2 TtaInsertFirstChild

11.2.3 TtaCreateElement

11.2.4 TtaInsertElement

11.2.5 TtaRemoveTree

11.2.6 TtaSetAccessRight

11.2.7 TtaHolophrastElement

11.2.8 TtaSetCheckingMode

11.3 Accessors

11.3.1 TtaGetMainRoot

11.3.2 TtaNextAssociatedRoot

11.3.3 TtaGetFirstChild

11.3.4 TtaGetLastChild

11.3.5 TtaGetFirstLeaf

11.3.6 TtaGetLastLeaf

11.3.7 TtaPreviousSibling

11.3.8 TtaNextSibling

11.3.9 TtaGetSuccessor

11.3.10 TtaGetPredecessor

11.3.11 TtaGetParent

11.3.12 TtaGetCommonAncestor

11.3.13 TtaGetTypedAncestor

11.3.14 TtaGetElementType

11.3.15 TtaGetElementTypeName

11.3.16 TtaGetElementTypeOriginalName

11.3.17 TtaGiveTypeFromName

11.3.18 TtaGiveTypeFromOriginalName

11.3.19 TtaSameTypes

11.3.20 TtaGetElementLabel

11.3.21 TtaIsConstant

11.3.22 TtaIsLeaf

11.3.23 TtaGetConstructOfType

11.3.24 TtaGetConstruct

11.3.25 TtaGetAccessRight

11.3.26 TtaIsHolophrasted

11.3.27 TtaIsReadOnly

11.3.28 TtaIsHidden

11.3.29 TtaIsInAnInclusion

11.3.30 TtaIsAncestor

11.3.31 TtaIsBefore

11.3.32 TtaIsFirstPairedElement

11.3.33 TtaCanInsertSibling

11.3.34 TtaCanInsertFirstChild

11.3.35 TtaGetDocument

11.3.36 TtaNextCopiedElement

11.3.37 TtaGetCopiedDocument

11.4 Locators

11.4.1 TtaSearchTypedElement

11.4.2 TtaSearchTypedElementInTree

11.4.3 TtaSearchElementByLabel

11.4.4 TtaSearchEmptyElement

11.4.5 TtaSearchOtherPairedElement

11.4.6 TtaSearchNoPageBreak

11.5 Help

11.5.1 TtaListAbstractTree

12 Contents

12.1 Modificators

12.1.1 TtaSetTextContent

12.1.2 TtaAppendTextContent

12.1.3 TtaInsertTextContent

12.1.4 TtaDeleteTextContent

12.1.5 TtaSplitText

12.1.6 TtaMergeText

12.1.7 TtaSetGraphicsShape

12.1.8 TtaAddPointInPolyline

12.1.9 TtaDeletePointInPolyline

12.1.10 TtaModifyPointInPolyline

12.1.11 TtaChangeLimitOfPolyline

12.1.12 TtaCopyPage

12.2 Accessors

12.2.1 TtaGetVolume

12.2.2 TtaGetPictureType

12.2.3 TtaGetTextLength

12.2.4 TtaGiveTextContent

12.2.5 TtaGiveSubString

12.2.6 TtaGetGraphicsShape

12.2.7 TtaGetPolylineLength

12.2.8 TtaGivePolylinePoint

12.2.9 TtaGetPageNumber

12.2.10 TtaGetPageView

13 Logical attributes

13.1 Constructors

13.1.1 TtaNewAttribute

13.1.2 TtaAttachAttribute

13.1.3 TtaRemoveAttribute

13.2 Modificators

13.2.1 TtaSetAttributeValue

13.2.2 TtaSetAttributeText

13.3 Accessors

13.3.1 TtaNextAttribute

13.3.2 TtaGetAttribute

13.3.3 TtaGiveAttributeType

13.3.4 TtaGiveAttributeTypeFromName

13.3.5 TtaGiveAttributeTypeFromOriginalName

13.3.6 TtaGetAttributeName

13.3.7 TtaGetAttributeOriginalName

13.3.8 TtaSameAttributeTypes

13.3.9 TtaGetAttributeValue

13.3.10 TtaGetAttributeValueName

13.3.11 TtaGetAttributeValueFromName

13.3.12 TtaGetTextAttributeLength

13.3.13 TtaGiveTextAttributeValue

13.4 Locators

13.4.1 TtaSearchAttribute

13.4.2 TtaSearchAttributes

14 References and links

14.1 Modificators

14.1.1 TtaSetReference

14.1.2 TtaNewInclusion

14.1.3 TtaCopyReference

14.1.4 TtaSetAttributeReference

14.1.5 TtaCopyAttributeReference

14.1.6 TtaCopyIncludedElem

14.1.7 TtaUpdateInclusionElements

14.2 Accessors

14.2.1 TtaGiveReferredElement

14.2.2 TtaIsElementTypeReference

14.2.3 TtaSameReferences

14.2.4 TtaGiveReferenceAttributeValue

14.2.5 TtaIsElementReferred

14.2.6 TtaGetFirstReferringAttribute

14.2.7 TtaSameReferenceAttributes

14.3 Locators

14.3.1 TtaNextUnloadedReferringDocument

14.3.2 TtaSearchReferenceElement

15 Languages

15.1 Constructors

15.1.1 TtaNewLanguage

15.1.2 TtaRemoveLanguage

15.1.3 TtaLoadLanguageDictionaries

15.1.4 TtaUnLoadLanguageDictionaries

15.1.5 TtaLoadTypoDictionaries

15.1.6 TtaUnLoadTypoDictionaries

15.2 Accessors

15.2.1 TtaGetLanguageIdFromName

15.2.2 TtaGetDefaultLanguage

15.2.3 TtaGetLanguageIdFromAlphabet

15.2.4 TtaGetAlphabet

15.2.5 TtaGetLanguageName

15.2.6 TtaGetLanguageNameFromCode

15.2.7 TtaGetLanguageCodeFromName

15.2.8 TtaGetPrincipalDictionary

15.2.9 TtaGetSecondaryDictionary

15.2.10 TtaGetPrincipalTypoDictionary

15.2.11 TtaGetSecondaryTypoDictionary

15.2.12 TtaGetNumberOfLanguages

16 Specific presentation

16.1 Constructors

16.1.1 TtaNewPRule

16.1.2 TtaNewPRuleForNamedView

16.1.3 TtaCopyPRule

16.1.4 TtaAttachPRule

16.1.5 TtaRemovePRule

16.2 Modificators

16.2.1 TtaSetPRuleValue

16.2.2 TtaSetPRuleView

16.2.3 TtaChangeBoxSize

16.2.4 TtaChangeBoxPosition

16.3 Accessors

16.3.1 TtaGiveBoxSize

16.3.2 TtaGiveBoxPosition

16.3.3 TtaGiveBoxAbsPosition

16.3.4 TtaGiveWindowSize

16.3.5 TtaNextPRule

16.3.6 TtaGetPRule

16.3.7 TtaGetPRuleType

16.3.8 TtaGetPRuleValue

16.3.9 TtaGetPRuleUnit

16.3.10 TtaGetPRuleView

16.3.11 TtaSamePRules

17 Style

17.1 Constructors

17.1.1 TtaGetSpecificStyleContext

17.1.2 TtaGetGenericStyleContext

17.2 Modificators

17.2.1 TtaSetStylePresentation

17.2.2 TtaUpdateStylePresentation

17.2.3 TtaCleanStylePresentation

17.3 Accessors

17.3.1 TtaGetStylePresentation

17.3.2

18 Views

18.1 Constructors

18.1.1 TtaOpenMainView

18.1.2 TtaOpenView

18.1.3 TtaOpenSubView

18.1.4 TtaChangeViewTitle

18.1.5 TtaCloseView

18.2 Modificators

18.2.1 TtaSetSensibility

18.2.2 TtaSetZoom

18.2.3 TtaShowElement

18.2.4 TtaRaiseView

18.2.5 TtaSetDisplayMode

18.2.6 TtaLockTableFormatting

18.2.7 TtaUnlockTableFormatting

18.3 Accessors

18.3.1 TtaGetSensibility

18.3.2 TtaGetZoom

18.3.3 TtaGetFirstElementShown

18.3.4 TtaGetDisplayMode

18.3.5 TtaIsPSchemaValid

18.3.6 TtaGiveViewsToOpen

18.3.7 TtaGetViewName

18.3.8 TtaGetViewFromName

18.3.9 TtaGiveActiveView

18.3.10 TtaIsViewOpened

18.3.11 TtaGiveTableFormattingLock

18.4 Help

18.4.1 TtaListView

19 Selection

19.1 Constructors

19.1.1 TtaSelectElement

19.1.2 TtaSelectView

19.1.3 TtaSelectString

19.1.4 TtaExtendSelection

19.1.5 TtaAddElementToSelection

19.1.6 TtaSelectInterval

19.1.7 TtaUnselect

19.1.8 TtaSwitchSelection

19.1.9 TtaSetSelectionMode

19.2 Accessors

19.2.1 TtaGetSelectedDocument

19.2.2 TtaIsDocumentSelected

19.2.3 TtaIsSelectionEmpty

19.2.4 TtaGiveFirstSelectedElement

19.2.5 TtaGiveLastSelectedElement

19.2.6 TtaGiveNextSelectedElement

19.2.7 TtaGiveNextElement

20 Printing

20.1 Constructors

20.1.1 TtaPrint

20.2 Modificators

20.2.1 TtaSetPrintExportProc

20.2.2 TtaSetPrintSchema

20.2.3 TtaSetPrintParameter

20.2.4 TtaSetPrintCommand

20.2.5 TtaSetPsFile

20.3 Accessors

20.3.1 TtaIsPrinting

20.3.2 TtaGetPrintParameter

20.3.3 TtaGetPrintCommand

20.3.4 TtaGetPsFile