← Back to branch summary

~ubuntu-branches/ubuntu/intrepid/graphicsmagick/intrepid

« back to all changes in this revision

Viewing changes to www/api/attribute.html

  • Committer: Bazaar Package Importer
  • Author(s): Daniel Kobras
  • Date: 2006-05-06 16:28:08 UTC
  • Revision ID: james.westby@ubuntu.com-20060506162808-vt2ni3r5nytcszms
Tags: upstream-1.1.7
Import upstream version 1.1.7

Show diffs side-by-side

added added

removed removed

Lines of Context:
www/api/attribute.html
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<title>attribute - Access key,value image attributes</title>
 
5
<link rev="made" href="mailto:bfriesen@scooby.simplesystems.org" />
 
6
</head>
 
7
 
 
8
<body style="background-color: white">
 
9
 
 
10
<P><a name="__index__"></a></P>
 
11
<!-- INDEX BEGIN -->
 
12
 
 
13
<ul>
 
14
 
 
15
        <li><a href="#name">NAME</a></li>
 
16
        <li><a href="#synopsis">SYNOPSIS</a></li>
 
17
        <li><a href="#function_descriptions">FUNCTION DESCRIPTIONS</a></li>
 
18
        <ul>
 
19
 
 
20
                <li><a href="#destroyimageattributes">DestroyImageAttributes</a></li>
 
21
                <li><a href="#getimageattribute">GetImageAttribute</a></li>
 
22
                <li><a href="#getimageclippingpathattribute">GetImageClippingPathAttribute</a></li>
 
23
                <li><a href="#setimageattribute">SetImageAttribute</a></li>
 
24
        </ul>
 
25
 
 
26
</ul>
 
27
<!-- INDEX END -->
 
28
 
 
29
<hr />
 
30
<P>
 
31
</P>
 
32
<h1><a name="name">NAME</a></h1>
 
33
<P>attribute - Access key,value image attributes</P>
 
34
<P>
 
35
</P>
 
36
<hr />
 
37
<h1><a name="synopsis">SYNOPSIS</a></h1>
 
38
<P><strong>DestroyImageAttributes</strong>( Image *image );</P>
 
39
<P>const ImageAttribute * <strong>GetImageAttribute</strong>( const Image *image, const char *key );</P>
 
40
<P>const ImageAttribute * <strong>GetImageClippingPathAttribute</strong>( const Image *image );</P>
 
41
<P>unsigned int  <strong>SetImageAttribute</strong>( Image *image, const char *key, const char *value );</P>
 
42
<P>
 
43
</P>
 
44
<hr />
 
45
<h1><a name="function_descriptions">FUNCTION DESCRIPTIONS</a></h1>
 
46
<P>
 
47
</P>
 
48
<h2><a name="destroyimageattributes">DestroyImageAttributes</a></h2>
 
49
<blockquote>DestroyImageAttributes() deallocates memory associated with the image attribute list. </blockquote><P>The format of the DestroyImageAttributes method is:</P>
 
50
<blockquote>DestroyImageAttributes ( <A HREF="types.html#Image">Image</A> *image ); </blockquote><P>A description of each parameter follows:</P>
 
51
<dl>
 
52
<dt><strong><a name="item_o_image_3a">image:</a></strong><br />
 
53
</dt>
 
54
<DD>
 
55
The image.
 
56
</dd>
 
57
<P></P></dl>
 
58
<P>
 
59
</P>
 
60
<h2><a name="getimageattribute">GetImageAttribute</a></h2>
 
61
<blockquote>GetImageAttribute() searches the list of image attributes and returns a pointer to the attribute if it exists otherwise NULL. </blockquote><P>The format of the GetImageAttribute method is:</P>
 
62
<blockquote>const ImageAttribute *GetImageAttribute ( const <A HREF="types.html#Image">Image</A> *image, const char *key ); </blockquote><P>A description of each parameter follows:</P>
 
63
<dl>
 
64
<dt><strong>image:</strong><br />
 
65
</dt>
 
66
<DD>
 
67
The image.
 
68
</dd>
 
69
<P></P>
 
70
<dt><strong><a name="item_o_key_3a">key:</a></strong><br />
 
71
</dt>
 
72
<DD>
 
73
These character strings are the name of an image attribute to return.
 
74
</dd>
 
75
<P></P></dl>
 
76
<P>
 
77
</P>
 
78
<h2><a name="getimageclippingpathattribute">GetImageClippingPathAttribute</a></h2>
 
79
<P>Method GetImageClippingPathAttribute searches the list of image attributes and returns a pointer to a clipping path if it exists otherwise NULL.</P>
 
80
<P>The format of the GetImageClippingPathAttribute method is:</P>
 
81
<blockquote>const ImageAttribute *GetImageClippingPathAttribute ( const <A HREF="types.html#Image">Image</A> *image ); </blockquote><P>A description of each parameter follows:</P>
 
82
<dl>
 
83
<dt><strong><a name="item_o_attribute_3a">attribute:</a></strong><br />
 
84
</dt>
 
85
<DD>
 
86
Method GetImageClippingPathAttribute returns the clipping path if it exists otherwise NULL.
 
87
</dd>
 
88
<P></P>
 
89
<dt><strong>image:</strong><br />
 
90
</dt>
 
91
<DD>
 
92
The image.
 
93
</dd>
 
94
<P></P></dl>
 
95
<P>
 
96
</P>
 
97
<h2><a name="setimageattribute">SetImageAttribute</a></h2>
 
98
<blockquote>SetImageAttribute() searches the list of image attributes and replaces the attribute value. If it is not found in the list, the attribute name and value is added to the list. If the attribute exists in the list, the value is concatenated to the attribute. SetImageAttribute returns True if the attribute is successfully concatenated or added to the list, otherwise False. If the value is NULL, the matching key is deleted from the list. </blockquote><P>The format of the SetImageAttribute method is:</P>
 
99
<blockquote>unsigned int SetImageAttribute ( <A HREF="types.html#Image">Image</A> *image, const char *key, const char *value ); </blockquote><P>A description of each parameter follows:</P>
 
100
<dl>
 
101
<dt><strong>image:</strong><br />
 
102
</dt>
 
103
<DD>
 
104
The image.
 
105
</dd>
 
106
<P></P>
 
107
<dt><strong><a name="item_o_key_2cvalue_3a">key,value:</a></strong><br />
 
108
</dt>
 
109
<DD>
 
110
These character strings are the name and value of an image attribute to replace or add to the list.
 
111
</dd>
 
112
</dl>
 
113
 
 
114
</body>
 
115
 
 
116
</html>