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.
130 // Move the given pages to a new index position.
132 // page_indices - the ordered list of pages to move. No duplicates allowed.
133 // page_indices_len - the number of elements in |page_indices|
134 // dest_page_index - the new index position to which the pages in
147 // > // Returned false because index 4 is out of range.
150 // > // Returned false because index 2 is out of range for 3 page indices.
161 // Get the rotation of |page|.
163 // page - handle to a page
165 // Returns one of the following indicating the page rotation:
166 // 0 - No rotation.
167 // 1 - Rotated 90 degrees clockwise.
168 // 2 - Rotated 180 degrees clockwise.
169 // 3 - Rotated 270 degrees clockwise.
170 FPDF_EXPORT int FPDF_CALLCONV FPDFPage_GetRotation(FPDF_PAGE page);
172 // Set rotation for |page|.
174 // page - handle to a page.
175 // rotate - the rotation value, one of:
176 // 0 - No rotation.
177 // 1 - Rotated 90 degrees clockwise.
178 // 2 - Rotated 180 degrees clockwise.
179 // 3 - Rotated 270 degrees clockwise.
180 FPDF_EXPORT void FPDF_CALLCONV FPDFPage_SetRotation(FPDF_PAGE page, int rotate);
182 // Insert |page_object| into |page|.
184 // page - handle to a page
185 // page_object - handle to a page object. The |page_object| will be
188 FPDFPage_InsertObject(FPDF_PAGE page, FPDF_PAGEOBJECT page_object);
191 // Remove |page_object| from |page|.
193 // page - handle to a page
194 // page_object - handle to a page object to be removed.
201 // FPDF_TEXTPAGE handles for |page| are no longer valid.
203 FPDFPage_RemoveObject(FPDF_PAGE page, FPDF_PAGEOBJECT page_object);
205 // Get number of page objects inside |page|.
207 // page - handle to a page.
209 // Returns the number of objects in |page|.
210 FPDF_EXPORT int FPDF_CALLCONV FPDFPage_CountObjects(FPDF_PAGE page);
212 // Get object in |page| at |index|.
214 // page - handle to a page.
215 // index - the index of a page object.
217 // Returns the handle to the page object, or NULL on failed.
218 FPDF_EXPORT FPDF_PAGEOBJECT FPDF_CALLCONV FPDFPage_GetObject(FPDF_PAGE page,
219 int index);
221 // Checks if |page| contains transparency.
223 // page - handle to a page.
225 // Returns TRUE if |page| contains transparency.
226 FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFPage_HasTransparency(FPDF_PAGE page);
228 // Generate the content of |page|.
230 // page - handle to a page.
234 // Before you save the page to a file, or reload the page, you must call
235 // |FPDFPage_GenerateContent| or any changes to |page| will be lost.
236 FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDFPage_GenerateContent(FPDF_PAGE page);
241 // newly-created objects if they are not added to a page through
244 // page_object - handle to a page object.
249 // page_object - handle to a page object.
257 // page_object - handle to a page object.
264 // Sets if |page_object| is active within page.
266 // page_object - handle to a page object.
267 // active - a boolean specifying if the object is active.
271 // Page objects all start in the active state by default, and remain in that
281 // page_object - handle to a page object.
282 // a - matrix value.
283 // b - matrix value.
284 // c - matrix value.
285 // d - matrix value.
286 // e - matrix value.
287 // f - matrix value.
305 // page_object - handle to a page object.
306 // matrix - the transform matrix.
318 // Get the transform matrix of a page object.
320 // page_object - handle to a page object.
321 // matrix - pointer to struct to receive the matrix value.
326 // and used to scale, rotate, shear and translate the page object.
328 // For page objects outside form objects, the matrix values are relative to the
329 // page that contains it.
330 // For page objects inside form objects, the matrix values are relative to the
338 // Set the transform matrix of a page object.
340 // page_object - handle to a page object.
341 // matrix - pointer to struct with the matrix value.
346 // and can be used to scale, rotate, shear and translate the page object.
352 // Transform all annotations in |page|.
354 // page - handle to a page.
355 // a - matrix value.
356 // b - matrix value.
357 // c - matrix value.
358 // d - matrix value.
359 // e - matrix value.
360 // f - matrix value.
365 // and can be used to scale, rotate, shear and translate the |page| annotations.
366 FPDF_EXPORT void FPDF_CALLCONV FPDFPage_TransformAnnots(FPDF_PAGE page,
376 // document - handle to a document.
385 // page_object - handle to a page object.
387 // Returns the page object's marked content ID, or -1 on error.
394 // page_object - handle to a page object.
396 // Returns the number of content marks in |page_object|, or -1 in case of
402 // Get content mark in |page_object| at |index|.
404 // page_object - handle to a page object.
405 // index - the index of a page object.
409 // invalid if the page object is destroyed, either directly or indirectly by
410 // unloading the page.
412 FPDFPageObj_GetMark(FPDF_PAGEOBJECT page_object, unsigned long index);
417 // page_object - handle to a page object.
418 // name - the name (tag) of the mark.
422 // invalid if the page object is destroyed, either directly or indirectly by
423 // unloading the page.
431 // page_object - handle to a page object.
432 // mark - handle to a content mark in that object to remove.
441 // mark - handle to a content mark.
442 // buffer - buffer for holding the returned name in UTF-16LE. This is only
446 // buflen - length of the buffer in bytes.
447 // out_buflen - pointer to variable that will receive the minimum buffer size
461 // mark - handle to a content mark.
463 // Returns the number of key/value pair parameters |mark|, or -1 in case of
471 // mark - handle to a content mark.
472 // index - index of the property.
473 // buffer - buffer for holding the returned key in UTF-16LE. This is only
477 // buflen - length of the buffer in bytes.
478 // out_buflen - pointer to variable that will receive the minimum buffer size
485 unsigned long index,
493 // mark - handle to a content mark.
494 // key - string key of the property.
506 // mark - handle to a content mark.
507 // key - string key of the property.
508 // out_value - pointer to variable that will receive the value. Not filled if
520 // mark - handle to a content mark.
521 // key - string key of the property.
522 // buffer - buffer for holding the returned value in UTF-16LE. This is
526 // buflen - length of the buffer in bytes.
527 // out_buflen - pointer to variable that will receive the minimum buffer size
542 // mark - handle to a content mark.
543 // key - string key of the property.
544 // buffer - buffer for holding the returned value. This is only modified
548 // buflen - length of the buffer in bytes.
549 // out_buflen - pointer to variable that will receive the minimum buffer size
566 // document - handle to the document.
567 // page_object - handle to the page object with the mark.
568 // mark - handle to a content mark.
569 // key - string key of the property.
570 // value - int value to set.
585 // document - handle to the document.
586 // page_object - handle to the page object with the mark.
587 // mark - handle to a content mark.
588 // key - string key of the property.
589 // value - string value to set.
604 // document - handle to the document.
605 // page_object - handle to the page object with the mark.
606 // mark - handle to a content mark.
607 // key - string key of the property.
608 // value - pointer to blob value to set.
609 // value_len - size in bytes of |value|.
623 // page_object - handle to the page object with the mark.
624 // mark - handle to a content mark.
625 // key - string key of the property.
635 // pages - pointer to the start of all loaded pages, may be NULL.
636 // count - number of |pages|, may be 0.
637 // image_object - handle to an image object.
638 // file_access - file access handler which specifies the JPEG image file.
644 // for all the loaded pages. Pass |pages| and page count (|count|) to this API
655 // pages - pointer to the start of all loaded pages, may be NULL.
656 // count - number of |pages|, may be 0.
657 // image_object - handle to an image object.
658 // file_access - file access handler which specifies the JPEG image file.
664 // for all the loaded pages. Pass |pages| and page count (|count|) to this API
679 // image_object - handle to an image object.
680 // a - matrix value.
681 // b - matrix value.
682 // c - matrix value.
683 // d - matrix value.
684 // e - matrix value.
685 // f - matrix value.
704 // pages - pointer to the start of all loaded pages, may be NULL.
705 // count - number of |pages|, may be 0.
706 // image_object - handle to an image object.
707 // bitmap - handle of the bitmap.
722 // image_object - handle to an image object.
731 // |document| associated with |image_object|. If there is a |page| associated
736 // document - handle to a document associated with |image_object|.
737 // page - handle to an optional page associated with |image_object|.
738 // image_object - handle to an image object.
743 FPDF_PAGE page,
751 // image_object - handle to an image object.
752 // buffer - buffer for holding the decoded image data.
753 // buflen - length of the buffer in bytes.
765 // image_object - handle to an image object.
766 // buffer - buffer for holding the raw image data.
767 // buflen - length of the buffer in bytes.
777 // image_object - handle to an image object.
783 // Get the filter at |index| of |image_object|'s list of filters. Note that the
788 // image_object - handle to an image object.
789 // index - the index of the filter requested.
790 // buffer - buffer for holding filter string, encoded in UTF-8.
791 // buflen - length of the buffer.
796 int index,
805 // image_object - handle to an image object.
806 // page - handle to the page that |image_object| is on. Required for
808 // metadata - receives the image metadata; must not be NULL.
813 FPDF_PAGE page,
819 // image_object - handle to an image object.
820 // width - receives the image width in pixels; must not be NULL.
821 // height - receives the image height in pixels; must not be NULL.
831 // x - initial horizontal position.
832 // y - initial vertical position.
840 // x - horizontal position for the left boundary of the rectangle.
841 // y - vertical position for the bottom boundary of the rectangle.
842 // w - width of the rectangle.
843 // h - height of the rectangle.
853 // page_object - handle to a page object.
854 // left - pointer where the left coordinate will be stored
855 // bottom - pointer where the bottom coordinate will be stored
856 // right - pointer where the right coordinate will be stored
857 // top - pointer where the top coordinate will be stored
870 // page_object - handle to a page object.
871 // quad_points - pointer where the quadrilateral points will be stored.
875 // Similar to FPDFPageObj_GetBounds(), this returns the bounds of a page
876 // object. When the object is rotated by a non-multiple of 90 degrees, this API
888 // page_object - handle to a page object.
889 // blend_mode - string containing the blend mode.
898 // Set the stroke RGBA of a page object. Range of values: 0 - 255.
900 // page_object - the handle to the page object.
901 // R - the red component for the object's stroke color.
902 // G - the green component for the object's stroke color.
903 // B - the blue component for the object's stroke color.
904 // A - the stroke alpha for the object.
914 // Get the stroke RGBA of a page object. Range of values: 0 - 255.
916 // page_object - the handle to the page object.
917 // R - the red component of the path stroke color.
918 // G - the green component of the object's stroke color.
919 // B - the blue component of the object's stroke color.
920 // A - the stroke alpha of the object.
930 // Set the stroke width of a page object.
932 // path - the handle to the page object.
933 // width - the width of the stroke.
939 // Get the stroke width of a page object.
941 // path - the handle to the page object.
942 // width - the width of the stroke.
950 // page_object - handle to a page object.
952 // Returns the line join, or -1 on failure.
960 // page_object - handle to a page object.
961 // line_join - line join
970 // page_object - handle to a page object.
972 // Returns the line cap, or -1 on failure.
980 // page_object - handle to a page object.
981 // line_cap - line cap
988 // Set the fill RGBA of a page object. Range of values: 0 - 255.
990 // page_object - the handle to the page object.
991 // R - the red component for the object's fill color.
992 // G - the green component for the object's fill color.
993 // B - the blue component for the object's fill color.
994 // A - the fill alpha for the object.
1004 // Get the fill RGBA of a page object. Range of values: 0 - 255.
1006 // page_object - the handle to the page object.
1007 // R - the red component of the object's fill color.
1008 // G - the green component of the object's fill color.
1009 // B - the blue component of the object's fill color.
1010 // A - the fill alpha of the object.
1023 // page_object - handle to a page object.
1024 // phase - pointer where the dashing phase will be stored.
1033 // page_object - handle to a page object.
1034 // phase - line dash phase.
1043 // page_object - handle to a page object.
1045 // Returns the line dash array size or -1 on failure.
1052 // page_object - handle to a page object.
1053 // dash_array - pointer where the dashing array will be stored.
1054 // dash_count - number of elements in |dash_array|.
1065 // page_object - handle to a page object.
1066 // dash_array - the dash array.
1067 // dash_count - number of elements in |dash_array|.
1068 // phase - the line dash phase.
1079 // path - handle to a path.
1084 // Returns the number of objects in |path| or -1 on failure.
1087 // Get segment in |path| at |index|.
1089 // path - handle to a path.
1090 // index - the index of a segment.
1094 FPDFPath_GetPathSegment(FPDF_PAGEOBJECT path, int index);
1098 // segment - handle to a segment.
1099 // x - the horizontal position of the segment.
1100 // y - the vertical position of the segment.
1108 // segment - handle to a segment.
1116 // segment - handle to a segment.
1118 // Returns close flag for non-NULL segment, FALSE otherwise.
1124 // path - the handle to the path object.
1125 // x - the horizontal position of the new current point.
1126 // y - the vertical position of the new current point.
1138 // path - the handle to the path object.
1139 // x - the horizontal position of the new point.
1140 // y - the vertical position of the new point.
1151 // path - the handle to the path object.
1152 // x1 - the horizontal position of the first Bezier control point.
1153 // y1 - the vertical position of the first Bezier control point.
1154 // x2 - the horizontal position of the second Bezier control point.
1155 // y2 - the vertical position of the second Bezier control point.
1156 // x3 - the horizontal position of the ending point of the Bezier curve.
1157 // y3 - the vertical position of the ending point of the Bezier curve.
1170 // path - the handle to the path object.
1180 // path - the handle to the path object.
1181 // fillmode - the filling mode to be set: one of the FPDF_FILLMODE_* flags.
1182 // stroke - a boolean specifying if the path should be stroked or not.
1191 // path - the handle to the path object.
1192 // fillmode - the filling mode of the path: one of the FPDF_FILLMODE_* flags.
1193 // stroke - a boolean specifying if the path is stroked or not.
1202 // document - handle to the document.
1203 // font - string containing the font name, without spaces.
1204 // font_size - the font size for the new text object.
1214 // text_object - handle to the text object.
1215 // text - the UTF-16LE encoded string containing the text to be added.
1225 // text_object - handle to the text object.
1226 // charcodes - pointer to an array of charcodes to be added.
1227 // count - number of elements in |charcodes|.
1237 // are auto-generated based on the inputs.
1239 // document - handle to the document.
1240 // data - the stream of font data, which will be copied by the font object.
1241 // size - the size of the font data, in bytes.
1242 // font_type - FPDF_FONT_TYPE1 or FPDF_FONT_TRUETYPE depending on the font type.
1243 // cid - a boolean specifying if the font is a CID font or not.
1255 // Loads one of the standard 14 fonts per PDF spec 1.7 page 416. The preferred
1257 // for example 'Helvetica-BoldItalic'.
1259 // document - handle to the document.
1260 // font - string containing the font name, without spaces.
1271 // data and the CIDToGIDMap data are caller provided, instead of auto-generated.
1273 // document - handle to the document.
1274 // font_data - the stream of font data, which will be copied by
1276 // font_data_size - the size of the font data, in bytes.
1277 // to_unicode_cmap - the ToUnicode data.
1278 // cid_to_gid_map_data - the stream of CIDToGIDMap data.
1279 // cid_to_gid_map_data_size - the size of the CIDToGIDMap data, in bytes.
1294 // text - handle to a text.
1295 // size - pointer to the font size of the text object, measured in points
1304 // font - Handle to the loaded font.
1309 // document - handle to the document.
1310 // font - handle to the font object.
1311 // font_size - the font size for the new text object.
1321 // text - the handle to the text object.
1331 // text - the handle to the text object.
1332 // render_mode - the FPDF_TEXT_RENDERMODE enum value to be set (cannot set to
1342 // text_object - the handle to the text object.
1343 // text_page - the handle to the text page.
1344 // buffer - the address of a buffer that receives the text.
1345 // length - the size, in bytes, of |buffer|.
1350 // Regardless of the platform, the |buffer| is always in UTF-16LE encoding.
1362 // |page| associated with |text_object|, the caller should provide that as well.
1366 // document - handle to a document associated with |text_object|.
1367 // page - handle to an optional page associated with |text_object|.
1368 // text_object - handle to a text object.
1369 // scale - the scaling factor, which must be greater than 0.
1374 FPDF_PAGE page,
1381 // text - the handle to the text object.
1389 // font - the handle to the font object.
1390 // buffer - the address of a buffer that receives the base font name.
1391 // length - the size, in bytes, of |buffer|.
1395 // PostScript name. See descriptions of "BaseFont" in ISO 32000-1:2008 spec.
1397 // Regardless of the platform, the |buffer| is always in UTF-8 encoding.
1407 // font - the handle to the font object.
1408 // buffer - the address of a buffer that receives the font name.
1409 // length - the size, in bytes, of |buffer|.
1414 // Regardless of the platform, the |buffer| is always in UTF-8 encoding.
1424 // font - The handle to the font object. (Required)
1425 // buffer - The address of a buffer that receives the font data.
1426 // buflen - Length of the buffer.
1427 // out_buflen - Pointer to variable that will receive the minimum buffer size
1448 // font - the handle to the font object.
1450 // Returns 1 if the font is embedded, 0 if it not, and -1 on failure.
1456 // font - the handle to the font object.
1459 // defined in ISO 32000-1:2008, table 123, -1 on failure.
1465 // font - the handle to the font object.
1467 // Returns the font weight, -1 on failure.
1474 // font - the handle to the font object.
1475 // angle - pointer where the italic angle will be stored
1487 // font - the handle to the font object.
1488 // font_size - the size of the |font|.
1489 // ascent - pointer where the font ascent will be stored
1502 // font - the handle to the font object.
1503 // font_size - the size of the |font|.
1504 // descent - pointer where the font descent will be stored
1517 // font - the handle to the font object.
1518 // glyph - the glyph.
1519 // font_size - the size of the font.
1520 // width - pointer where the glyph width will be stored
1534 // font - the handle to the font object.
1535 // glyph - the glyph being drawn.
1536 // font_size - the size of the font.
1546 // glyphpath - handle to a glyph path.
1548 // Returns the number of objects in |glyphpath| or -1 on failure.
1553 // Get segment in glyphpath at index.
1555 // glyphpath - handle to a glyph path.
1556 // index - the index of a segment.
1560 FPDFGlyphPath_GetGlyphPathSegment(FPDF_GLYPHPATH glyphpath, int index);
1562 // Get number of page objects inside |form_object|.
1564 // form_object - handle to a form object.
1566 // Returns the number of objects in |form_object| on success, -1 on error.
1570 // Get page object in |form_object| at |index|.
1572 // form_object - handle to a form object.
1573 // index - the 0-based index of a page object.
1575 // Returns the handle to the page object, or NULL on error.
1577 FPDFFormObj_GetObject(FPDF_PAGEOBJECT form_object, unsigned long index);