Lines Matching +full:index +full:- +full:page
2 // Use of this source code is governed by a BSD-style license that can be
37 // The page object constants.
46 #define FPDF_SEGMENT_UNKNOWN -1
82 // The image's horizontal pixel-per-inch.
84 // The image's vertical pixel-per-inch.
90 // The image's marked content ID. Useful for pairing with associated alt-text.
91 // A value of -1 indicates no ID.
104 // Create a new PDF page.
106 // document - handle to document.
107 // page_index - suggested 0-based index of the page to create. If it is larger
108 // than document's current last index(L), the created page index
109 // is the next available index -- L+1.
110 // width - the page width in points.
111 // height - the page height in points.
113 // Returns the handle to the new page or NULL on failure.
115 // The page should be closed with FPDF_ClosePage() when finished as
116 // with any other page in the document.
122 // Delete the page at |page_index|.
124 // document - handle to document.
125 // page_index - the index of the page to delete.
129 // Get the rotation of |page|.
131 // page - handle to a page
133 // Returns one of the following indicating the page rotation:
134 // 0 - No rotation.
135 // 1 - Rotated 90 degrees clockwise.
136 // 2 - Rotated 180 degrees clockwise.
137 // 3 - Rotated 270 degrees clockwise.
138 FPDF_EXPORT int FPDF_CALLCONV FPDFPage_GetRotation(FPDF_PAGE page);
140 // Set rotation for |page|.
142 // page - handle to a page.
143 // rotate - the rotation value, one of:
144 // 0 - No rotation.
145 // 1 - Rotated 90 degrees clockwise.
146 // 2 - Rotated 180 degrees clockwise.
147 // 3 - Rotated 270 degrees clockwise.
148 FPDF_EXPORT void FPDF_CALLCONV FPDFPage_SetRotation(FPDF_PAGE page, int rotate);
150 // Insert |page_obj| into |page|.
152 // page - handle to a page
153 // page_obj - handle to a page object. The |page_obj| will be automatically
155 FPDF_EXPORT void FPDF_CALLCONV FPDFPage_InsertObject(FPDF_PAGE page,
159 // Remove |page_obj| from |page|.
161 // page - handle to a page
162 // page_obj - handle to a page object to be removed.
169 FPDFPage_RemoveObject(FPDF_PAGE page, FPDF_PAGEOBJECT page_obj);
171 // Get number of page objects inside |page|.
173 // page - handle to a page.
175 // Returns the number of objects in |page|.
176 FPDF_EXPORT int FPDF_CALLCONV FPDFPage_CountObjects(FPDF_PAGE page);
178 // Get object in |page| at |index|.
180 // page - handle to a page.
181 // index - the index of a page object.
183 // Returns the handle to the page object, or NULL on failed.
184 FPDF_EXPORT FPDF_PAGEOBJECT FPDF_CALLCONV FPDFPage_GetObject(FPDF_PAGE page,
185 int index);
187 // Checks if |page| contains transparency.
189 // page - handle to a page.
191 // Returns TRUE if |page| contains transparency.
192 FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFPage_HasTransparency(FPDF_PAGE page);
194 // Generate the content of |page|.
196 // page - handle to a page.
200 // Before you save the page to a file, or reload the page, you must call
201 // |FPDFPage_GenerateContent| or any changes to |page| will be lost.
202 FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFPage_GenerateContent(FPDF_PAGE page);
207 // newly-created objects if they are not added to a page through
210 // page_obj - handle to a page object.
215 // page_object - handle to a page object.
223 // page_object - handle to a page object.
231 // page_object - handle to a page object.
232 // a - matrix value.
233 // b - matrix value.
234 // c - matrix value.
235 // d - matrix value.
236 // e - matrix value.
237 // f - matrix value.
253 // Get the transform matrix of a page object.
255 // page_object - handle to a page object.
256 // matrix - pointer to struct to receive the matrix value.
261 // and used to scale, rotate, shear and translate the page object.
268 // Set the transform matrix of a page object.
270 // page_object - handle to a page object.
271 // matrix - pointer to struct with the matrix value.
276 // and can be used to scale, rotate, shear and translate the page object.
282 // Transform all annotations in |page|.
284 // page - handle to a page.
285 // a - matrix value.
286 // b - matrix value.
287 // c - matrix value.
288 // d - matrix value.
289 // e - matrix value.
290 // f - matrix value.
295 // and can be used to scale, rotate, shear and translate the |page| annotations.
296 FPDF_EXPORT void FPDF_CALLCONV FPDFPage_TransformAnnots(FPDF_PAGE page,
306 // document - handle to a document.
315 // page_object - handle to a page object.
317 // Returns the number of content marks in |page_object|, or -1 in case of
323 // Get content mark in |page_object| at |index|.
325 // page_object - handle to a page object.
326 // index - the index of a page object.
330 // invalid if the page object is destroyed, either directly or indirectly by
331 // unloading the page.
333 FPDFPageObj_GetMark(FPDF_PAGEOBJECT page_object, unsigned long index);
338 // page_object - handle to a page object.
339 // name - the name (tag) of the mark.
343 // invalid if the page object is destroyed, either directly or indirectly by
344 // unloading the page.
352 // page_object - handle to a page object.
353 // mark - handle to a content mark in that object to remove.
362 // mark - handle to a content mark.
363 // buffer - buffer for holding the returned name in UTF-16LE. This is only
367 // buflen - length of the buffer.
368 // out_buflen - pointer to variable that will receive the minimum buffer size
381 // mark - handle to a content mark.
383 // Returns the number of key/value pair parameters |mark|, or -1 in case of
391 // mark - handle to a content mark.
392 // index - index of the property.
393 // buffer - buffer for holding the returned key in UTF-16LE. This is only
397 // buflen - length of the buffer.
398 // out_buflen - pointer to variable that will receive the minimum buffer size
404 unsigned long index,
412 // mark - handle to a content mark.
413 // key - string key of the property.
425 // mark - handle to a content mark.
426 // key - string key of the property.
427 // out_value - pointer to variable that will receive the value. Not filled if
439 // mark - handle to a content mark.
440 // key - string key of the property.
441 // buffer - buffer for holding the returned value in UTF-16LE. This is
446 // buflen - length of the buffer.
447 // out_buflen - pointer to variable that will receive the minimum buffer size
461 // mark - handle to a content mark.
462 // key - string key of the property.
463 // buffer - buffer for holding the returned value. This is only modified
467 // buflen - length of the buffer.
468 // out_buflen - pointer to variable that will receive the minimum buffer size
484 // document - handle to the document.
485 // page_object - handle to the page object with the mark.
486 // mark - handle to a content mark.
487 // key - string key of the property.
488 // value - int value to set.
503 // document - handle to the document.
504 // page_object - handle to the page object with the mark.
505 // mark - handle to a content mark.
506 // key - string key of the property.
507 // value - string value to set.
522 // document - handle to the document.
523 // page_object - handle to the page object with the mark.
524 // mark - handle to a content mark.
525 // key - string key of the property.
526 // value - pointer to blob value to set.
527 // value_len - size in bytes of |value|.
541 // page_object - handle to the page object with the mark.
542 // mark - handle to a content mark.
543 // key - string key of the property.
553 // pages - pointer to the start of all loaded pages, may be NULL.
554 // count - number of |pages|, may be 0.
555 // image_object - handle to an image object.
556 // file_access - file access handler which specifies the JPEG image file.
562 // for all the loaded pages. Pass |pages| and page count (|count|) to this API
573 // pages - pointer to the start of all loaded pages, may be NULL.
574 // count - number of |pages|, may be 0.
575 // image_object - handle to an image object.
576 // file_access - file access handler which specifies the JPEG image file.
582 // for all the loaded pages. Pass |pages| and page count (|count|) to this API
597 // image_object - handle to an image object.
598 // a - matrix value.
599 // b - matrix value.
600 // c - matrix value.
601 // d - matrix value.
602 // e - matrix value.
603 // f - matrix value.
622 // pages - pointer to the start of all loaded pages, may be NULL.
623 // count - number of |pages|, may be 0.
624 // image_object - handle to an image object.
625 // bitmap - handle of the bitmap.
640 // image_object - handle to an image object.
649 // |document| associated with |image_object|. If there is a |page| associated
654 // document - handle to a document associated with |image_object|.
655 // page - handle to an optional page associated with |image_object|.
656 // image_object - handle to an image object.
661 FPDF_PAGE page,
669 // image_object - handle to an image object.
670 // buffer - buffer for holding the decoded image data.
671 // buflen - length of the buffer in bytes.
683 // image_object - handle to an image object.
684 // buffer - buffer for holding the raw image data.
685 // buflen - length of the buffer in bytes.
695 // image_object - handle to an image object.
701 // Get the filter at |index| of |image_object|'s list of filters. Note that the
706 // image_object - handle to an image object.
707 // index - the index of the filter requested.
708 // buffer - buffer for holding filter string, encoded in UTF-8.
709 // buflen - length of the buffer.
714 int index,
723 // image_object - handle to an image object.
724 // page - handle to the page that |image_object| is on. Required for
726 // metadata - receives the image metadata; must not be NULL.
731 FPDF_PAGE page,
737 // image_object - handle to an image object.
738 // width - receives the image width in pixels; must not be NULL.
739 // height - receives the image height in pixels; must not be NULL.
749 // x - initial horizontal position.
750 // y - initial vertical position.
758 // x - horizontal position for the left boundary of the rectangle.
759 // y - vertical position for the bottom boundary of the rectangle.
760 // w - width of the rectangle.
761 // h - height of the rectangle.
771 // page_object - handle to a page object.
772 // left - pointer where the left coordinate will be stored
773 // bottom - pointer where the bottom coordinate will be stored
774 // right - pointer where the right coordinate will be stored
775 // top - pointer where the top coordinate will be stored
788 // page_object - handle to a page object.
789 // quad_points - pointer where the quadrilateral points will be stored.
793 // Similar to FPDFPageObj_GetBounds(), this returns the bounds of a page
794 // object. When the object is rotated by a non-multiple of 90 degrees, this API
806 // page_object - handle to a page object.
807 // blend_mode - string containing the blend mode.
816 // Set the stroke RGBA of a page object. Range of values: 0 - 255.
818 // page_object - the handle to the page object.
819 // R - the red component for the object's stroke color.
820 // G - the green component for the object's stroke color.
821 // B - the blue component for the object's stroke color.
822 // A - the stroke alpha for the object.
832 // Get the stroke RGBA of a page object. Range of values: 0 - 255.
834 // page_object - the handle to the page object.
835 // R - the red component of the path stroke color.
836 // G - the green component of the object's stroke color.
837 // B - the blue component of the object's stroke color.
838 // A - the stroke alpha of the object.
848 // Set the stroke width of a page object.
850 // path - the handle to the page object.
851 // width - the width of the stroke.
857 // Get the stroke width of a page object.
859 // path - the handle to the page object.
860 // width - the width of the stroke.
868 // page_object - handle to a page object.
870 // Returns the line join, or -1 on failure.
878 // page_object - handle to a page object.
879 // line_join - line join
888 // page_object - handle to a page object.
890 // Returns the line cap, or -1 on failure.
898 // page_object - handle to a page object.
899 // line_cap - line cap
906 // Set the fill RGBA of a page object. Range of values: 0 - 255.
908 // page_object - the handle to the page object.
909 // R - the red component for the object's fill color.
910 // G - the green component for the object's fill color.
911 // B - the blue component for the object's fill color.
912 // A - the fill alpha for the object.
922 // Get the fill RGBA of a page object. Range of values: 0 - 255.
924 // page_object - the handle to the page object.
925 // R - the red component of the object's fill color.
926 // G - the green component of the object's fill color.
927 // B - the blue component of the object's fill color.
928 // A - the fill alpha of the object.
941 // page_object - handle to a page object.
942 // phase - pointer where the dashing phase will be stored.
951 // page_object - handle to a page object.
952 // phase - line dash phase.
961 // page_object - handle to a page object.
963 // Returns the line dash array size or -1 on failure.
970 // page_object - handle to a page object.
971 // dash_array - pointer where the dashing array will be stored.
972 // dash_count - number of elements in |dash_array|.
983 // page_object - handle to a page object.
984 // dash_array - the dash array.
985 // dash_count - number of elements in |dash_array|.
986 // phase - the line dash phase.
997 // path - handle to a path.
1002 // Returns the number of objects in |path| or -1 on failure.
1005 // Get segment in |path| at |index|.
1007 // path - handle to a path.
1008 // index - the index of a segment.
1012 FPDFPath_GetPathSegment(FPDF_PAGEOBJECT path, int index);
1016 // segment - handle to a segment.
1017 // x - the horizontal position of the segment.
1018 // y - the vertical position of the segment.
1026 // segment - handle to a segment.
1034 // segment - handle to a segment.
1036 // Returns close flag for non-NULL segment, FALSE otherwise.
1042 // path - the handle to the path object.
1043 // x - the horizontal position of the new current point.
1044 // y - the vertical position of the new current point.
1056 // path - the handle to the path object.
1057 // x - the horizontal position of the new point.
1058 // y - the vertical position of the new point.
1069 // path - the handle to the path object.
1070 // x1 - the horizontal position of the first Bezier control point.
1071 // y1 - the vertical position of the first Bezier control point.
1072 // x2 - the horizontal position of the second Bezier control point.
1073 // y2 - the vertical position of the second Bezier control point.
1074 // x3 - the horizontal position of the ending point of the Bezier curve.
1075 // y3 - the vertical position of the ending point of the Bezier curve.
1088 // path - the handle to the path object.
1098 // path - the handle to the path object.
1099 // fillmode - the filling mode to be set: one of the FPDF_FILLMODE_* flags.
1100 // stroke - a boolean specifying if the path should be stroked or not.
1109 // path - the handle to the path object.
1110 // fillmode - the filling mode of the path: one of the FPDF_FILLMODE_* flags.
1111 // stroke - a boolean specifying if the path is stroked or not.
1120 // document - handle to the document.
1121 // font - string containing the font name, without spaces.
1122 // font_size - the font size for the new text object.
1132 // text_object - handle to the text object.
1133 // text - the UTF-16LE encoded string containing the text to be added.
1143 // text_object - handle to the text object.
1144 // charcodes - pointer to an array of charcodes to be added.
1145 // count - number of elements in |charcodes|.
1156 // document - handle to the document.
1157 // data - the stream of data, which will be copied by the font object.
1158 // size - size of the stream, in bytes.
1159 // font_type - FPDF_FONT_TYPE1 or FPDF_FONT_TRUETYPE depending on the font
1161 // cid - a boolean specifying if the font is a CID font or not.
1173 // Loads one of the standard 14 fonts per PDF spec 1.7 page 416. The preferred
1175 // for example 'Helvetica-BoldItalic'.
1177 // document - handle to the document.
1178 // font - string containing the font name, without spaces.
1188 // text - handle to a text.
1189 // size - pointer to the font size of the text object, measured in points
1198 // font - Handle to the loaded font.
1203 // document - handle to the document.
1204 // font - handle to the font object.
1205 // font_size - the font size for the new text object.
1215 // text - the handle to the text object.
1225 // text - the handle to the text object.
1226 // render_mode - the FPDF_TEXT_RENDERMODE enum value to be set (cannot set to
1236 // text_object - the handle to the text object.
1237 // text_page - the handle to the text page.
1238 // buffer - the address of a buffer that receives the text.
1239 // length - the size, in bytes, of |buffer|.
1244 // Regardless of the platform, the |buffer| is always in UTF-16LE encoding.
1256 // |page| associated with |text_object|, the caller should provide that as well.
1260 // document - handle to a document associated with |text_object|.
1261 // page - handle to an optional page associated with |text_object|.
1262 // text_object - handle to a text object.
1263 // scale - the scaling factor, which must be greater than 0.
1268 FPDF_PAGE page,
1275 // text - the handle to the text object.
1283 // font - the handle to the font object.
1284 // buffer - the address of a buffer that receives the font name.
1285 // length - the size, in bytes, of |buffer|.
1290 // Regardless of the platform, the |buffer| is always in UTF-8 encoding.
1299 // font - The handle to the font object. (Required)
1300 // buffer - The address of a buffer that receives the font data.
1301 // buflen - Length of the buffer.
1302 // out_buflen - Pointer to variable that will receive the minimum buffer size
1323 // font - the handle to the font object.
1325 // Returns 1 if the font is embedded, 0 if it not, and -1 on failure.
1331 // font - the handle to the font object.
1334 // defined in ISO 32000-1:2008, table 123, -1 on failure.
1340 // font - the handle to the font object.
1342 // Returns the font weight, -1 on failure.
1349 // font - the handle to the font object.
1350 // angle - pointer where the italic angle will be stored
1362 // font - the handle to the font object.
1363 // font_size - the size of the |font|.
1364 // ascent - pointer where the font ascent will be stored
1377 // font - the handle to the font object.
1378 // font_size - the size of the |font|.
1379 // descent - pointer where the font descent will be stored
1392 // font - the handle to the font object.
1393 // glyph - the glyph.
1394 // font_size - the size of the font.
1395 // width - pointer where the glyph width will be stored
1409 // font - the handle to the font object.
1410 // glyph - the glyph being drawn.
1411 // font_size - the size of the font.
1421 // glyphpath - handle to a glyph path.
1423 // Returns the number of objects in |glyphpath| or -1 on failure.
1428 // Get segment in glyphpath at index.
1430 // glyphpath - handle to a glyph path.
1431 // index - the index of a segment.
1435 FPDFGlyphPath_GetGlyphPathSegment(FPDF_GLYPHPATH glyphpath, int index);
1437 // Get number of page objects inside |form_object|.
1439 // form_object - handle to a form object.
1441 // Returns the number of objects in |form_object| on success, -1 on error.
1445 // Get page object in |form_object| at |index|.
1447 // form_object - handle to a form object.
1448 // index - the 0-based index of a page object.
1450 // Returns the handle to the page object, or NULL on error.
1452 FPDFFormObj_GetObject(FPDF_PAGEOBJECT form_object, unsigned long index);