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

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.1.5 TtaGetEnvString

6 Application

6.1 Constructors

6.1.1 TtaGetMemory

6.1.2 TtaFreeMemory

6.2 Modificators

6.2.1 TtaSetErrorMessages

6.2.2 TtaSetEnvString

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 TtaCreatePixmapLogo

7.1.5 TtaCreateBitmapLogo

7.1.6 TtaAddButton

7.1.7 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 Documents and schemas

8.1 Constructors

8.1.1 TtaNewDocument

8.1.2 TtaOpenDocument

8.1.3 TtaSaveDocument

8.1.4 TtaExportDocument

8.1.5 TtaCloseDocument

8.1.6 TtaRemoveDocument

8.1.7 TtaSetDocumentPath

8.1.8 TtaAppendDocumentPath

8.1.9 TtaSetSchemaPath

8.2 Modificators

8.2.1 TtaNewNature

8.2.2 TtaNewSchemaExtension

8.2.3 TtaRemoveSchemaExtension

8.2.4 TtaSetPSchema

8.2.5 TtaSetDocumentDirectory

8.2.6 TtaSetDocumentName

8.2.7 TtaSetDocumentAccessMode

8.2.8 TtaSetDocumentBackUpInterval

8.2.9 TtaSetNotificationMode

8.2.10 TtaSetDocumentModified

8.2.11 TtaSetDocumentUnmodified

8.3 Accessors

8.3.1 TtaGetSchemaExtension

8.3.2 TtaGetDocumentName

8.3.3 TtaGetDocumentFromName

8.3.4 TtaGetDocumentSSchema

8.3.5 TtaGetSSchemaName

8.3.6 TtaGetPSchemaName

8.3.7 TtaGetDocumentDirectory

8.3.8 TtaGetSSchema

8.3.9 TtaSameSSchemas

8.3.10 TtaGiveSchemasOfDocument

8.3.11 TtaNextSchemaExtension

8.3.12 TtaNextNature

8.3.13 TtaIsDocumentModified

8.3.14 TtaGetDocumentBackUpInterval

8.3.15 TtaGetDocumentAccessMode

8.3.16 TtaGetNotificationMode

8.3.17 TtaGetDocumentPath

8.3.18 TtaGetSchemaPath

8.3.19 TtaGetDocumentOfSavedElements

9 Tree structures

9.1 Constructors

9.1.1 TtaNewElement

9.1.2 TtaNewTree

9.1.3 TtaCopyTree

9.1.4 TtaCreateDescent

9.1.5 TtaCreateDescentWithContent

9.1.6 TtaDeleteTree

9.1.7 TtaAttachNewTree

9.2 Modificators

9.2.1 TtaInsertSibling

9.2.2 TtaInsertFirstChild

9.2.3 TtaCreateElement

9.2.4 TtaInsertElement

9.2.5 TtaRemoveTree

9.2.6 TtaSetAccessRight

9.2.7 TtaHolophrastElement

9.2.8 TtaSetCheckingMode

9.3 Accessors

9.3.1 TtaGetMainRoot

9.3.2 TtaNextAssociatedRoot

9.3.3 TtaGetFirstChild

9.3.4 TtaGetLastChild

9.3.5 TtaPreviousSibling

9.3.6 TtaNextSibling

9.3.7 TtaGetSuccessor

9.3.8 TtaGetPredecessor

9.3.9 TtaGetParent

9.3.10 TtaGetCommonAncestor

9.3.11 TtaGetTypedAncestor

9.3.12 TtaGetElementType

9.3.13 TtaGetElementTypeName

9.3.14 TtaGiveTypeFromName

9.3.15 TtaSameTypes

9.3.16 TtaGetElementLabel

9.3.17 TtaIsConstant

9.3.18 TtaIsLeaf

9.3.19 TtaGetConstructOfType

9.3.20 TtaGetConstruct

9.3.21 TtaGetAccessRight

9.3.22 TtaIsHolophrasted

9.3.23 TtaIsReadOnly

9.3.24 TtaIsHidden

9.3.25 TtaIsInAnInclusion

9.3.26 TtaIsAncestor

9.3.27 TtaIsBefore

9.3.28 TtaIsFirstPairedElement

9.3.29 TtaCanInsertSibling

9.3.30 TtaCanInsertFirstChild

9.3.31 TtaGetDocument

9.3.32 TtaNextCopiedElement

9.3.33 TtaGetCopiedDocument

9.4 Locators

9.4.1 TtaSearchTypedElement

9.4.2 TtaSearchElementByLabel

9.4.3 TtaSearchEmptyElement

9.4.4 TtaSearchOtherPairedElement

9.4.5 TtaSearchNoPageBreak

9.5 Help

9.5.1 TtaListAbstractTree

10 Contents

10.1 Modificators

10.1.1 TtaSetTextContent

10.1.2 TtaAppendTextContent

10.1.3 TtaInsertTextContent

10.1.4 TtaDeleteTextContent

10.1.5 TtaSplitText

10.1.6 TtaMergeText

10.1.7 TtaSetGraphicsShape

10.1.8 TtaAddPointInPolyline

10.1.9 TtaDeletePointInPolyline

10.1.10 TtaModifyPointInPolyline

10.1.11 TtaChangeLimitOfPolyline

10.1.12 TtaCopyPage

10.2 Accessors

10.2.1 TtaGetPictureType

