GEOS SDK TechDocs
|
| 
2.2 Displaying the Data
| 
2.4 Navigating the Folder Tree
InkNoteSetKeywords(), InkNoteSetKeywordsFromTextObject(), InkNoteGetKeywords(), InkNoteSendKeywordsToTextObject(), InkGetTitle(), InkSendTitleToTextObject(), InkFolderSetTitle(), InkFolderSetTitleFromTextObject(), InkNoteSetTitle(), InkNoteSetTitleFromTextObject()
Each note may have two text strings which are helpful for identification: a title and a set of keywords. These words may be used as the fields for a computed search if the application supports these; regardless, the user will certainly find these fields useful for organizing notes.
To set a note's title, call
InkNoteSetTitle()
. There is a corresponding
InkFolderSetTitle()
for setting the title of a folder.
Since applications may wish to set the titles of these items based upon the user's entry in a text object, there are two routines
InkNoteSetTitleFromTextObject()
and
InkFolderSetTitleFromTextObject()
which take an item's name from a text object.
InkGetTitle()
gets any item's title, and
InkSendTitleToTextObject()
is a specialized function used to update the passed text object's text to hold the item's title. The maximum length of any title should be
INK_DB_MAX_TITLE_SIZE.
Notes may have keywords: words which should not appear in the title but which are still useful for searches. Folders do not have keywords. To set a note's keywords, use
InkNoteSetKeywords()
;
to use the contents of a text object as the keywords, use
InkNoteSetKeywordsFromTextObject()
.
To retrieve the keywords, call
InkNoteGetKeywords()
.
InkNoteSendKeywordsToTextObject()
replaces a text object's text with the passed note's keywords. The maximum length of any keyword should be INK_DB_MAX_NOTE_KEYWORDS_SIZE
.
GEOS SDK TechDocs
|
| 2.2 Displaying the Data
| 2.4 Navigating the Folder Tree