GD::Text.3pm
上传用户:qdrechuli
上传日期:2022-08-01
资源大小:917k
文件大小:12k
源码类别:

视频捕捉/采集

开发平台:

Visual C++

  1. ." Automatically generated by Pod::Man version 1.15
  2. ." Tue Oct  8 11:46:52 2002
  3. ."
  4. ." Standard preamble:
  5. ." ======================================================================
  6. .de Sh " Subsection heading
  7. .br
  8. .if t .Sp
  9. .ne 5
  10. .PP
  11. fB\$1fR
  12. .PP
  13. ..
  14. .de Sp " Vertical space (when we can't use .PP)
  15. .if t .sp .5v
  16. .if n .sp
  17. ..
  18. .de Ip " List item
  19. .br
  20. .ie \n(.$>=3 .ne \$3
  21. .el .ne 3
  22. .IP "\$1" \$2
  23. ..
  24. .de Vb " Begin verbatim text
  25. .ft CW
  26. .nf
  27. .ne \$1
  28. ..
  29. .de Ve " End verbatim text
  30. .ft R
  31. .fi
  32. ..
  33. ." Set up some character translations and predefined strings.  *(-- will
  34. ." give an unbreakable dash, *(PI will give pi, *(L" will give a left
  35. ." double quote, and *(R" will give a right double quote.  | will give a
  36. ." real vertical bar.  *(C+ will give a nicer C++.  Capital omega is used
  37. ." to do unbreakable dashes and therefore won't be available.  *(C` and
  38. ." *(C' expand to `' in nroff, nothing in troff, for use with C<>
  39. .tr (*W-|(bv*(Tr
  40. .ds C+ Cv'-.1v'h'-1p's-2+h'-1p'+s0v'.1v'h'-1p'
  41. .ie n {
  42. .    ds -- (*W-
  43. .    ds PI pi
  44. .    if (n(.H=4u)&(1m=24u) .ds -- (*Wh'-12u'(*Wh'-12u'-" diablo 10 pitch
  45. .    if (n(.H=4u)&(1m=20u) .ds -- (*Wh'-12u'(*Wh'-8u'-"  diablo 12 pitch
  46. .    ds L" ""
  47. .    ds R" ""
  48. .    ds C` ""
  49. .    ds C' ""
  50. 'br}
  51. .el{
  52. .    ds -- |(em|
  53. .    ds PI (*p
  54. .    ds L" ``
  55. .    ds R" ''
  56. 'br}
  57. ."
  58. ." If the F register is turned on, we'll generate index entries on stderr
  59. ." for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
  60. ." index entries marked with X<> in POD.  Of course, you'll have to process
  61. ." the output yourself in some meaningful fashion.
  62. .if nF {
  63. .    de IX
  64. .    tm Index:\$1t\n%t"\$2"
  65. ..
  66. .    nr % 0
  67. .    rr F
  68. .}
  69. ."
  70. ." For nroff, turn off justification.  Always turn off hyphenation; it
  71. ." makes way too many mistakes in technical documents.
  72. .hy 0
  73. .if n .na
  74. ."
  75. ." Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  76. ." Fear.  Run.  Save yourself.  No user-serviceable parts.
  77. .bd B 3
  78. .    " fudge factors for nroff and troff
  79. .if n {
  80. .    ds #H 0
  81. .    ds #V .8m
  82. .    ds #F .3m
  83. .    ds #[ f1
  84. .    ds #] fP
  85. .}
  86. .if t {
  87. .    ds #H ((1u-(\\n(.fu%2u))*.13m)
  88. .    ds #V .6m
  89. .    ds #F 0
  90. .    ds #[ &
  91. .    ds #] &
  92. .}
  93. .    " simple accents for nroff and troff
  94. .if n {
  95. .    ds ' &
  96. .    ds ` &
  97. .    ds ^ &
  98. .    ds , &
  99. .    ds ~ ~
  100. .    ds /
  101. .}
  102. .if t {
  103. .    ds ' \k:h'-(\n(.wu*8/10-*(#H)''h"|\n:u"
  104. .    ds ` \k:h'-(\n(.wu*8/10-*(#H)'`h'|\n:u'
  105. .    ds ^ \k:h'-(\n(.wu*10/11-*(#H)'^h'|\n:u'
  106. .    ds , \k:h'-(\n(.wu*8/10)',h'|\n:u'
  107. .    ds ~ \k:h'-(\n(.wu-*(#H-.1m)'~h'|\n:u'
  108. .    ds / \k:h'-(\n(.wu*8/10-*(#H)'z(slh'|\n:u'
  109. .}
  110. .    " troff and (daisy-wheel) nroff accents
  111. .ds : \k:h'-(\n(.wu*8/10-*(#H+.1m+*(#F)'v'-*(#V'z.h'.2m+*(#F'.h'|\n:u'v'*(#V'
  112. .ds 8 h'*(#H'(*bh'-*(#H'
  113. .ds o \k:h'-(\n(.wu+w'(de'u-*(#H)/2u'v'-.3n'*(#[z(dev'.3n'h'|\n:u'*(#]
  114. .ds d- h'*(#H'(pdh'-w'~'u'v'-.25m'f2(hyfPv'.25m'h'-*(#H'
  115. .ds D- D\k:h'-w'D'u'v'-.11m'z(hyv'.11m'h'|\n:u'
  116. .ds th *(#[v'.3m's+1Is-1v'-.3m'h'-(w'I'u*2/3)'s-1os+1*(#]
  117. .ds Th *(#[s+2Is-2h'-w'I'u*3/5'v'-.3m'ov'.3m'*(#]
  118. .ds ae ah'-(w'a'u*4/10)'e
  119. .ds Ae Ah'-(w'A'u*4/10)'E
  120. .    " corrections for vroff
  121. .if v .ds ~ \k:h'-(\n(.wu*9/10-*(#H)'s-2u~ds+2h'|\n:u'
  122. .if v .ds ^ \k:h'-(\n(.wu*10/11-*(#H)'v'-.4m'^v'.4m'h'|\n:u'
  123. .    " for low resolution devices (crt and lpr)
  124. .if n(.H>23 .if n(.V>19 
  125. {
  126. .    ds : e
  127. .    ds 8 ss
  128. .    ds o a
  129. .    ds d- dh'-1'(ga
  130. .    ds D- Dh'-1'(hy
  131. .    ds th o'bp'
  132. .    ds Th o'LP'
  133. .    ds ae ae
  134. .    ds Ae AE
  135. .}
  136. .rm #[ #] #H #V #F C
  137. ." ======================================================================
  138. ."
  139. .IX Title "Text 3"
  140. .TH Text 3 "perl v5.6.1" "2000-09-18" "User Contributed Perl Documentation"
  141. .UC
  142. .SH "NAME"
  143. &s-1GD:s0:Text - Text utilities for use with s-1GDs0
  144. .SH "SYNOPSIS"
  145. .IX Header "SYNOPSIS"
  146. .Vb 2
  147. &  use GD;
  148. &  use GD::Text;
  149. .Ve
  150. .Vb 7
  151. &  my $gd_text = GD::Text->new() or die GD::Text::error();
  152. &  $gd_text->set_font('funny.ttf', 12) or die $gd_text->error;
  153. &  $gd_text->set_font(gdTinyFont);
  154. &  $gd_text->set_font(GD::Font::Tiny);
  155. &  ...
  156. &  $gd_text->set_text($string);
  157. &  my ($w, $h) = $gd_text->get('width', 'height');
  158. .Ve
  159. .Vb 4
  160. &  if ($gd_text->is_ttf)
  161. &  {
  162. &          ...
  163. &  }
  164. .Ve
  165. Or alternatively
  166. .PP
  167. .Vb 5
  168. &  my $gd_text = GD::Text->new(
  169. &        text => 'Some text',
  170. &        font => 'funny.ttf',
  171. &        ptsize => 14,
  172. &    );
  173. .Ve
  174. .SH "DESCRIPTION"
  175. .IX Header "DESCRIPTION"
  176. This module provides a font-independent way of dealing with text in
  177. &s-1GDs0, for use with the s-1GD:s0:Text::* modules and s-1GD:s0:Graph.
  178. .SH "NOTES"
  179. .IX Header "NOTES"
  180. As with all Modules for Perl: Please stick to using the interface. If
  181. you try to fiddle too much with knowledge of the internals of this
  182. module, you could get burned. I may change them at any time.
  183. .PP
  184. You can only use TrueType fonts with version of s-1GDs0 > 1.20, and then
  185. only if compiled with support for this. If you attempt to do it
  186. anyway, you will get errors.
  187. .SH "METHODS"
  188. .IX Header "METHODS"
  189. .Sh "s-1GD:s0:Text->new( attrib => value, ... )"
  190. .IX Subsection "GD::Text->new( attrib => value, ... )"
  191. Create a new object. See the f(CW*(C`set()*(C'fR method for attributes.
  192. .Sh "s-1GD:\fIs0:Text::error()fP or f(CW$gd_textfP->fIerror()fP;"
  193. .IX Subsection "GD:f(ISs0:Text::error() or $gd_text->error();"
  194. Return the last error that occured in the class. This may be
  195. imperfect.
  196. .Sh "$gd_text->set_font( font, size )"
  197. .IX Subsection "$gd_text->set_font( font, size )"
  198. Set the font to use for this string. The arguments are either a s-1GDs0
  199. builtin font (like gdSmallFont or s-1GD:s0:Font->Small) or the name of a
  200. TrueType font file and the size of the font to use. See also
  201. the section on "font_path". 
  202. .PP
  203. If you are not using an absolute path to the font file, you can leave of
  204. the .ttf file extension, but you have to append it for absolute paths:
  205. .PP
  206. .Vb 3
  207. &  $gd_text->set_font('cetus', 12);
  208. &  # but
  209. &  $gd_text->set_font('/usr/fonts/cetus.ttf', 12);
  210. .Ve
  211. The first argument can be a reference to an array of fonts. The first
  212. font from the array that can be found will be used. This allows you to
  213. do something like
  214. .PP
  215. .Vb 3
  216. &  $gd_text->font_path( '/usr/share/fonts:/usr/fonts');
  217. &  $gd_text->set_font(
  218. &    ['verdana', 'arial', gdMediumBoldFont], 14);
  219. .Ve
  220. if you'd prefer verdana to be used, would be satisfied with arial, but
  221. if none of that is available just want to make sure you can fall
  222. back on something that will be available. 
  223. .PP
  224. Returns true on success, false on error.
  225. .Sh "$gd_text->set_text('some text')"
  226. .IX Subsection "$gd_text->set_text('some text')"
  227. Set the text to operate on. 
  228. Returns true on success and false on error.
  229. .Sh "$gd_text->set( attrib => value, ... )"
  230. .IX Subsection "$gd_text->set( attrib => value, ... )"
  231. The set method provides a convenience replacement for the various other
  232. &f(CW*(C`set_xxx()*(C'fR methods. Valid attributes are:
  233. .Ip "text" 4
  234. .IX Item "text"
  235. The text to operate on, see also f(CW*(C`set_text()*(C'fR.
  236. .Ip "font, ptsize" 4
  237. .IX Item "font, ptsize"
  238. The font to use and the point size. The point size is only used for
  239. TrueType fonts. Also see f(CW*(C`set_font()*(C'fR.
  240. .PP
  241. Returns true on success, false on any error, even if it was partially
  242. successful. When an error is returned, no guarantees are given about
  243. the correctness of the attributes.
  244. .Sh "$gd_text->get( attrib, ... )"
  245. .IX Subsection "$gd_text->get( attrib, ... )"
  246. Get the value of an attribute.
  247. Return a list of the attribute values in list context, and the value of
  248. the first attribute in scalar context.
  249. .PP
  250. The attributes that can be retrieved are all the ones that can be set,
  251. and:
  252. .Ip "width, height" 4
  253. .IX Item "width, height"
  254. The width (height) of the string in pixels
  255. .Ip "space" 4
  256. .IX Item "space"
  257. The width of a space in pixels
  258. .Ip "char_up, char_down" 4
  259. .IX Item "char_up, char_down"
  260. The number of pixels that a character can stick out above and below the
  261. baseline. Note that this is only useful for TrueType fonts. For builtins
  262. char_up is equal to height, and char_down is always 0.
  263. .PP
  264. Note that some of these parameters (char_up, char_down and space) are
  265. generic font properties, and not necessarily a property of the text
  266. that is set.
  267. .Sh "$gd_text->width('string')"
  268. .IX Subsection "$gd_text->width('string')"
  269. Return the length of a string in pixels, without changing the current
  270. value of the text.  Returns the width of 'string' rendered in the
  271. current font and size.  On failure, returns undef.
  272. .PP
  273. The use of this method is vaguely deprecated.
  274. .Sh "$gd_text->is_builtin"
  275. .IX Subsection "$gd_text->is_builtin"
  276. Returns true if the current object is based on a builtin s-1GDs0 font.
  277. .Sh "$gd_text->is_ttf"
  278. .IX Subsection "$gd_text->is_ttf"
  279. Returns true if the current object is based on a TrueType font.
  280. .Sh "$gd_text->fIcan_do_ttf()fP or s-1GD:s0:Text->fIcan_do_ttf()fP"
  281. .IX Subsection "$gd_text->can_do_ttf() or GD::Text->can_do_ttf()"
  282. Return true if this object can handle s-1TTFs0 fonts.
  283. .PP
  284. This depends on whether your version of s-1GDs0 is newer than 1.19 and
  285. has s-1TTFs0 support compiled into it.
  286. .Sh "$gd_text->font_path(path_spec), s-1GD:s0:Text->font_path(path_spec)"
  287. .IX Subsection "$gd_text->font_path(path_spec), GD::Text->font_path(path_spec)"
  288. This sets the font path for the fIclassfR (i.e. not just for the object).
  289. The f(CW*(C`set_font*(C'fR method will search this path to find the font specified
  290. if it is a TrueType font. It should contain a list of
  291. paths. The current directory is always searched first, unless '.' is
  292. present in s-1FONT_PATHs0. Examples: 
  293. .PP
  294. .Vb 2
  295. &  GD::Text->font_path('/usr/ttfonts'); # Unix
  296. &  GD::Text->font_path('c:/fonts');     # MS-OS
  297. .Ve
  298. Any font name that is not an absolute path will first be looked for in
  299. the current directory, and then in /usr/ttfonts (c:efonts).
  300. .PP
  301. .Vb 2
  302. &  GD::Text->font_path('/usr/ttfonts:.:lib/fonts'); # Unix
  303. &  GD::Text->font_path('c:/fonts;.;f:/fonts');      # MS-OS
  304. .Ve
  305. Any font name that is not an absolute path will first be looked for in
  306. /usr/ttfonts (c:efonts), then in the current directory. and then in
  307. lib/fonts (f:efonts),
  308. relative to the current directory.
  309. .PP
  310. .Vb 1
  311. &  GD::Text->font_path(undef);
  312. .Ve
  313. Font files are only looked for in the current directory.
  314. .PP
  315. &s-1FONT_PATHs0 is initialised at module load time from the environment
  316. variables s-1FONT_PATHs0 or, if that's not present, s-1TTF_FONT_PATHs0.
  317. .PP
  318. Returns the value the font path is set to.  If called without arguments
  319. &f(CW*(C`font_path*(C'fR returns the current font path.
  320. .PP
  321. Note: This currently only works for unices, and (hopefully) for
  322. Microsoft based s-1OSs0's. If anyone feels the urge to have a look at the
  323. code, and send me patches for their s-1OSs0, I'd be most grateful)
  324. .SH "BUGS"
  325. .IX Header "BUGS"
  326. This module has only been tested with anglo-centric 'normal' fonts and
  327. encodings.  Fonts that have other characteristics may not work well.
  328. If that happens, please let me know how to make this work better.
  329. .PP
  330. The font height gets estimated by building a string with all printable
  331. characters that pass the s-1POSIX:\fIs0:isgraph()fR test. If your system doesn't
  332. have s-1POSIXs0, I make an approximation that may be false.
  333. .PP
  334. The whole font path thing works well on Unix, but probably not very well
  335. on other s-1OSs0's. This is only a problem if you try to use a font path. If
  336. you don't use a font path, there should never be a problem. I will try
  337. to expand this in the future, but only if there's a demand for it.
  338. Suggestions welcome.
  339. .SH "COPYRIGHT"
  340. .IX Header "COPYRIGHT"
  341. copyright 1999
  342. Martien Verbruggen (mgjv@comdyn.com.au)
  343. .SH "SEE ALSO"
  344. .IX Header "SEE ALSO"
  345. &fIGDfR|(3), s-1GD:\fIs0:Text::WrapfR|(3), s-1GD:\fIs0:Text::AlignfR|(3)