OLD | NEW |
1 // Copyright 2014 PDFium Authors. All rights reserved. | 1 // Copyright 2014 PDFium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com | 5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com |
6 | 6 |
7 #ifndef PUBLIC_FPDF_TEXT_H_ | 7 #ifndef PUBLIC_FPDF_TEXT_H_ |
8 #define PUBLIC_FPDF_TEXT_H_ | 8 #define PUBLIC_FPDF_TEXT_H_ |
9 | 9 |
10 #include "fpdfview.h" | 10 #include "fpdfview.h" |
(...skipping 333 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
344 // Return Value: | 344 // Return Value: |
345 // Number of detected web links. | 345 // Number of detected web links. |
346 // | 346 // |
347 DLLEXPORT int STDCALL FPDFLink_CountWebLinks(FPDF_PAGELINK link_page); | 347 DLLEXPORT int STDCALL FPDFLink_CountWebLinks(FPDF_PAGELINK link_page); |
348 | 348 |
349 // Function: FPDFLink_GetURL | 349 // Function: FPDFLink_GetURL |
350 // Fetch the URL information for a detected web link. | 350 // Fetch the URL information for a detected web link. |
351 // Parameters: | 351 // Parameters: |
352 // link_page - Handle returned by FPDFLink_LoadWebLinks. | 352 // link_page - Handle returned by FPDFLink_LoadWebLinks. |
353 // link_index - Zero-based index for the link. | 353 // link_index - Zero-based index for the link. |
354 // buffer - A unicode buffer. | 354 // buffer - A unicode buffer for the result. |
355 // buflen - Number of characters (not bytes) for the buffer, | 355 // buflen - Number of characters (not bytes) for the buffer, |
356 // including an additional terminator. | 356 // including an additional terminator. |
357 // Return Value: | 357 // Return Value: |
358 // If buffer is NULL or buflen is zero, return number of characters | 358 // If |buffer| is NULL or |buflen| is zero, return the number of |
359 // (not bytes and an additional terminator is also counted) needed, | 359 // characters (not bytes) needed to buffer the result (an additional |
360 // otherwise, return number of characters copied into the buffer. | 360 // terminator is included in this count). |
| 361 // Otherwise, copy the result into |buffer|, truncating at |buflen| if |
| 362 // the result is too large to fit, and return the number of characters |
| 363 // actually copied into the buffer (the additional terminator is also |
| 364 // included in this count). |
| 365 // If |link_index| does not correspond to a valid link, then the result |
| 366 // is an empty string. |
361 // | 367 // |
362 DLLEXPORT int STDCALL FPDFLink_GetURL(FPDF_PAGELINK link_page, | 368 DLLEXPORT int STDCALL FPDFLink_GetURL(FPDF_PAGELINK link_page, |
363 int link_index, | 369 int link_index, |
364 unsigned short* buffer, | 370 unsigned short* buffer, |
365 int buflen); | 371 int buflen); |
366 | 372 |
367 // Function: FPDFLink_CountRects | 373 // Function: FPDFLink_CountRects |
368 // Count number of rectangular areas for the link. | 374 // Count number of rectangular areas for the link. |
369 // Parameters: | 375 // Parameters: |
370 // link_page - Handle returned by FPDFLink_LoadWebLinks. | 376 // link_page - Handle returned by FPDFLink_LoadWebLinks. |
371 // link_index - Zero-based index for the link. | 377 // link_index - Zero-based index for the link. |
372 // Return Value: | 378 // Return Value: |
373 // Number of rectangular areas for the link. | 379 // Number of rectangular areas for the link. If |link_index| does |
| 380 // not correspond to a valid link, then 0 is returned. |
374 // | 381 // |
375 DLLEXPORT int STDCALL FPDFLink_CountRects(FPDF_PAGELINK link_page, | 382 DLLEXPORT int STDCALL FPDFLink_CountRects(FPDF_PAGELINK link_page, |
376 int link_index); | 383 int link_index); |
377 | 384 |
378 // Function: FPDFLink_GetRect | 385 // Function: FPDFLink_GetRect |
379 // Fetch the boundaries of a rectangle for a link. | 386 // Fetch the boundaries of a rectangle for a link. |
380 // Parameters: | 387 // Parameters: |
381 // link_page - Handle returned by FPDFLink_LoadWebLinks. | 388 // link_page - Handle returned by FPDFLink_LoadWebLinks. |
382 // link_index - Zero-based index for the link. | 389 // link_index - Zero-based index for the link. |
383 // rect_index - Zero-based index for a rectangle. | 390 // rect_index - Zero-based index for a rectangle. |
384 // left - Pointer to a double value receiving the rectangle | 391 // left - Pointer to a double value receiving the rectangle |
385 // left boundary. | 392 // left boundary. |
386 // top - Pointer to a double value receiving the rectangle | 393 // top - Pointer to a double value receiving the rectangle |
387 // top boundary. | 394 // top boundary. |
388 // right - Pointer to a double value receiving the rectangle | 395 // right - Pointer to a double value receiving the rectangle |
389 // right boundary. | 396 // right boundary. |
390 // bottom - Pointer to a double value receiving the rectangle | 397 // bottom - Pointer to a double value receiving the rectangle |
391 // bottom boundary. | 398 // bottom boundary. |
392 // Return Value: | 399 // Return Value: |
393 // None. | 400 // None. If |link_index| does not correspond to a valid link, then |
| 401 // |left|, |top|, |right|, and |bottom| remain unmodified. |
394 // | 402 // |
395 DLLEXPORT void STDCALL FPDFLink_GetRect(FPDF_PAGELINK link_page, | 403 DLLEXPORT void STDCALL FPDFLink_GetRect(FPDF_PAGELINK link_page, |
396 int link_index, | 404 int link_index, |
397 int rect_index, | 405 int rect_index, |
398 double* left, | 406 double* left, |
399 double* top, | 407 double* top, |
400 double* right, | 408 double* right, |
401 double* bottom); | 409 double* bottom); |
402 | 410 |
403 // Function: FPDFLink_CloseWebLinks | 411 // Function: FPDFLink_CloseWebLinks |
404 // Release resources used by weblink feature. | 412 // Release resources used by weblink feature. |
405 // Parameters: | 413 // Parameters: |
406 // link_page - Handle returned by FPDFLink_LoadWebLinks. | 414 // link_page - Handle returned by FPDFLink_LoadWebLinks. |
407 // Return Value: | 415 // Return Value: |
408 // None. | 416 // None. |
409 // | 417 // |
410 DLLEXPORT void STDCALL FPDFLink_CloseWebLinks(FPDF_PAGELINK link_page); | 418 DLLEXPORT void STDCALL FPDFLink_CloseWebLinks(FPDF_PAGELINK link_page); |
411 | 419 |
412 #ifdef __cplusplus | 420 #ifdef __cplusplus |
413 } | 421 } |
414 #endif | 422 #endif |
415 | 423 |
416 #endif // PUBLIC_FPDF_TEXT_H_ | 424 #endif // PUBLIC_FPDF_TEXT_H_ |
OLD | NEW |