Lines Matching +full:index +full:- +full:page
2 // Use of this source code is governed by a BSD-style license that can be
10 // clang-format off
20 // Prepare information about all characters in a page.
22 // page - Handle to the page. Returned by FPDF_LoadPage function
25 // A handle to the text page information structure.
28 // Application must call FPDFText_ClosePage to release the text page
31 FPDF_EXPORT FPDF_TEXTPAGE FPDF_CALLCONV FPDFText_LoadPage(FPDF_PAGE page);
34 // Release all resources allocated for a text page information
37 // text_page - Handle to a text page information structure.
45 // Get number of characters in a page.
47 // text_page - Handle to a text page information structure.
50 // Number of characters in the page. Return -1 for error.
54 // Characters in a page form a "stream", inside the stream, each
55 // character has an index.
56 // We will use the index parameters in many of FPDFTEXT functions. The
57 // first character in the page
58 // has an index value of zero.
63 // Get Unicode of a character in a page.
65 // text_page - Handle to a text page information structure.
67 // index - Zero-based index of the character.
75 FPDFText_GetUnicode(FPDF_TEXTPAGE text_page, int index);
81 // text_page - Handle to a text page information structure.
83 // index - Zero-based index of the character.
85 // The associated text object for the character at |index|, or NULL on
86 // error. The returned text object, if non-null, is of type
90 FPDFText_GetTextObject(FPDF_TEXTPAGE text_page, int index);
94 // Get if a character in a page is generated by PDFium.
96 // text_page - Handle to a text page information structure.
98 // index - Zero-based index of the character.
102 // -1 if there was an error.
105 FPDFText_IsGenerated(FPDF_TEXTPAGE text_page, int index);
109 // Get if a character in a page is a hyphen.
111 // text_page - Handle to a text page information structure.
113 // index - Zero-based index of the character.
117 // -1 if there was an error.
120 FPDFText_IsHyphen(FPDF_TEXTPAGE text_page, int index);
124 // Get if a character in a page has an invalid unicode mapping.
126 // text_page - Handle to a text page information structure.
128 // index - Zero-based index of the character.
132 // -1 if there was an error.
135 FPDFText_HasUnicodeMapError(FPDF_TEXTPAGE text_page, int index);
140 // text_page - Handle to a text page information structure.
142 // index - Zero-based index of the character.
149 int index);
155 // text_page - Handle to a text page information structure.
157 // index - Zero-based index of the character.
158 // buffer - A buffer receiving the font name.
159 // buflen - The length of |buffer| in bytes.
160 // flags - Optional pointer to an int receiving the font flags.
167 // set to the font flags. |buffer| is in UTF-8 encoding. Return 0 on
172 int index,
181 // text_page - Handle to a text page information structure.
183 // index - Zero-based index of the character.
186 // |text_page| is invalid, if |index| is out of bounds, or if the
187 // character's text object is undefined, return -1.
190 int index);
196 // text_page - Handle to a text page information structure.
198 // index - Zero-based index of the character.
199 // R - Pointer to an unsigned int number receiving the
201 // G - Pointer to an unsigned int number receiving the
203 // B - Pointer to an unsigned int number receiving the
205 // A - Pointer to an unsigned int number receiving the
213 int index,
223 // text_page - Handle to a text page information structure.
225 // index - Zero-based index of the character.
226 // R - Pointer to an unsigned int number receiving the
228 // G - Pointer to an unsigned int number receiving the
230 // B - Pointer to an unsigned int number receiving the
232 // A - Pointer to an unsigned int number receiving the
240 int index,
250 // text_page - Handle to a text page information structure.
252 // index - Zero-based index of the character.
255 // greater or equal to 0. If |text_page| is invalid, or if |index| is
256 // out of bounds, then return -1.
259 int index);
264 // text_page - Handle to a text page information structure.
266 // index - Zero-based index of the character.
267 // left - Pointer to a double number receiving left position
269 // right - Pointer to a double number receiving right position
271 // bottom - Pointer to a double number receiving bottom position
273 // top - Pointer to a double number receiving top position of
277 // |top|. If |text_page| is invalid, or if |index| is out of bounds,
283 int index,
295 // text_page - Handle to a text page information structure.
297 // index - Zero-based index of the character.
298 // rect - Pointer to a FS_RECTF receiving the character box.
301 // invalid, or if |index| is out of bounds, then return FALSE, and the
307 FPDFText_GetLooseCharBox(FPDF_TEXTPAGE text_page, int index, FS_RECTF* rect);
313 // text_page - Handle to a text page information structure.
315 // index - Zero-based index of the character.
316 // matrix - Pointer to a FS_MATRIX receiving the transformation
320 // invalid, or if |index| is out of bounds, or if |matrix| is NULL,
324 int index,
330 // text_page - Handle to a text page information structure.
332 // index - Zero-based index of the character.
333 // x - Pointer to a double number receiving x coordinate of
335 // y - Pointer to a double number receiving y coordinate of
344 int index,
349 // Get the index of a character at or nearby a certain position on the
350 // page.
352 // text_page - Handle to a text page information structure.
354 // x - X position in PDF "user space".
355 // y - Y position in PDF "user space".
356 // xTolerance - An x-axis tolerance value for character hit
358 // yTolerance - A y-axis tolerance value for character hit
361 // The zero-based index of the character at, or nearby the point (x,y).
363 // be -1. If an error occurs, -3 will be returned.
373 // Extract unicode text string from the page.
375 // text_page - Handle to a text page information structure.
377 // start_index - Index for the start characters.
378 // count - Number of UCS-2 values to be extracted.
379 // result - A buffer (allocated by application) receiving the
380 // extracted UCS-2 values. The buffer must be able to
381 // hold `count` UCS-2 values plus a terminator.
386 // This function ignores characters without UCS-2 representations.
387 // It considers all characters on the page, even those that are not
388 // visible when the page has a cropbox. To filter out the characters
401 // text_page - Handle to a text page information structure.
403 // start_index - Index for the start character.
404 // count - Number of characters, or -1 for all remaining.
406 // Number of rectangles, 0 if text_page is null, or -1 on bad
410 // applications to detect the position on the page for a text segment,
423 // text_page - Handle to a text page information structure.
425 // rect_index - Zero-based index for the rectangle.
426 // left - Pointer to a double value receiving the rectangle
428 // top - Pointer to a double value receiving the rectangle
430 // right - Pointer to a double value receiving the rectangle
432 // bottom - Pointer to a double value receiving the rectangle
449 // Extract unicode text within a rectangular boundary on the page.
451 // text_page - Handle to a text page information structure.
453 // left - Left boundary.
454 // top - Top boundary.
455 // right - Right boundary.
456 // bottom - Bottom boundary.
457 // buffer - Caller-allocated buffer to receive UTF-16 values.
458 // buflen - Number of UTF-16 values (not bytes) that `buffer`
461 // If buffer is NULL or buflen is zero, return number of UTF-16
465 // provided if space is available. Otherwise, return number of UTF-16
492 // text_page - Handle to a text page information structure.
494 // findwhat - A unicode match pattern.
495 // flags - Option flags.
496 // start_index - Start from this character. -1 for end of the page.
508 // Search in the direction from page start to end.
510 // handle - A search context handle returned by
518 // Search in the direction from page end to start.
520 // handle - A search context handle returned by
528 // Get the starting character index of the search result.
530 // handle - A search context handle returned by
533 // Index for the starting character.
540 // handle - A search context handle returned by
550 // handle - A search context handle returned by
558 // Prepare information about weblinks in a page.
560 // text_page - Handle to a text page information structure.
563 // A handle to the page's links information structure, or
569 // automatically detecting links in the page contents. For example,
582 // link_page - Handle returned by FPDFLink_LoadWebLinks.
591 // link_page - Handle returned by FPDFLink_LoadWebLinks.
592 // link_index - Zero-based index for the link.
593 // buffer - A unicode buffer for the result.
594 // buflen - Number of 16-bit code units (not bytes) for the
597 // If |buffer| is NULL or |buflen| is zero, return the number of 16-bit
601 // the result is too large to fit, and return the number of 16-bit code
615 // link_page - Handle returned by FPDFLink_LoadWebLinks.
616 // link_index - Zero-based index for the link.
627 // link_page - Handle returned by FPDFLink_LoadWebLinks.
628 // link_index - Zero-based index for the link.
629 // rect_index - Zero-based index for a rectangle.
630 // left - Pointer to a double value receiving the rectangle
632 // top - Pointer to a double value receiving the rectangle
634 // right - Pointer to a double value receiving the rectangle
636 // bottom - Pointer to a double value receiving the rectangle
654 // Fetch the start char index and char count for a link.
656 // link_page - Handle returned by FPDFLink_LoadWebLinks.
657 // link_index - Zero-based index for the link.
658 // start_char_index - pointer to int receiving the start char index
659 // char_count - pointer to int receiving the char count
675 // link_page - Handle returned by FPDFLink_LoadWebLinks.