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


Ignore:
Timestamp:
Sep 20, 2016, 5:07:50 PM (3 years ago)
Author:
lewisr
Comment:

More formatting

Legend:

Unmodified
Added
Removed
Modified
  • Lucide-Plugin-API

    v2 v3  
    7676=== getPageCount() ===
    7777
    78 Description:    Returns the number of pages in the loaded document.
    79 
    80 Return value:   Number of pages.
    81 Default
    82 return value:   0
    83 
    84 long:           getPageCount();
    85 
    86 
     78Description:
     79  Returns the number of pages in the loaded document.
     80Return value:
     81  Number of pages.
     82Default return value:
     83  0
     84Type:
     85  long
     86Syntax:
     87  {{{getPageCount();}}}
    8788
    8889=== getPageSize() ===
    8990
    90 Description:    Gets the size of the specified page.
    91 
    92 Parameters:     pagenum: page number
    93                 width: return the width of the page
    94                 (NULL if width is not needed)
    95                 height: return the height of the page
    96                 (NULL if height is not needed)
    97 
    98 void:           getPageSize( in long pagenum, inout double width, inout double height );
    99 
     91Description:
     92  Gets the size of the specified page.
     93Parameters:
     94  ||pagenum||page number||
     95  ||width||return the width of the page (NULL if width is not needed)||
     96  ||height||return the height of the page (NULL if height is not needed)||
     97Type:
     98  void
     99Syntax:
     100  {{{getPageSize( in long pagenum, inout double width, inout double height );}}}
    100101
    101102[=#renderPageToPixbuf ]
    102103=== renderPageToPixbuf() ===
    103104
    104 Description:    First, scale the document to match the specified pixels per point,
    105                 then render the rectangle given by the upper left corner at
    106                 (src_x, src_y) and src_width by src_height.
    107 
    108 Parameters:     pagenum: the page from which we are to render
    109                 src_x: x coordinate of upper left corner
    110                 src_y: y coordinate of upper left corner
    111                 src_width: width of rectangle to render
    112                 src_height: height of rectangle to render
    113                 scale: scale specified as pixels per point
    114                 (if isScalable() is FALSE, scale is ignored and assumed to be 1.0)
    115                 rotation: rotate the document by the specified degree
    116                 (allowed values are 0, 90, 180, 270)
    117                 (if isRotable() is FALSE, rotation is ignored and assumed to be 0)
    118                 pixbuf: pixbuf into which we are to render
    119                 errorCode: return location for an error/warning code, or NULL
    120                 error: return location for an error/warning, or NULL
    121 
    122 Syntax:         renderPageToPixbuf( in long pagenum, in long src_x, in long src_y,
    123                         in long src_width, in long src_height,
    124                         in double scale, in long rotation,
    125                         in LuPixbuf pixbuf,
    126                         out long errorCode, inout string error );
    127 
     105Description:
     106  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.
     107Parameters:
     108  ||pagenum||the page from which we are to render||
     109  ||src_x||x coordinate of upper left corner||
     110  ||src_y||y coordinate of upper left corner||
     111  ||src_width||width of rectangle to render||
     112  ||src_height||height of rectangle to render||
     113  ||scale||scale specified as pixels per point (if isScalable() is FALSE, scale is ignored and assumed to be 1.0)||
     114  ||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)||
     115  ||pixbuf||pixbuf into which we are to render||
     116  ||errorCode||return location for an error/warning code, or NULL||
     117  ||error||return location for an error/warning, or NULL||
     118Syntax:
     119  {{{
     120renderPageToPixbuf( in long pagenum, in long src_x, in long src_y,
     121                    in long src_width, in long src_height,
     122                    in double scale, in long rotation,
     123                    in LuPixbuf pixbuf,
     124                    out long errorCode, inout string error );
     125}}}
    128126
    129127=== isAsynchRenderingSupported() ===
    130128
    131 Description:    See renderPageToPixbufAsynch().
    132 
    133 Return value:   TRUE if document can be rendered asynchronously.
    134 Default
    135 return value:   FALSE
    136 
    137 boolean:        isAsynchRenderingSupported();
    138 
    139 
     129Description:
     130  See [#renderPageToPixbufAsynch renderPageToPixbufAsynch()].
     131Return value:
     132  TRUE if document can be rendered asynchronously.
     133Default return value:
     134  FALSE
     135Type:
     136  boolean
     137Syntax:
     138  {{{isAsynchRenderingSupported();}}}
     139
     140[=#renderPageToPixbufAsynch ]
    140141=== renderPageToPixbufAsynch() ===
    141142
    142 Description:    Same as renderPageToPixbuf(), but received pointers to
    143                 draw function, abort function and functions data.
    144                 Callback functions must be defined as
    145                 long _System *asynchCallbackFn( void *data );
    146 
    147 Parameters:     errorCode: return location for an error/warning code, or NULL
    148                 error: return location for an error/warning, or NULL
    149 
    150 Note:           You must implement renderPageToPixbuf() also, as
    151                 it is used for printing.
    152 
    153 void:           renderPageToPixbufAsynch( in long pagenum, in long src_x,
    154                         in long src_y, in long src_width, in long src_height,
    155                         in double scale, in long rotation, in LuPixbuf pixbuf,
    156                         in asynchCallbackFn fnd, in asynchCallbackFn fna,
    157                         in somToken fndata,
    158                         out long errorCode, inout string error );
    159 
     143Description:
     144  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 );
     145Parameters:
     146  ||errorCode||return location for an error/warning code, or NULL||
     147  ||error||return location for an error/warning, or NULL||
     148Note:
     149  You must implement [#renderPageToPixbuf renderPageToPixbuf()] also, as it is used for printing.
     150Type:
     151  void
     152Syntax:
     153  {{{
     154renderPageToPixbufAsynch( in long pagenum, in long src_x,
     155                          in long src_y, in long src_width, in long src_height,
     156                          in double scale, in long rotation, in LuPixbuf pixbuf,
     157                          in asynchCallbackFn fnd, in asynchCallbackFn fna,
     158                          in somToken fndata,
     159                          out long errorCode, inout string error );
     160  }}}
    160161
    161162=== isRenderIntoPS() ===
    162163
    163 Description:    See: renderPageToPS().
    164 
    165 Return value:   TRUE if document will render directly into
    166                 presentation space using renderPageToPS().
    167 Default
    168 return value:   FALSE
    169 
    170 Note:           You may not implement renderPageToPixbuf() if
    171                 isRenderIntoPS() is TRUE.
    172 
    173 boolean:        isRenderIntoPS();
    174 
    175 
     164Description:
     165  See: [#renderPageToPS renderPageToPS()].
     166Return value:
     167  TRUE if document will render directly into presentation space using [#renderPageToPS renderPageToPS()].
     168Default return value:
     169  FALSE
     170Note:
     171  You may not implement renderPageToPixbuf() if isRenderIntoPS() is TRUE.
     172Type:
     173  boolean
     174Syntax:
     175  {{{isRenderIntoPS();}}}
     176
     177[=#renderPageToPS ]
    176178=== renderPageToPS() ===
    177179