10.2.2 TtaGetTextLength

10.2.3 TtaGiveTextContent

10.2.4 TtaGiveSubString

10.2.5 TtaGetGraphicsShape

10.2.6 TtaGetPolylineLength

10.2.7 TtaGivePolylinePoint

10.2.8 TtaGetPageNumber

10.2.9 TtaGetPageView

11 Logical attributes

11.1 Constructors

11.1.1 TtaNewAttribute

11.1.2 TtaAttachAttribute

11.1.3 TtaRemoveAttribute

11.2 Modificators

11.2.1 TtaSetAttributeValue

11.2.2 TtaSetAttributeText

11.3 Accessors

11.3.1 TtaNextAttribute

11.3.2 TtaGetAttribute

11.3.3 TtaGiveAttributeType

11.3.4 TtaGiveAttributeTypeFromName

11.3.5 TtaGetAttributeName

11.3.6 TtaSameAttributeTypes

11.3.7 TtaGetAttributeValue

11.3.8 TtaGetTextAttributeLength

11.3.9 TtaGiveTextAttributeValue

11.4 Locators

11.4.1 TtaSearchAttribute

12 References and links

12.1 Modificators

12.1.1 TtaSetReference

12.1.2 TtaNewInclusion

12.1.3 TtaCopyReference

12.1.4 TtaSetAttributeReference

12.1.5 TtaCopyAttributeReference

12.2 Accessors

12.2.1 TtaGiveReferredElement

12.2.2 TtaIsElementTypeReference

12.2.3 TtaSameReferences

12.2.4 TtaGiveReferenceAttributeValue

12.2.5 TtaIsElementReferred

12.2.6 TtaSameReferenceAttributes

12.3 Locators

12.3.1 TtaNextLoadedReference

12.3.2 TtaNextUnloadedReferringDocument

12.3.3 TtaSearchReferenceElement

13 Languages

13.1 Constructors

13.1.1 TtaNewLanguage

13.1.2 TtaLoadLanguageDictionaries

13.1.3 TtaUnLoadLanguageDictionaries

13.1.4 TtaLoadTypoDictionaries

13.1.5 TtaUnLoadTypoDictionaries

13.2 Accessors

13.2.1 TtaGetLanguageIdFromName

13.2.2 TtaGetDefaultLanguage

13.2.3 TtaGetLanguageIdFromAlphabet

13.2.4 TtaGetAlphabet

13.2.5 TtaGetLanguageName

13.2.6 TtaGetPrincipalDictionary

13.2.7 TtaGetSecondaryDictionary

13.2.8 TtaGetPrincipalTypoDictionary

13.2.9 TtaGetSecondaryTypoDictionary

13.2.10 TtaGetNumberOfLanguages

14 Specific presentation

14.1 Constructors

14.1.1 TtaNewPRule

14.1.2 TtaNewPRuleForNamedView

14.1.3 TtaCopyPRule

14.1.4 TtaAttachPRule

14.1.5 TtaRemovePRule

14.2 Modificators

14.2.1 TtaSetPRuleValue

14.2.2 TtaChangeBoxSize

14.2.3 TtaChangeBoxPosition

14.3 Accessors

14.3.1 TtaGiveBoxSize

14.3.2 TtaGiveBoxPosition

14.3.3 TtaNextPRule

14.3.4 TtaGetPRule

14.3.5 TtaGetPRuleType

14.3.6 TtaGetPRuleValue

14.3.7 TtaSamePRules

15 Views

15.1 Constructors

15.1.1 TtaOpenMainView

15.1.2 TtaOpenView

15.1.3 TtaOpenSubView

15.1.4 TtaChangeViewTitle

15.1.5 TtaCloseView

15.2 Modificators

15.2.1 TtaSetSensibility

15.2.2 TtaSetZoom

15.2.3 TtaShowElement

15.2.4 TtaRaiseView

15.2.5 TtaSetDisplayMode

15.3 Accessors

15.3.1 TtaGetSensibility

15.3.2 TtaGetZoom

15.3.3 TtaGetDisplayMode

15.3.4 TtaIsPSchemaValid

15.3.5 TtaGiveViewsToOpen

15.3.6 TtaGetViewName

15.3.7 TtaGetViewFromName

15.3.8 TtaGiveActiveView

15.3.9 TtaIsViewOpened

15.4 Help

15.4.1 TtaListView

16 Selection

16.1 Constructors

16.1.1 TtaSelectElement

16.1.2 TtaSelectString

16.1.3 TtaExtendSelection

16.1.4 TtaSelectInterval

16.1.5 TtaUnselect

16.1.6 TtaSetSelectionMode

16.2 Accessors

16.2.1 TtaIsDocumentSelected

16.2.2 TtaGiveFirstSelectedElement

16.2.3 TtaGiveNextSelectedElement

17 Messages

17.1 Constructors

17.1.1 TtaGetMessageTable

17.2 Accessors

17.2.1 TtaGetMessage

17.2.2 TtaDisplaySimpleMessage

17.2.3 TtaDisplayMessage

18 Dialogue

18.1 Constructors

18.1.1 TtaListDirectory

18.1.2 TtaIsSuffixFileIn

19 Printing

19.1 Constructors

19.1.1 TtaPrint

19.2 Modificators

19.2.1 TtaSetPrintExportProc

19.2.2 TtaSetPrintParameter

19.2.3 TtaSetPrintCommand