Changes between Version 3 and Version 4 of Lucide-Plugin-API


Ignore:
Timestamp:
Sep 20, 2016, 11:31:18 PM (3 years ago)
Author:
lewisr
Comment:

More formatting

Legend:

Unmodified
Added
Removed
Modified
  • Lucide-Plugin-API

    v3 v4  
    4949
    5050=== isFixedImage() ===
    51 
    5251Description:
    5352  Determines if upscaling improves image quality. Must return TRUE for fixed-size images/bitmaps. Must return FALSE for documents which render fonts/vector images, to indicate that upscaling improves the quality of the rendered image. Used to determine better printing parameters.
     
    6261
    6362=== isRotable() ===
    64 
    6563Description:
    6664  See: [=#renderPageToPixbuf renderPageToPixbuf()], rotation.
     
    7573
    7674=== getPageCount() ===
    77 
    7875Description:
    7976  Returns the number of pages in the loaded document.
     
    8885
    8986=== getPageSize() ===
    90 
    9187Description:
    9288  Gets the size of the specified page.
     
    10298[=#renderPageToPixbuf ]
    10399=== renderPageToPixbuf() ===
    104 
    105100Description:
    106101  First, scale the document to match the specified pixels per point, then render the rectangle given by the upper left corner at (src_x, src_y) and src_width by src_height.
     
    126121
    127122=== isAsynchRenderingSupported() ===
    128 
    129123Description:
    130124  See [#renderPageToPixbufAsynch renderPageToPixbufAsynch()].
     
    140134[=#renderPageToPixbufAsynch ]
    141135=== renderPageToPixbufAsynch() ===
    142 
    143136Description:
    144137  Same as [#renderPageToPixbuf renderPageToPixbuf()], but received pointers to draw function, abort function and functions data. Callback functions must be defined as long _System *asynchCallbackFn( void *data );
     
    161154
    162155=== isRenderIntoPS() ===
    163 
    164156Description:
    165157  See: [#renderPageToPS renderPageToPS()].
     
    177169[=#renderPageToPS ]
    178170=== renderPageToPS() ===
    179 
    180 Description:    First scale the document to match the specified pixels per point,
    181                 then render the rectangle given by the upper left corner at
    182                 (src_x, src_y) and src_width and src_height.
    183 
    184 Parameters:     pagenum: the page from which we are to render
    185                 src_x: x coordinate of upper left corner
    186                 src_y: y coordinate of upper left corner
    187                 src_width: width of rectangle to render
    188                 src_height: height of rectangle to render
    189                 scale: scale specified as pixels per point
    190                 (if isScalable() is FALSE, scale is ignored and assumed to be 1.0)
    191                 rotation: rotate the document by the specified degree
    192                 (allowed values are 0, 90, 180, 270)
    193                 (if isRotable() is FALSE, rotation is ignored and assumed to be 0)
    194                 hps: handle of presentation space into which we are to render
    195                 rect: pointer to RECTL structure, defines render area on HPS
    196                 errorCode: return location for an error/warning code, or NULL
    197                 error: return location for an error/warning, or NULL
    198 
    199 Syntax:         renderPageToPS( in long pagenum, in long src_x, in long src_y,
    200                         in long src_width, in long src_height,
    201                         in double scale, in long rotation,
    202                         in unsigned long hps, in somMToken rect,
    203                         out long errorCode, inout string error );
    204 
     171Description:
     172  First scale the document to match the specified pixels per point, then render the rectangle given by the upper left corner at (src_x, src_y) and src_width and src_height.
     173Parameters:
     174  ||pagenum||the page from which we are to render||
     175  ||src_x||x coordinate of upper left corner||
     176  ||src_y||y coordinate of upper left corner||
     177  ||src_width||width of rectangle to render||
     178  ||src_height||height of rectangle to render||
     179  ||scale||scale specified as pixels per point (if isScalable() is FALSE, scale is ignored and assumed to be 1.0)||
     180  ||rotation||rotate the document by the specified degree (allowed values are 0, 90, 180, 270) (if isRotable() is FALSE, rotation is ignored and assumed to be 0)||
     181  ||hps||handle of presentation space into which we are to render||
     182  ||rect||pointer to RECTL structure, defines render area on HPS||
     183  ||errorCode||return location for an error/warning code, or NULL||
     184  ||error||return location for an error/warning, or NULL||
     185Syntax:
     186  {{{
     187  renderPageToPS( in long pagenum, in long src_x, in long src_y,
     188                  in long src_width, in long src_height,
     189                  in double scale, in long rotation,
     190                  in unsigned long hps, in somMToken rect,
     191                  out long errorCode, inout string error );
     192  }}}
    205193
    206194=== isHaveText() ===
    207 
    208 Description:    See: getSelectionRectangles(), searchText().
    209 
    210 Return value:   TRUE if the document contains text, which
    211                 can be selected by the user, searched, etc.;
    212                 FALSE otherwise.
    213 Default
    214 return value:   FALSE
    215 
    216 boolean:        isHaveText();
    217 
    218 
     195Description:
     196  See: [#getSelectionRectangles getSelectionRectangles()], [#searchText searchText()].
     197Return value:   
     198  TRUE if the document contains text, which can be selected by the user, searched, etc.; FALSE otherwise.
     199Default return value:
     200  FALSE
     201Type:
     202  boolean
     203Syntax:
     204  {{{isHaveText();}}}
     205
     206[=#getSelectionRectangles ]
    219207=== getSelectionRectangles() ===
    220 
    221 Description:    Returns a sequence of rectangles containing the area that would
    222                 be rendered as "selected."
    223                 The returned sequence must be freed with freeRectangles().
    224 
    225 Note:           SOMMalloc() must be used for all memory allocations.
    226 
    227 Parameters:     pagenum: page number
    228                 selection: start and end point of selection as a rectangle
    229 
    230 Return value:   A newly allocated LuRectSequence, or NULL if
    231                 nothing is selected or the document doesn't have
    232                 selectable text.
    233 Default
    234 return value:   NULL
    235 
    236 
    237 Syntax:         LuRectSequence *getSelectionRectangles( in long pagenum,
    238                         in LuRectangle selection );
    239 
    240 
     208Description:   
     209  Returns a sequence of rectangles containing the area that would be rendered as "selected." The returned sequence must be freed with [#freeRectangles freeRectangles()].
     210Parameters:
     211  ||pagenum||page number||
     212  ||selection||start and end point of selection as a rectangle||
     213Return value:
     214  A newly allocated LuRectSequence, or NULL if nothing is selected or the document doesn't have selectable text.
     215Default return value:
     216  NULL
     217Note:
     218  SOMMalloc() must be used for all memory allocations.
     219Syntax:
     220  {{{LuRectSequence *getSelectionRectangles( in long pagenum, in LuRectangle selection );}}}
     221
     222[=#freeRectangles ]
    241223=== freeRectangles() ===
    242 
    243 Description:    Deallocates a sequence of rectangles
    244                 allocated by getSelectionRectangles() or searchText().
    245 
    246 void:           freeRectangles( in LuRectSequence rectangles );
    247 
     224Description:
     225  Deallocates a sequence of rectangles allocated by [#getSelectionRectangles getSelectionRectangles()] or [#searchText searchText()].
     226Type:
     227  void
     228Syntax:
     229  {{{freeRectangles( in LuRectSequence rectangles );}}}
    248230
    249231=== getText() ===
    250 
    251 Description:    Retrieves the contents of the specified rectangle as text.
    252 
    253 Parameters:     pagenum: page number
    254                 selection: the rectangle including the text
    255 
    256 Return value:   A pointer to the contents of the rectangle
    257                 as a string or NULL.
    258                 The pointer is valid until next getText() call,
    259                 or until LuDocument object is destroyed.
    260 Default
    261 return value:   NULL
    262 
    263 Note:           Charset of returned string must be UTF-8
    264 
    265 string:         getText( in long pagenum, in LuRectangle selection );
    266 
     232Description:
     233  Retrieves the contents of the specified rectangle as text.
     234Parameters:
     235  ||pagenum||page number||
     236  ||selection||the rectangle including the text||
     237Return value:
     238  A pointer to the contents of the rectangle as a string or NULL. The pointer is valid until next getText() call, or until LuDocument object is destroyed.
     239Default return value:
     240  NULL
     241Note:
     242  Charset of returned string must be UTF-8
     243Type:
     244  string
     245Syntax:
     246  {{{getText( in long pagenum, in LuRectangle selection );}}}
    267247
    268248=== isHaveLinks() ===
    269 
    270 Description:    See: getLinkMapping().
    271 
    272 Return value:   TRUE if document may contain navigable links,
    273                 FALSE otherwise.
    274 Default
    275 return value:   FALSE
    276 
    277 boolean:        isHaveLinks();
    278 
    279 
     249Description:
     250  See: [#getLinkMapping getLinkMapping()].
     251Return value:
     252  TRUE if document may contain navigable links, FALSE otherwise.
     253Default return value:
     254  FALSE
     255Type:
     256  boolean
     257Syntax:
     258  {{{isHaveLinks();}}}
     259
     260[=#getLinkMapping ]
    280261=== getLinkMapping() ===
    281 
    282 Description:    Returns a sequence of LuLinkMapping items.
    283                 This sequence must be freed
    284                 with freeLinkMapping() when done.
    285 
    286 Parameters:     pagenum: page number
    287 
    288 Return value:   A pointer to sequence of LuLinkMapping.
    289 Default
    290 return value:   A pointer to an empty LuLinkMapSequence.
    291 
    292 Note:           SOMMalloc() must be used for all memory allocations.
    293 
    294 Syntax:         LuLinkMapSequence *getLinkMapping( in long pagenum );
    295 
    296 
     262Description:
     263  Returns a sequence of LuLinkMapping items. This sequence must be freed with [#freeLinkMapping freeLinkMapping()] when done.
     264Parameters:
     265  ||pagenum||page number||
     266Return value:
     267  A pointer to sequence of LuLinkMapping.
     268Default return value:
     269  A pointer to an empty LuLinkMapSequence.
     270Note:
     271  SOMMalloc() must be used for all memory allocations.
     272Syntax:
     273   {{{LuLinkMapSequence *getLinkMapping( in long pagenum );}}}
     274
     275[=#freeLinkMapping ]
    297276=== freeLinkMapping() ===
    298 
    299 Description:    Frees a sequence of LuLinkMapping allocated by
    300                 getLinkMapping().
    301 
    302 Parameters:     mapping: A sequence of LuLinkMapping
    303 
    304 void:           freeLinkMapping( in LuLinkMapSequence mapping );
    305 
    306 
     277Description:
     278  Frees a sequence of LuLinkMapping allocated by [#getLinkMapping getLinkMapping()].
     279Parameters:
     280  ||mapping||A sequence of LuLinkMapping||
     281Type:
     282  void
     283Syntax:
     284  {{{freeLinkMapping( in LuLinkMapSequence mapping );}}}
    307285
    308286=== isSaveable() ===
    309 
    310 Description:    Describes whether the current document may be saved.
    311 
    312 Return value:   TRUE if document can be saved in same format
    313                 as original, FALSE otherwise.
    314 Default
    315 return value:   FALSE
    316 
    317 boolean:        isSaveable();
    318 
     287Description:
     288  Describes whether the current document may be saved.
     289Return value:
     290  TRUE if document can be saved in same format as original, FALSE otherwise.
     291Default return value:
     292  FALSE
     293Type:
     294  boolean
     295Syntax:
     296  {{{isSaveable();}}}
    319297
    320298=== saveAs() ===
    321 
    322 Description:    Saves the current document.
    323 
    324 Parameters:     filename: name of file to save
    325 
    326 Return value:   TRUE, if the document was successfully saved,
    327                 FALSE otherwise.
    328 Default
    329 return value:   FALSE
    330 
    331 Syntax:         saveAs( in string filename );
    332 
    333 
     299Description:
     300  Saves the current document.
     301Parameters:
     302  ||filename||name of file to save||
     303
     304Return value:
     305  TRUE, if the document was successfully saved, FALSE otherwise.
     306Default return value:
     307  FALSE
     308Type:
     309  string
     310Syntax:
     311  {{{saveAs( in string filename );}}}
    334312
    335313=== isPostScriptExportable() ===
    336 
    337 Description:    Describes whether the current document may be
    338                 exported to PostScript.
    339 
    340 Return value:   TRUE if document can be exported to
    341                 PostScript, FALSE otherwise.
    342 Default
    343 return value:   FALSE
    344 
    345 boolean:        isPostScriptExportable();
    346 
     314Description:
     315  Describes whether the current document may be exported to PostScript.
     316Return value:
     317  TRUE if document can be exported to PostScript, FALSE otherwise.
     318Default return value:
     319  FALSE
     320Type:
     321  boolean
     322Syntax:
     323  {{{isPostScriptExportable();}}}
    347324
    348325=== exportToPostScript() ===
    349 
    350 Description:    Create a new postscript file and generate the document to it.
    351 
    352 Parameters:     filename: the path of the output filename
    353                 first_page: the first page to print
    354                 last_page: the last page to print
    355                 width: the paper width in 1/72 inch
    356                 height: the paper height in 1/72 inch
    357                 (These values will end up in the DocumentMedia, the
    358                 BoundingBox DSC comments, and other places in the
    359                 generated PostScript.)
    360                 brkExport: pointer to boolean variable which must be checked
    361                 during generating postscript, if it's TRUE - interrupt
    362                 generation process.
    363 
    364 Return value:   TRUE if PS document was generated successfully or
    365                 generation was interrupted, FALSE otherwise.
    366 Default
    367 return value:   FALSE
    368 
    369 Syntax:         exportToPostScript( in string filename,
    370                         in long first_page, in long last_page,
    371                         in double width, in double height,
    372                         inout boolean brkExport );
    373 
     326Description:
     327  Create a new postscript file and generate the document to it.
     328Parameters:
     329  ||filename||the path of the output filename||
     330  ||first_page||the first page to print||
     331  ||last_page||the last page to print||
     332  ||width||the paper width in 1/72 inch||
     333  ||height||the paper height in 1/72 inch||
     334  ||brkExport||pointer to boolean variable which must be checked during generating postscript; if TRUE, interrupt generation process.||
     335Return value:
     336  TRUE if PS document was generated successfully or generation was interrupted, FALSE otherwise.
     337Default return value:
     338  FALSE
     339Note:
     340  Values for width and height will end up in the DocumentMedia, the BoundingBox DSC comments, and other places in the generated PostScript.
     341Syntax:
     342{{{
     343  exportToPostScript( in string filename,
     344                      in long first_page, in long last_page,
     345                      in double width, in double height,
     346                      inout boolean brkExport );
     347}}}
    374348
    375349=== isHaveFontInfo() ===
    376 
    377 Description:    See: getFontInfo().
    378 
    379 Return value:   TRUE if getFontInfo() can return information about
    380                 fonts used in document, FALSE otherwise.
    381 Default
    382 return value:   FALSE
    383 
    384 boolean:        isHaveFontInfo();
    385 
    386 
     350Description:
     351  See: [#getFontInfo getFontInfo()].
     352Return value:
     353  TRUE if getFontInfo() can return information about fonts used in the document, FALSE otherwise.
     354Default return value:
     355  FALSE
     356Type:
     357  boolean
     358Syntax:
     359  {{{isHaveFontInfo();}}}
     360
     361[=#getFontInfo ]
    387362=== getFontInfo() ===
    388 
    389 Description:    Returns information about fonts used in document.
    390                 Returned sequence must be freed with freeFontInfo() when done.
    391 
    392 Return value:   A pointer to the sequence of LuFontInfo
    393                 or NULL if no font information.
    394 Default
    395 return value:   NULL
    396 
    397 Note:           SOMMalloc() must be used for all memory allocations.
    398 
    399 Syntax:         LuFontInfoSequence *getFontInfo();
    400 
    401 
     363Description:
     364  Returns information about fonts used in document. Returned sequence must be freed with [#freeFontInfo freeFontInfo()] when done.
     365Return value:
     366  A pointer to the sequence of LuFontInfo or NULL if no font information.
     367Default return value:
     368  NULL
     369Note:
     370  SOMMalloc() must be used for all memory allocations.
     371Syntax:
     372  {{{LuFontInfoSequence *getFontInfo();}}}
     373
     374[=#freeFontInfo ]
    402375=== freeFontInfo() ===
    403 
    404 Description:    Frees a sequence of LuFontInfo allocated by
    405                 getFontInfo().
    406 
    407 Parameters:     fonts: A sequence of LuFontInfo
    408 
    409 
    410 void:           freeFontInfo( in LuFontInfoSequence fonts );
    411 
     376Description:
     377  Frees a sequence of LuFontInfo allocated by [#getFontInfo getFontInfo()].
     378Parameters:
     379  ||fonts||A sequence of LuFontInfo||
     380Type:
     381  void
     382Syntax:
     383  {{{freeFontInfo( in LuFontInfoSequence fonts );}}}
    412384
    413385=== isHaveIndex() ===
    414 
    415 Description:    Determines if the document has an index associated with it.
    416                 See getIndex()
    417 
    418 Return value:   TRUE if the document has an index, FALSE otherwise.
    419 Default
    420 return value:   FALSE
    421 
    422 boolean:        isHaveIndex();
    423 
    424 
     386Description:
     387  Determines if the document has an index associated with it. See [#getIndex getIndex()].
     388Return value:
     389  TRUE if the document has an index, FALSE otherwise.
     390Default return value:
     391  FALSE
     392Type:
     393  boolean
     394Syntax:
     395  isHaveIndex();
     396
     397[=#getIndex ]
    425398=== getIndex() ===
    426 
    427 Description:    Certain documents have an index associated with them.
    428                 This index can be used to help the user navigate the document,
    429                 and is similar to a table of contents. Each node in the index will
    430                 contain a LuLink which can be displayed to the user.
    431 
    432                 Here is a simple example of some code that walks the full index:
    433 
    434                         void viewTree( int level, LuIndexNode *n )
    435                         {
    436                                 if ( n == NULL ) {
    437                                         return;
    438                                 }
    439                        
    440                                 somLPrintf( level, "title: %s\n", n->getLink(ev)->title );
    441                        
    442                                 LuIndexNode *cn = n->getFirstChild( ev );
    443                                 while ( cn != NULL ) {
    444                                         viewTree( level + 1, cn );
    445                                         cn = n->getNextChild( ev );
    446                                 }
    447                         }
    448 
    449 Return value:   A new LuIndexNode, which represents an index root,
    450                 or NULL, if the document doesn't have an index.
    451 Default
    452 return value:   NULL
    453 
    454 Syntax:         LuIndexNode getIndex();
    455 
    456 
     399Description:
     400  Certain documents have an index associated with them. This index can be used to help the user navigate the document, and is similar to a table of contents. Each node in the index will contain a LuLink which can be displayed to the user.
     401 
     402  Here is a simple example of some code that walks the full index:
     403  {{{
     404  void viewTree( int level, LuIndexNode *n )
     405  {
     406        if ( n == NULL ) {
     407                return;
     408        }
     409 
     410        somLPrintf( level, "title: %s\n", n->getLink(ev)->title );
     411 
     412        LuIndexNode *cn = n->getFirstChild( ev );
     413        while ( cn != NULL ) {
     414                viewTree( level + 1, cn );
     415                cn = n->getNextChild( ev );
     416        }
     417  }
     418  }}}
     419Return value:
     420  A new LuIndexNode, which represents an index root, or NULL, if the document doesn't have an index.
     421Default return value:
     422  NULL
     423Syntax:
     424  {{{LuIndexNode getIndex();}}}
     425
     426[=#getDocumentInfo ]
    457427=== getDocumentInfo() ===
    458 
    459 Description:    Returns information about the current document.
    460                 Returned sequence must be freed with freeDocumentInfo() when done.
    461 
    462 Return value:   A pointer to the sequence of LuDocumentInfo
    463                 or NULL if no information is available.
    464 Default
    465 return value:   NULL
    466 
    467 
    468 Syntax:         LuDocumentInfo *getDocumentInfo();
    469 
    470 
    471 
     428Description:
     429  Returns information about the current document. Returned sequence must be freed with [#freeDocumentInfo freeDocumentInfo()] when done.
     430Return value:
     431  A pointer to the sequence of LuDocumentInfo or NULL if no information is available.
     432Default return value:
     433  NULL
     434Syntax:
     435  {{{LuDocumentInfo *getDocumentInfo();}}}
     436
     437[=#freeDocumentInfo ]
    472438=== freeDocumentInfo() ===
    473 
    474 Description:    Frees a LuDocumentInfo structure allocated by getDocumentInfo().
    475 
    476 Parameters:     info: LuDocumentInfo structure allocated by getDocumentInfo()
    477 
    478 void:           freeDocumentInfo( in LuDocumentInfo info );
    479 
    480 
     439Description:
     440  Frees a LuDocumentInfo structure allocated by [#getDocumentInfo getDocumentInfo()].
     441Parameters:
     442  ||info||LuDocumentInfo structure allocated by [#getDocumentInfo getDocumentInfo()]||
     443Type:
     444  void
     445Syntax:
     446  {{{freeDocumentInfo( in LuDocumentInfo info );}}}
    481447
    482448=== getThumbnailSize() ===
    483 
    484 Description:    Returns TRUE if the page has a thumbnail associated with it. It also
    485                 fills the width and height with the those of the thumbnail.
    486                 The values of width and height are not changed if no
    487                 appropriate thumbnail exists.
    488 
    489 Parameters:     pagenum: page number
    490                 suggested_width: if thumbnail doesn't have a predefined width,
    491                 it will be created with suggested_width.
    492                 width: value for width
    493                 height: value for height
    494 
    495 Return value:   TRUE, if the page has a thumbnail associated with it, FALSE otherwise.
    496 Default
    497 return value:   FALSE
    498 
    499 Syntax:         getThumbnailSize( in long pagenum, in short suggested_width, inout short width, inout short height );
    500 
     449Description:
     450  Returns TRUE if the page has a thumbnail associated with it. It also fills the width and height with the those of the thumbnail. The values of width and height are not changed if no appropriate thumbnail exists.
     451Parameters:
     452  ||pagenum||page number||
     453  ||suggested_width||if thumbnail doesn't have a predefined width, it will be created with suggested_width.||
     454  ||width||value for width||
     455  ||height||value for height||
     456Return value:
     457  TRUE, if the page has a thumbnail associated with it, FALSE otherwise.
     458Default return value:
     459  FALSE
     460Syntax:
     461  {{{getThumbnailSize( in long pagenum, in short suggested_width, inout short width, inout short height );}}}
    501462
    502463=== getThumbnail() ===
    503 
    504 Description:    Returns pointer to LuPixbuf
    505 
    506 Parameters:     pagenum: page number
    507                 suggested_width: if thumbnail doesn't have a predefined width,
    508                 it will be created with suggested_width.
    509 
    510 Return value:   pointer to LuPixbuf, if page has a thumbnail associated with it,
    511                 or NULL.
    512 Default
    513 return value:   NULL
    514 
    515 Syntax:         LuPixbuf getThumbnail( in long pagenum, in short suggested_width );
    516 
    517 
    518 
     464Description:
     465  Returns pointer to LuPixbuf.
     466Parameters:
     467  ||pagenum||page number||
     468  ||suggested_width||if thumbnail doesn't have a predefined width, it will be created with suggested_width.||
     469Return value:
     470  Pointer to LuPixbuf, if page has a thumbnail associated with it, or NULL.
     471Default return value:
     472  NULL
     473Syntax:
     474  {{{LuPixbuf getThumbnail( in long pagenum, in short suggested_width );}}}
     475
     476[=#searchText ]
    519477=== searchText() ===
    520 
    521 Description:    Returns a sequence of rectangles for each occurrence of the text
    522                 found on the page.
    523                 The returned sequence must be freed with freeRectangles()
    524 
    525 Parameters:     pagenum: page number
    526                 text: the text to find (in system encoding)
    527 
    528 Return value:   A newly allocated LuRectSequence, or NULL if nothing found
    529 Default
    530 return value:   NULL
    531 
    532 Note:           SOMMalloc() must be used for all memory allocations.
    533 
    534 Syntax:         LuRectSequence *searchText( in long pagenum, in string text,
    535                         in boolean caseSensitive, in boolean findBack );
    536 
     478Description:
     479  Returns a sequence of rectangles for each occurrence of the text found on the page. The returned sequence must be freed with [#freeRectangles freeRectangles()].
     480Parameters:
     481  ||pagenum||page number||
     482  ||text||the text to find (in system encoding)||
     483Return value:
     484  A newly allocated LuRectSequence, or NULL if nothing found
     485Default return value:
     486  NULL
     487Note:
     488  SOMMalloc() must be used for all memory allocations.
     489Syntax:
     490  {{{
     491  LuRectSequence *searchText( in long pagenum, in string text,
     492                              in boolean caseSensitive, in boolean findBack );
     493  }}}
    537494
    538495=== isCreateFileThumbnail() ===
    539 
    540 Description:    If this method returns TRUE, then GUI may create thumbnail for
    541                 this file and write it into EAs.
    542 
    543 Return value:   TRUE, if thumbnail may be created, FALSE otherwise.
    544 Default
    545 return value:   FALSE
    546 
    547 boolean:        isCreateFileThumbnail();
    548 
     496Description:
     497  If this method returns TRUE, then GUI may create a thumbnail for this file and write it into the file's EAs.
     498Return value:
     499  TRUE, if thumbnail may be created, FALSE otherwise.
     500Default return value:
     501  FALSE
     502Type:
     503  boolean
     504Syntax:
     505  {{{isCreateFileThumbnail();}}}
    549506
    550507=== isHaveInputFields() ===
    551 
    552 Description:    Returns TRUE if the document contains input fields, FALSE otherwise.
    553                 See: getInputFields().
    554 
    555 Return value:   TRUE, if the document contains input fields, FALSE otherwise.
    556 Default
    557 return value:   FALSE
    558 
    559 boolean:        isHaveInputFields();
    560 
    561 
     508Description:
     509  Returns TRUE if the document contains input fields, FALSE otherwise. See: [#getInputFields getInputFields()].
     510Return value:
     511  TRUE, if the document contains input fields, FALSE otherwise.
     512Default return value:
     513  FALSE
     514Type:
     515  boolean
     516Syntax:
     517  {{{isHaveInputFields();}}}
     518
     519[=#getInputFields ]
    562520=== getInputFields() ===
    563 
    564 Description:    Returns a sequence of LuInputField items that may be used to enter
    565                 data into the document.
    566                 This sequence must be freed with freeInputFields() when done.
    567 
    568 Parameters:     pagenum: page number
    569 
    570 Return value:   A pointer to sequence of valid LuInputField items.
    571 Default
    572 return value:   A pointer to an empty LuInputFieldSequence.
    573 
    574 Note:           The returned sequence must be allocated with SOMMalloc(),
    575                 each element must be a newly created SOM object.
    576 
    577 Syntax:         {{{LuInputFieldSequence *getInputFields( in long pagenum );}}}
    578 
    579 
     521Description:
     522  Returns a sequence of LuInputField items that may be used to enter data into the document. This sequence must be freed with [#freeInputFields freeInputFields()] when done.
     523Parameters:
     524  ||pagenum||page number||
     525Return value:
     526  A pointer to sequence of valid LuInputField items.
     527Default return value:
     528  A pointer to an empty LuInputFieldSequence.
     529Note:
     530  The returned sequence must be allocated with SOMMalloc(), each element must be a newly created SOM object.
     531Syntax:
     532  {{{LuInputFieldSequence *getInputFields( in long pagenum );}}}
     533
     534[=#freeInputFields ]
    580535=== freeInputFields() ===
    581 
    582 Description:    Frees the input field sequence returned by getInputFields().
    583                 Subclasses should never override this method.
    584 
    585 void:           {{{freeInputFields(in LuInputFieldSequence aInputFields);}}}
     536Description:
     537  Frees the input field sequence returned by [#getInputFields getInputFields()]. Subclasses should never override this method.
     538Type:
     539  void
     540Syntax:
     541  {{{freeInputFields(in LuInputFieldSequence aInputFields);}}}