hpdf 2.0.8-mswin32
Sign up to get free protection for your applications and to get access to all the features.
- data/History +57 -0
- data/License +25 -0
- data/README +136 -0
- data/docs/annotation_handling.html +503 -0
- data/docs/api.css +115 -0
- data/docs/api_reference.html +112 -0
- data/docs/bindings.html +242 -0
- data/docs/compile_your_program.html +365 -0
- data/docs/default.css +115 -0
- data/docs/destination_handling.html +620 -0
- data/docs/document_handling.html +4751 -0
- data/docs/documentation.html +110 -0
- data/docs/encoder_handling.html +428 -0
- data/docs/error_handling.html +1609 -0
- data/docs/examples.html +702 -0
- data/docs/ext_gstate.html +407 -0
- data/docs/font_handling.html +669 -0
- data/docs/fonts.html +978 -0
- data/docs/graphics.html +1210 -0
- data/docs/handles.html +204 -0
- data/docs/how_to_use.html +371 -0
- data/docs/image/Thumbs.db +0 -0
- data/docs/image/character_map.png +0 -0
- data/docs/image/encoding_list.png +0 -0
- data/docs/image/extgtate.png +0 -0
- data/docs/image/figure1.png +0 -0
- data/docs/image/figure10.png +0 -0
- data/docs/image/figure11.png +0 -0
- data/docs/image/figure12.png +0 -0
- data/docs/image/figure13.png +0 -0
- data/docs/image/figure14.png +0 -0
- data/docs/image/figure15.png +0 -0
- data/docs/image/figure16.png +0 -0
- data/docs/image/figure17.png +0 -0
- data/docs/image/figure18.png +0 -0
- data/docs/image/figure19.png +0 -0
- data/docs/image/figure2.png +0 -0
- data/docs/image/figure20.png +0 -0
- data/docs/image/figure21.png +0 -0
- data/docs/image/figure22.png +0 -0
- data/docs/image/figure23.png +0 -0
- data/docs/image/figure24.png +0 -0
- data/docs/image/figure25.png +0 -0
- data/docs/image/figure26.png +0 -0
- data/docs/image/figure27.png +0 -0
- data/docs/image/figure28.png +0 -0
- data/docs/image/figure3.png +0 -0
- data/docs/image/figure4.png +0 -0
- data/docs/image/figure5.png +0 -0
- data/docs/image/figure6.png +0 -0
- data/docs/image/figure7.png +0 -0
- data/docs/image/figure8.png +0 -0
- data/docs/image/figure9.png +0 -0
- data/docs/image/font_demo.png +0 -0
- data/docs/image/harulogo.png +0 -0
- data/docs/image/image_demo.png +0 -0
- data/docs/image/jpfont_demo.png +0 -0
- data/docs/image/line_demo.png +0 -0
- data/docs/image/png_demo.png +0 -0
- data/docs/image/text_annot.png +0 -0
- data/docs/image/text_demo.png +0 -0
- data/docs/image/text_demo2.png +0 -0
- data/docs/image/tt_font.png +0 -0
- data/docs/image_handling.html +505 -0
- data/docs/index.html +305 -0
- data/docs/install.html +243 -0
- data/docs/outline_handling.html +229 -0
- data/docs/page_handling.html +2647 -0
- data/docs/page_operator.html +2640 -0
- data/docs/useful_links.html +203 -0
- data/examples/arc_demo.rb +82 -0
- data/examples/demo.rb +91 -0
- data/examples/encryption.rb +41 -0
- data/examples/ext_gstater_demo.rb +171 -0
- data/examples/font_demo.rb +67 -0
- data/examples/jpfont_demo.rb +122 -0
- data/examples/line_demo.rb +301 -0
- data/examples/slide_show_demo.rb +139 -0
- data/examples/text_demo2.rb +189 -0
- data/examples/ttfont_demo.rb +106 -0
- data/lib/hpdf.so +0 -0
- data/tests/arc_demo.rb +82 -0
- data/tests/demo.rb +91 -0
- data/tests/encryption.rb +41 -0
- data/tests/ext_gstater_demo.rb +171 -0
- data/tests/font_demo.rb +67 -0
- data/tests/line_demo.rb +301 -0
- data/tests/slide_show_demo.rb +139 -0
- data/tests/test_all_examples.rb +31 -0
- data/tests/text_demo2.rb +189 -0
- metadata +137 -0
data/History
ADDED
@@ -0,0 +1,57 @@
|
|
1
|
+
== version 2.0.8 2006.11.25
|
2
|
+
*fixed a problem of HPDF_Circle() which causes buffer overflow.
|
3
|
+
*added HPDF_Ellipse().
|
4
|
+
|
5
|
+
== version 2.0.7 2006.11.05
|
6
|
+
*fixed a bug of HPDF_Annotation_New() (the values of bottom and top are set
|
7
|
+
upside down).
|
8
|
+
*added HPDF_Page_GetCurrentPos2(), HPDF_Page_GetCurrentTextPos2() and
|
9
|
+
HPDF_Image_GetSize2().
|
10
|
+
|
11
|
+
== version 2.0.6 2006.10.16
|
12
|
+
*added opacity and blend-mode featurs.
|
13
|
+
*added slide-show functions (contributed by Adrian Nelson).
|
14
|
+
*added an interface for VB6 (contributed by Ko, Chi-Chih).
|
15
|
+
*fixed a bug that HPDF_MemStream_Rewrite() may cause segmentation fault.
|
16
|
+
*fixed a bug of error checking of HPDF_Page_Concat().
|
17
|
+
*fixed a bug of calculation for the position of text showing.
|
18
|
+
|
19
|
+
== version 2.0.5 2006.09.20
|
20
|
+
*fixed a bug that an image which loaded by HPDF_LoadRawImageFromFile() or
|
21
|
+
HPDF_LoadRawImageFromMem() is not compressed.
|
22
|
+
*added C# interface.
|
23
|
+
*added viewer-preference feature.
|
24
|
+
*fixed a bug that HPDF_SetPassword does not raise error when NULL string set
|
25
|
+
to owner-password.
|
26
|
+
*fixed a bug that causes program crash when using interlaced PNG images.
|
27
|
+
|
28
|
+
== version 2.0.4 2006.08.25
|
29
|
+
*fixed a bug of the TrueType font feature related to composit glyph.
|
30
|
+
|
31
|
+
== version 2.0.3 2006.08.20
|
32
|
+
*fixed a bug that HPDF_Page_TextRect() always returns
|
33
|
+
HPDF_PAGE_INSUFFICIENT_SPACE.
|
34
|
+
*added delayed loading function for a png image (HPDF_LoadPngImageFromFile2).
|
35
|
+
*change HPDF_SaveToStream function.
|
36
|
+
*correct hpdf_ttfontdef.c to avoid warning from a compiler.
|
37
|
+
|
38
|
+
== version 2.0.2
|
39
|
+
*modified HPDF_Page_ShowTextNextLine() to invoking HPDF_Page_MoveToNextLine()
|
40
|
+
if it is invoked with null or zero-length text.
|
41
|
+
*fixed a bug in which HPDF_Page_MeasureText() returns wrong value when using
|
42
|
+
CID fonts.
|
43
|
+
*changed the feature of HPDF_Page_MeasureText().
|
44
|
+
*added Japanese word wrap feature to HPDF_Page_MeasureText() and
|
45
|
+
HPDF_Page_TextRect().
|
46
|
+
*fixed typos of HPDF_PageLayout values.
|
47
|
+
*modified options of makefile for BCC32 to multi-thread.
|
48
|
+
rebuild libz.a, libpng.a for BCC32 with -WM option.
|
49
|
+
|
50
|
+
== version 2.0.1a 2006-08-03
|
51
|
+
*fixed a bug that HPDFPage::draw_image does not work correctly. (Ruby module
|
52
|
+
only.)
|
53
|
+
|
54
|
+
== version 2.0.1 2006-07-29
|
55
|
+
*fixed a bug that HPDF_TextRect() does not work correctly when using CID fonts.
|
56
|
+
*added HPDF_Font_GetAscent(), HPDF_Font_GetDescent(), HPDF_Font_GetXHeight(),
|
57
|
+
HPDF_Font_GetCapHeight().
|
data/License
ADDED
@@ -0,0 +1,25 @@
|
|
1
|
+
*
|
2
|
+
* License
|
3
|
+
*
|
4
|
+
Haru is distributed under the ZLIB/LIBPNG License. Because ZLIB/LIBPNG License
|
5
|
+
is one of the freest licenses, You can use Haru for various purposes.
|
6
|
+
|
7
|
+
The license of Haru is as follows.
|
8
|
+
|
9
|
+
Copyright (C) 1999-2006 Takeshi Kanno
|
10
|
+
This software is provided 'as-is', without any express or implied warranty.
|
11
|
+
|
12
|
+
In no event will the authors be held liable for any damages arising from the
|
13
|
+
use of this software.
|
14
|
+
|
15
|
+
Permission is granted to anyone to use this software for any purpose,including
|
16
|
+
commercial applications, and to alter it and redistribute it freely, subject
|
17
|
+
to the following restrictions:
|
18
|
+
|
19
|
+
1. The origin of this software must not be misrepresented; you must not claim
|
20
|
+
that you wrote the original software. If you use this software in a
|
21
|
+
product, an acknowledgment in the product documentation would be
|
22
|
+
appreciated but is not required.
|
23
|
+
2. Altered source versions must be plainly marked as such, and must not be
|
24
|
+
misrepresented as being the original software.
|
25
|
+
3. This notice may not be removed or altered from any source distribution.
|
data/README
ADDED
@@ -0,0 +1,136 @@
|
|
1
|
+
===============================================================================
|
2
|
+
# Haru Free PDF Library Version 2.0.8 - Nov 25, 2006
|
3
|
+
|
4
|
+
This gem has been packaged by Emmanuel Oga, EmmanuelOga.blogspot.com
|
5
|
+
|
6
|
+
I followed the instructions in the libharu_2_x_x_ruby_win32.zip package:
|
7
|
+
|
8
|
+
...libharu_2_x_x_ruby_win32.zip is a binary package of interface module
|
9
|
+
for Ruby on windows. This package includes hpdf.so
|
10
|
+
(a module file for ruby) and sample programs.
|
11
|
+
|
12
|
+
Unpack libharu_x_x_x_ruby_win32.zip and copy hpdf.so to
|
13
|
+
"site_ruby/X.X/i386-msvcrt" directory manually.
|
14
|
+
|
15
|
+
That's all!!! Then, i "gemified" that module and included the sample code.
|
16
|
+
Original readme follows:
|
17
|
+
|
18
|
+
===============================================================================
|
19
|
+
|
20
|
+
# Haru Free PDF Library Version 2.0.8 - Nov 25, 2006
|
21
|
+
#
|
22
|
+
# URL http://libharu.sourceforge.net/
|
23
|
+
#
|
24
|
+
# Copyright 2000-2006 (c) Takeshi Kanno
|
25
|
+
#
|
26
|
+
|
27
|
+
See INSTALL for instructions on how to install libpng.
|
28
|
+
|
29
|
+
*
|
30
|
+
* What is Haru Free PDF Library?
|
31
|
+
*
|
32
|
+
Haru is a free, cross platform, open-sourced software library for generating
|
33
|
+
PDF. It supports the following features.
|
34
|
+
|
35
|
+
1. Generating PDF files with lines, text, images.
|
36
|
+
2. Outline, text annotation, link annotation.
|
37
|
+
3. Compressing document with deflate-decode.
|
38
|
+
4. Embedding PNG, Jpeg images.
|
39
|
+
5. Embedding Type1 font and TrueType font.
|
40
|
+
6. Creating encrypted PDF files.
|
41
|
+
7. Using various character set (ISO8859-1~16, MSCP1250~8, KOI-8R).
|
42
|
+
8. Supporting CJK fonts and encodings.
|
43
|
+
|
44
|
+
You can add the feature of PDF creation by using Haru without understanding
|
45
|
+
complicated internal structure of PDF.
|
46
|
+
|
47
|
+
*
|
48
|
+
* The differences from the previous version
|
49
|
+
*
|
50
|
+
|
51
|
+
The biggest differences are that all code is written in C.
|
52
|
+
To our regret, because internal structures changed greatly, The API is not
|
53
|
+
compatible with previous version.
|
54
|
+
|
55
|
+
However, the new-version has the following advantages compared with the
|
56
|
+
previous version.
|
57
|
+
|
58
|
+
1. Supported shared-library build.
|
59
|
+
A new-version library is able to be built as shared-library.
|
60
|
+
2. The performance has been greatly improved.
|
61
|
+
A new-version library is about 4-15 times faster than a previous version.
|
62
|
+
3. Supported more features.
|
63
|
+
TrueType font, 128 bit encryption, arc function, and so on.
|
64
|
+
|
65
|
+
*
|
66
|
+
* Supporting platforms
|
67
|
+
*
|
68
|
+
Haru is written in ANSI-C and should compile easily with any compliant C
|
69
|
+
compiler.
|
70
|
+
I inspected Haru in the following environment and make files for these
|
71
|
+
environments are included in a package.
|
72
|
+
|
73
|
+
1. Cygwin + GCC (Microsoft Windows)
|
74
|
+
2. Cygwin + MinGW (Microsoft Windows)
|
75
|
+
3. MSYS + MinGW (Microsoft Windows)
|
76
|
+
3. Microsoft VC++ (Microsoft Windows)
|
77
|
+
4. Borland C++ (Microsoft Windows)
|
78
|
+
5. GCC (Linux, FreeBSD, NetBSD, Solaris...)
|
79
|
+
|
80
|
+
Also on platforms except the above, it is easy to build HARU. If you success to build HARU on other platforms, please send makefile to me.
|
81
|
+
In addition, ZLIB and PNGLIB are required when you want to use the features of
|
82
|
+
compression and embedding PNG images. (In the case of Windows, static library
|
83
|
+
files for several compilers are included in the package for WIndows. In the
|
84
|
+
case of most of UNIX, these libraries are usually installed.)
|
85
|
+
|
86
|
+
*
|
87
|
+
* Available development environment
|
88
|
+
*
|
89
|
+
Haru can work as both static-library (.a, .lib) and shared-library (.so, .dll).
|
90
|
+
When you use it as static-library, It can be used by C and a C++.
|
91
|
+
But when you use it as shared-library, it can be used by many development
|
92
|
+
languages which support shared library.
|
93
|
+
So far, Haru provides bindings for Ruby, Delphi/Free Pascal and C#.
|
94
|
+
|
95
|
+
If you write bindings for other programing languages, please notice me!
|
96
|
+
|
97
|
+
*
|
98
|
+
* Runtime environment of programs using Haru
|
99
|
+
*
|
100
|
+
1. static-library
|
101
|
+
No runtime files are required.
|
102
|
+
|
103
|
+
2. shared-library
|
104
|
+
In Windows, you have to distribute libhpdf.dll with a program. In UNIX you
|
105
|
+
have to distribute libhpdf.so* with a program.
|
106
|
+
|
107
|
+
NOTE:
|
108
|
+
In the UNIX environment, there are the cases that libz.so, libpng.so.x are
|
109
|
+
necessary. About this, please refer to the documentation of PNGLIB and ZLIB.
|
110
|
+
|
111
|
+
*
|
112
|
+
* Acknowledgment
|
113
|
+
*
|
114
|
+
1. Information-technology Promotion Agency(IPA)
|
115
|
+
The development of Haru has been supported by Exploratory Software Project
|
116
|
+
of Information-technology Promotion Agency(IPA), Japan.
|
117
|
+
|
118
|
+
2. All users of libHaru.
|
119
|
+
We wish to thank all users of Haru.
|
120
|
+
In particular, we thank Thomas Nimstad, LeslieM, Par Hogberg, adenelson,
|
121
|
+
Riccardo Cohen, sea_sbs, Andrew.
|
122
|
+
They gave me very useful advices.
|
123
|
+
|
124
|
+
3. Sourceforge.net
|
125
|
+
We would like to thank sourceForge.net for project hosting.
|
126
|
+
|
127
|
+
4. Adobe Systems Inc.
|
128
|
+
We thank Adobe Systems Inc. for publishing PDF specification.
|
129
|
+
|
130
|
+
|
131
|
+
TODO - todo for libharu
|
132
|
+
|
133
|
+
* Vertical writing support of HPDF_TextRect()
|
134
|
+
* Correct a code which uses implicit type conversion and causes warnings.
|
135
|
+
* Form desiner.
|
136
|
+
|
@@ -0,0 +1,503 @@
|
|
1
|
+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3c.org/TR/1999/REC-html401-19991224/loose.dtd">
|
2
|
+
<html lang="en">
|
3
|
+
<head>
|
4
|
+
<title>Haru Free PDF Library</title>
|
5
|
+
<meta http-equiv="Content-Type"
|
6
|
+
content="text/html; charset=iso-8859-1">
|
7
|
+
<link href="api.css" type="text/css" rel="stylesheet">
|
8
|
+
</head>
|
9
|
+
<body>
|
10
|
+
<div id="headcontainer">
|
11
|
+
<div class="head"><img alt="Haru Free PDF Library"
|
12
|
+
src="image/harulogo.png" style="width: 413px; height: 40px;"></div>
|
13
|
+
</div>
|
14
|
+
<div id="barcontainer">
|
15
|
+
<div class="buildbar"><a href="index.html">home</a> | <a
|
16
|
+
href="http://sourceforge.net/project/showfiles.php?group_id=83044">download</a>
|
17
|
+
|
|
18
|
+
<a href="documentation.html">documentation</a> | <a
|
19
|
+
href="examples.html">examples </a>| <a
|
20
|
+
href="http://sourceforge.net/projects/libharu/">sourceforge</a> |
|
21
|
+
<a href="http://sourceforge.net/forum/?group_id=83044">forums</a><br>
|
22
|
+
</div>
|
23
|
+
</div>
|
24
|
+
<div id="container">
|
25
|
+
<div id="mainpage">
|
26
|
+
<div id="ccol">
|
27
|
+
<h2>Annotation<br>
|
28
|
+
</h2>
|
29
|
+
<h3><a name="HPDF_LinkAnnot_SetHighlightMode_"></a>HPDF_LinkAnnot_SetHighlightMode<br>
|
30
|
+
</h3>
|
31
|
+
<div class="bodytext1">
|
32
|
+
<div class="bodycode2"><span style="font-weight: bold;">#include</span>
|
33
|
+
"apdf.h"<br>
|
34
|
+
<br>
|
35
|
+
HPDF_STATUS<br>
|
36
|
+
HPDF_LinkAnnot_SetHighlightMode
|
37
|
+
(HPDF_Annotation
|
38
|
+
annot,<br>
|
39
|
+
|
40
|
+
HPDF_AnnotHighlightMode mode);<br>
|
41
|
+
<br>
|
42
|
+
</div>
|
43
|
+
<h4>Description<br>
|
44
|
+
</h4>
|
45
|
+
HPDF_LinkAnnot_SetHighlightMode() defined the appearance of when a
|
46
|
+
mouse clicked on a link annotation. (see <a
|
47
|
+
href="examples.html#text_annotation.c_link_annotation.c_">example
|
48
|
+
program of link annotation</a>)<br>
|
49
|
+
<br>
|
50
|
+
<h4>Parameter</h4>
|
51
|
+
<span style="font-weight: bold;">annot</span>
|
52
|
+
<div class="bodytext5">The handle of an annotation object.<br>
|
53
|
+
<br>
|
54
|
+
</div>
|
55
|
+
<span style="font-weight: bold;">mode</span>
|
56
|
+
<div class="bodytext5">The following valued are available.<br>
|
57
|
+
<table style="width: 100%; text-align: left;" border="1" cellpadding="1"
|
58
|
+
cellspacing="1">
|
59
|
+
<tbody>
|
60
|
+
<tr>
|
61
|
+
<td
|
62
|
+
style="vertical-align: top; width: 28px; text-align: right; background-color: rgb(204, 204, 204);"><br>
|
63
|
+
</td>
|
64
|
+
<td
|
65
|
+
style="vertical-align: top; background-color: rgb(204, 204, 204);">VALUE<br>
|
66
|
+
</td>
|
67
|
+
<td
|
68
|
+
style="vertical-align: top; background-color: rgb(204, 204, 204);">DESCRIPTION<br>
|
69
|
+
</td>
|
70
|
+
</tr>
|
71
|
+
<tr>
|
72
|
+
<td style="vertical-align: top; width: 28px; text-align: right;">1<br>
|
73
|
+
</td>
|
74
|
+
<td style="vertical-align: top;">HPDF_ANNOT_NO_HIGHTLIGHT<br>
|
75
|
+
</td>
|
76
|
+
<td style="vertical-align: top;">No highlighting.<br>
|
77
|
+
</td>
|
78
|
+
</tr>
|
79
|
+
<tr>
|
80
|
+
<td style="vertical-align: top; width: 28px; text-align: right;">2<br>
|
81
|
+
</td>
|
82
|
+
<td style="vertical-align: top;">HPDF_ANNOT_INVERT_BOX<br>
|
83
|
+
</td>
|
84
|
+
<td style="vertical-align: top;">Invert the contents of the area
|
85
|
+
of annotation.<br>
|
86
|
+
</td>
|
87
|
+
</tr>
|
88
|
+
<tr>
|
89
|
+
<td style="vertical-align: top; width: 28px; text-align: right;">3<br>
|
90
|
+
</td>
|
91
|
+
<td style="vertical-align: top;">HPDF_ANNOT_INVERT_BORDER<br>
|
92
|
+
</td>
|
93
|
+
<td style="vertical-align: top;">Invert the annotation’s border.<br>
|
94
|
+
</td>
|
95
|
+
</tr>
|
96
|
+
<tr>
|
97
|
+
<td style="vertical-align: top; width: 28px; text-align: right;">4<br>
|
98
|
+
</td>
|
99
|
+
<td style="vertical-align: top;">HPDF_ANNOT_DOWN_APPEARANCE<br>
|
100
|
+
</td>
|
101
|
+
<td style="vertical-align: top;">Dent the annotation.<br>
|
102
|
+
</td>
|
103
|
+
</tr>
|
104
|
+
</tbody>
|
105
|
+
</table>
|
106
|
+
<br>
|
107
|
+
</div>
|
108
|
+
<br>
|
109
|
+
<h4>Returns</h4>
|
110
|
+
When HPDF_LinkAnnot_SetHighlightMode() succeeds, it returns HPDF_OK.
|
111
|
+
Otherwise, it
|
112
|
+
returns error-code and error-handler is invoked.<br>
|
113
|
+
<br>
|
114
|
+
<h4>Error</h4>
|
115
|
+
<span style="font-weight: bold;">HPDF_INVALID_ANNOTATION</span>
|
116
|
+
<div class="bodytext5">An invalid annotation handle was set.<br>
|
117
|
+
|
118
|
+
<br>
|
119
|
+
</div>
|
120
|
+
<span style="font-weight: bold;">HPDF_INVALID_PARAMETER<br>
|
121
|
+
</span>
|
122
|
+
<div class="bodytext5">An invalid value was set at either left, top or
|
123
|
+
zoom parameter.<br>
|
124
|
+
<br>
|
125
|
+
</div>
|
126
|
+
<span style="font-weight: bold;">HPDF_FAILD_TO_ALLOC_MEM</span><br>
|
127
|
+
<div class="bodytext5">Memory Allocation Failed.<br>
|
128
|
+
</div>
|
129
|
+
</div>
|
130
|
+
<br>
|
131
|
+
<h3><a name="HPDF_LinkAnnot_SetBorderStyle_"></a>HPDF_LinkAnnot_SetBorderStyle<br>
|
132
|
+
</h3>
|
133
|
+
<div class="bodytext1">
|
134
|
+
<div class="bodycode2"><span style="font-weight: bold;">#include</span>
|
135
|
+
"apdf.h"<br>
|
136
|
+
<br>
|
137
|
+
HPDF_STATUS<br>
|
138
|
+
HPDF_LinkAnnot_SetBorderStyle (HPDF_Annotation annot,<br>
|
139
|
+
|
140
|
+
HPDF_REAL width,<br>
|
141
|
+
|
142
|
+
HPDF_UINT16 dash_on,<br>
|
143
|
+
|
144
|
+
HPDF_UINT16 dash_off);<br>
|
145
|
+
<br>
|
146
|
+
</div>
|
147
|
+
<h4>Description<br>
|
148
|
+
</h4>
|
149
|
+
HPDF_LinkAnnot_SetBorderStyle() defines the style of the annotation's
|
150
|
+
border. <br>
|
151
|
+
<br>
|
152
|
+
<h4>Parameter</h4>
|
153
|
+
<span style="font-weight: bold;">annot</span>
|
154
|
+
<div class="bodytext5">The handle of an annotation object.<br>
|
155
|
+
<br>
|
156
|
+
</div>
|
157
|
+
<span style="font-weight: bold;">width</span><br>
|
158
|
+
<div class="bodytext5">The width of an annotation's border.<br>
|
159
|
+
<br>
|
160
|
+
</div>
|
161
|
+
<span style="font-weight: bold;">dash_on, dash_off</span><br>
|
162
|
+
<div class="bodytext5">The dash style.<br>
|
163
|
+
<br>
|
164
|
+
</div>
|
165
|
+
<br>
|
166
|
+
<h4>Returns</h4>
|
167
|
+
When HPDF_LinkAnnot_SetBorderStyle() succeeds, it returns HPDF_OK.
|
168
|
+
Otherwise, it
|
169
|
+
returns error-code and error-handler is invoked.<br>
|
170
|
+
<br>
|
171
|
+
<h4>Error</h4>
|
172
|
+
<span style="font-weight: bold;">HPDF_INVALID_ANNOTATION<br>
|
173
|
+
</span>
|
174
|
+
<div class="bodytext5">An invalid annotation handle was set.<br>
|
175
|
+
|
176
|
+
<br>
|
177
|
+
</div>
|
178
|
+
<span style="font-weight: bold;">HPDF_INVALID_PARAMETER<br>
|
179
|
+
</span>
|
180
|
+
<div class="bodytext5">An invalid width value was set.<br>
|
181
|
+
|
182
|
+
<br>
|
183
|
+
</div>
|
184
|
+
<span style="font-weight: bold;">HPDF_FAILD_TO_ALLOC_MEM</span>
|
185
|
+
<div class="bodytext5">Memory Allocation Failed.
|
186
|
+
</div>
|
187
|
+
</div>
|
188
|
+
<br>
|
189
|
+
<h3><a name="HPDF_TextAnnot_SetIcon_"></a>HPDF_TextAnnot_SetIcon<br>
|
190
|
+
</h3>
|
191
|
+
<div class="bodytext1">
|
192
|
+
<div class="bodycode2"><span style="font-weight: bold;">#include</span>
|
193
|
+
"apdf.h"<br>
|
194
|
+
<br>
|
195
|
+
HPDF_STATUS<br>
|
196
|
+
HPDF_TextAnnot_SetIcon (HPDF_Annotation annot,<br>
|
197
|
+
|
198
|
+
HPDF_AnnotIcon icon);<br>
|
199
|
+
<br>
|
200
|
+
</div>
|
201
|
+
<h4>Description<br>
|
202
|
+
</h4>
|
203
|
+
HPDF_TextAnnot_SetIcon() defines the style of the annotation's icon.
|
204
|
+
(see <a href="examples.html#text_annotation.c_link_annotation.c_">example
|
205
|
+
program of text annotation</a>) <br>
|
206
|
+
<br>
|
207
|
+
<h4>Parameter</h4>
|
208
|
+
<span style="font-weight: bold;">annot</span>
|
209
|
+
<div class="bodytext5">The handle of an annotation object.<br>
|
210
|
+
<br>
|
211
|
+
</div>
|
212
|
+
<span style="font-weight: bold;">icon</span><br>
|
213
|
+
<div class="bodytext5">The style of icon. The following values are
|
214
|
+
available.
|
215
|
+
<ul>
|
216
|
+
<li>HPDF_ANNOT_ICON_COMMENT</li>
|
217
|
+
<li>HPDF_ANNOT_ICON_KEY</li>
|
218
|
+
<li>HPDF_ANNOT_ICON_NOTE</li>
|
219
|
+
<li>HPDF_ANNOT_ICON_HELP</li>
|
220
|
+
<li>HPDF_ANNOT_ICON_NEW_PARAGRAPH</li>
|
221
|
+
<li>HPDF_ANNOT_ICON_PARAGRAPH</li>
|
222
|
+
<li>HPDF_ANNOT_ICON_INSERT<br>
|
223
|
+
</li>
|
224
|
+
</ul>
|
225
|
+
</div>
|
226
|
+
<h4>Returns</h4>
|
227
|
+
When HPDF_TextAnnot_SetIcon() succeeds, it returns HPDF_OK. Otherwise,
|
228
|
+
it
|
229
|
+
returns error-code and error-handler is invoked.<br>
|
230
|
+
<br>
|
231
|
+
<h4>Error</h4>
|
232
|
+
<span style="font-weight: bold;">HPDF_INVALID_ANNOTATION</span><br>
|
233
|
+
<div class="bodytext5">An invalid annotation handle was set.<br>
|
234
|
+
<br>
|
235
|
+
</div>
|
236
|
+
<span style="font-weight: bold;">HPDF_ANNOT_INVALID_ICON</span><br>
|
237
|
+
<div class="bodytext5">An invalid icon-style was specified.<br>
|
238
|
+
<br>
|
239
|
+
</div>
|
240
|
+
<span style="font-weight: bold;">HPDF_FAILD_TO_ALLOC_MEM</span>
|
241
|
+
<div class="bodytext5">Memory Allocation Failed.
|
242
|
+
</div>
|
243
|
+
</div>
|
244
|
+
<br>
|
245
|
+
<h3><a name="HPDF_TextAnnot_SetOpened_"></a>HPDF_TextAnnot_SetOpened<br>
|
246
|
+
</h3>
|
247
|
+
<div class="bodytext1">
|
248
|
+
<div class="bodycode2"><span style="font-weight: bold;">#include</span>
|
249
|
+
"apdf.h"<br>
|
250
|
+
<br>
|
251
|
+
HPDF_STATUS<br>
|
252
|
+
HPDF_TextAnnot_SetOpened (HPDF_Annotation annot,<br>
|
253
|
+
|
254
|
+
HPDF_BOOL opened);<br>
|
255
|
+
<br>
|
256
|
+
</div>
|
257
|
+
<h4>Description<br>
|
258
|
+
</h4>
|
259
|
+
HPDF_TextAnnot_SetOpened() defines whether the text-annotation is
|
260
|
+
initially displayed open.<br>
|
261
|
+
<br>
|
262
|
+
<h4>Parameter</h4>
|
263
|
+
<span style="font-weight: bold;">annot</span>
|
264
|
+
<div class="bodytext5">The handle of an annotation object.<br>
|
265
|
+
<br>
|
266
|
+
</div>
|
267
|
+
<span style="font-weight: bold;">opened</span><br>
|
268
|
+
<div class="bodytext5">HPDF_TRUE means that the annotation initially
|
269
|
+
displayed open. <br>
|
270
|
+
</div>
|
271
|
+
<h4>Returns</h4>
|
272
|
+
When HPDF_TextAnnot_SetOpened() succeeds, it returns HPDF_OK.
|
273
|
+
Otherwise, it
|
274
|
+
returns error-code and error-handler is invoked.<br>
|
275
|
+
<br>
|
276
|
+
<h4>Error</h4>
|
277
|
+
<span style="font-weight: bold;">HPDF_INVALID_ANNOTATION</span><br>
|
278
|
+
<div class="bodytext5">An invalid annotation handle was set.<br>
|
279
|
+
<br>
|
280
|
+
</div>
|
281
|
+
<span style="font-weight: bold;">HPDF_FAILD_TO_ALLOC_MEM</span>
|
282
|
+
<div class="bodytext5">Memory Allocation Failed.
|
283
|
+
</div>
|
284
|
+
</div>
|
285
|
+
<br>
|
286
|
+
<br>
|
287
|
+
<br>
|
288
|
+
<br>
|
289
|
+
<br>
|
290
|
+
<br>
|
291
|
+
<br>
|
292
|
+
<br>
|
293
|
+
<br>
|
294
|
+
<br>
|
295
|
+
<br>
|
296
|
+
<br>
|
297
|
+
<br>
|
298
|
+
<br>
|
299
|
+
<br>
|
300
|
+
<br>
|
301
|
+
<br>
|
302
|
+
<br>
|
303
|
+
<br>
|
304
|
+
<br>
|
305
|
+
<br>
|
306
|
+
<br>
|
307
|
+
</div>
|
308
|
+
</div>
|
309
|
+
<div id="lcol">
|
310
|
+
<div class="sidebar">
|
311
|
+
<ul>
|
312
|
+
</ul>
|
313
|
+
<ul>
|
314
|
+
<li><a href="#HPDF_LinkAnnot_SetHighlightMode_">HPDF_LinkAnnot_SetHighlightMode</a></li>
|
315
|
+
<li><a href="#HPDF_LinkAnnot_SetBorderStyle_">HPDF_LinkAnnot_SetBorderStyle</a></li>
|
316
|
+
<li><a href="#HPDF_TextAnnot_SetIcon_">HPDF_TextAnnot_SetIcon</a></li>
|
317
|
+
<li><a href="#HPDF_TextAnnot_SetOpened_">HPDF_TextAnnot_SetOpened</a><br>
|
318
|
+
</li>
|
319
|
+
</ul>
|
320
|
+
<br>
|
321
|
+
<br>
|
322
|
+
<br>
|
323
|
+
<br>
|
324
|
+
<br>
|
325
|
+
<br>
|
326
|
+
<br>
|
327
|
+
<br>
|
328
|
+
<br>
|
329
|
+
<br>
|
330
|
+
<br>
|
331
|
+
<br>
|
332
|
+
<br>
|
333
|
+
<br>
|
334
|
+
<br>
|
335
|
+
<br>
|
336
|
+
<br>
|
337
|
+
<br>
|
338
|
+
<br>
|
339
|
+
<br>
|
340
|
+
<br>
|
341
|
+
<br>
|
342
|
+
<br>
|
343
|
+
<br>
|
344
|
+
<br>
|
345
|
+
<br>
|
346
|
+
<br>
|
347
|
+
<br>
|
348
|
+
<br>
|
349
|
+
<br>
|
350
|
+
<br>
|
351
|
+
<br>
|
352
|
+
<br>
|
353
|
+
<br>
|
354
|
+
<br>
|
355
|
+
<br>
|
356
|
+
<br>
|
357
|
+
<br>
|
358
|
+
<br>
|
359
|
+
<br>
|
360
|
+
<br>
|
361
|
+
<br>
|
362
|
+
<br>
|
363
|
+
<br>
|
364
|
+
<br>
|
365
|
+
<br>
|
366
|
+
<br>
|
367
|
+
<br>
|
368
|
+
<br>
|
369
|
+
<br>
|
370
|
+
<br>
|
371
|
+
<br>
|
372
|
+
<br>
|
373
|
+
<br>
|
374
|
+
<br>
|
375
|
+
<br>
|
376
|
+
<br>
|
377
|
+
<br>
|
378
|
+
<br>
|
379
|
+
<br>
|
380
|
+
<br>
|
381
|
+
<br>
|
382
|
+
<br>
|
383
|
+
<br>
|
384
|
+
<br>
|
385
|
+
<br>
|
386
|
+
<br>
|
387
|
+
<br>
|
388
|
+
<br>
|
389
|
+
<br>
|
390
|
+
<br>
|
391
|
+
<br>
|
392
|
+
<br>
|
393
|
+
<br>
|
394
|
+
<br>
|
395
|
+
<br>
|
396
|
+
<br>
|
397
|
+
<br>
|
398
|
+
<br>
|
399
|
+
<br>
|
400
|
+
<br>
|
401
|
+
<br>
|
402
|
+
<br>
|
403
|
+
<br>
|
404
|
+
<br>
|
405
|
+
<br>
|
406
|
+
<br>
|
407
|
+
<br>
|
408
|
+
<br>
|
409
|
+
<br>
|
410
|
+
<br>
|
411
|
+
<br>
|
412
|
+
<br>
|
413
|
+
<br>
|
414
|
+
<br>
|
415
|
+
<br>
|
416
|
+
<br>
|
417
|
+
<br>
|
418
|
+
<br>
|
419
|
+
<br>
|
420
|
+
<br>
|
421
|
+
<br>
|
422
|
+
<br>
|
423
|
+
<br>
|
424
|
+
<br>
|
425
|
+
<br>
|
426
|
+
<br>
|
427
|
+
<br>
|
428
|
+
<br>
|
429
|
+
<br>
|
430
|
+
<br>
|
431
|
+
<br>
|
432
|
+
<br>
|
433
|
+
<br>
|
434
|
+
<br>
|
435
|
+
<br>
|
436
|
+
<br>
|
437
|
+
<br>
|
438
|
+
<br>
|
439
|
+
<br>
|
440
|
+
<br>
|
441
|
+
<br>
|
442
|
+
<br>
|
443
|
+
<br>
|
444
|
+
<br>
|
445
|
+
<br>
|
446
|
+
<br>
|
447
|
+
<br>
|
448
|
+
<br>
|
449
|
+
<br>
|
450
|
+
<br>
|
451
|
+
<br>
|
452
|
+
<br>
|
453
|
+
<br>
|
454
|
+
<br>
|
455
|
+
<br>
|
456
|
+
<br>
|
457
|
+
<br>
|
458
|
+
<br>
|
459
|
+
<br>
|
460
|
+
<br>
|
461
|
+
<br>
|
462
|
+
<br>
|
463
|
+
<br>
|
464
|
+
<br>
|
465
|
+
<br>
|
466
|
+
<br>
|
467
|
+
<br>
|
468
|
+
<br>
|
469
|
+
<br>
|
470
|
+
<br>
|
471
|
+
<br>
|
472
|
+
<br>
|
473
|
+
<br>
|
474
|
+
<br>
|
475
|
+
<br>
|
476
|
+
<br>
|
477
|
+
<br>
|
478
|
+
<br>
|
479
|
+
<br>
|
480
|
+
<br>
|
481
|
+
<br>
|
482
|
+
<br>
|
483
|
+
<br>
|
484
|
+
<br>
|
485
|
+
<br>
|
486
|
+
</div>
|
487
|
+
</div>
|
488
|
+
<br>
|
489
|
+
<br>
|
490
|
+
<br>
|
491
|
+
<br>
|
492
|
+
<br>
|
493
|
+
<br>
|
494
|
+
<br>
|
495
|
+
<br>
|
496
|
+
<br>
|
497
|
+
<br>
|
498
|
+
<br>
|
499
|
+
<br>
|
500
|
+
<br>
|
501
|
+
</div>
|
502
|
+
</body>
|
503
|
+
</html>
|