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

« back to all changes in this revision

Viewing changes to www/Magick++/CoderInfo.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:
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
 
2
<HTML>
 
3
<HEAD>
 
4
        <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=ibm437">
 
5
        <TITLE>Magick::CoderInfo Class</TITLE>
 
6
        <META NAME="GENERATOR" CONTENT="OpenOffice.org 1.0  (Win32)">
 
7
        <META NAME="AUTHOR" CONTENT="Bob Friesenhahn">
 
8
        <META NAME="CREATED" CONTENT="20020805;13531808">
 
9
        <META NAME="CHANGEDBY" CONTENT="Bob Friesenhahn">
 
10
        <META NAME="CHANGED" CONTENT="20020805;13535284">
 
11
        <META NAME="DESCRIPTION" CONTENT="Class to access raw image pixels.">
 
12
        <META NAME="KEYWORDS" CONTENT="GraphicsMagick,Pixel,Magick++">
 
13
        <STYLE>
 
14
        <!--
 
15
                TD P { color: #000000 }
 
16
                P { color: #000000 }
 
17
                H3 { color: #000000 }
 
18
                A:link { color: #0000ff }
 
19
                A:visited { color: #ff0000 }
 
20
        -->
 
21
        </STYLE>
 
22
</HEAD>
 
23
<BODY LANG="en-US" TEXT="#000000" LINK="#0000ff" VLINK="#ff0000" BGCOLOR="#ffffff">
 
24
<H3 ALIGN=CENTER>Magick::CoderInfo</H3>
 
25
<P>The <I>CoderInfo</I> class provides the means to provide
 
26
information regarding GraphicsMagick support for an image format
 
27
(designated by a magick string). It may be used to provide support
 
28
for a specific named format (provided as an argument to the
 
29
constructor), or as an element of a container when format support is
 
30
queried using the <A HREF="STL.html#coderInfoList">coderInfoList()</A>
 
31
templated function. 
 
32
</P>
 
33
<P>The following code fragment illustrates how CoderInfo may be used.
 
34
</P>
 
35
<P><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp; CoderInfo
 
36
info(&quot;GIF&quot;);</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;
 
37
cout &lt;&lt; info-&gt;name() &lt;&lt; &quot;: (&quot; &lt;&lt;
 
38
info-&gt;description() &lt;&lt; &quot;) : &quot;;</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;
 
39
cout &lt;&lt; &quot;Readable = &quot;;</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;
 
40
if ( info-&gt;isReadable() )</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
41
cout &lt;&lt; &quot;true&quot;;</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;
 
42
else</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
43
cout &lt;&lt; &quot;false&quot;;</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;
 
44
cout &lt;&lt; &quot;, &quot;;</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;
 
45
cout &lt;&lt; &quot;Writable = &quot;;</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;
 
46
if ( info-&gt;isWritable() )</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
47
cout &lt;&lt; &quot;true&quot;;</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;
 
48
else</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
49
cout &lt;&lt; &quot;false&quot;;</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;
 
50
cout &lt;&lt; &quot;, &quot;;</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;
 
51
cout &lt;&lt; &quot;Multiframe = &quot;;</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;
 
52
if ( info-&gt;isMultiframe() )</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
53
cout &lt;&lt; &quot;true&quot;;</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;
 
54
else</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
 
55
cout &lt;&lt; &quot;false&quot;;</FONT></TT> <BR><TT><FONT COLOR="#000066">&nbsp;&nbsp;&nbsp;
 
56
cout &lt;&lt; endl;</FONT></TT> 
 
57
</P>
 
58
<P STYLE="margin-bottom: 0cm">The methods available in the <I>CoderInfo</I>
 
59
class are shown in the following table: <BR><BR>
 
60
</P>
 
61
<P ALIGN=CENTER STYLE="margin-bottom: 0cm"><B>CoderInfo Methods</B></P>
 
62
<TABLE WIDTH=100% BORDER=1 CELLPADDING=2 CELLSPACING=2>
 
63
        <TR>
 
64
                <TD>
 
65
                        <P ALIGN=CENTER><B>Method</B></P>
 
66
                </TD>
 
67
                <TD>
 
68
                        <P ALIGN=CENTER><B>Returns</B></P>
 
69
                </TD>
 
70
                <TD>
 
71
                        <P ALIGN=CENTER><B>Signature</B></P>
 
72
                </TD>
 
73
                <TD>
 
74
                        <P ALIGN=CENTER><B>Description</B></P>
 
75
                </TD>
 
76
        </TR>
 
77
        <TR>
 
78
                <TD>
 
79
                        <P ALIGN=CENTER><A NAME="CoderInfo"></A><FONT SIZE=2>CoderInfo</FONT></P>
 
80
                </TD>
 
81
                <TD BGCOLOR="#999999">
 
82
                        <P><FONT SIZE=2>&nbsp;</FONT></P>
 
83
                </TD>
 
84
                <TD>
 
85
                        <P><FONT SIZE=2>void</FONT></P>
 
86
                </TD>
 
87
                <TD>
 
88
                        <P><FONT SIZE=2>Construct object corresponding to named format
 
89
                        (e.g. &quot;GIF&quot;). An exception is thrown if the format is
 
90
                        not supported.</FONT></P>
 
91
                </TD>
 
92
        </TR>
 
93
        <TR>
 
94
                <TD>
 
95
                        <P ALIGN=CENTER><A NAME="name"></A><FONT SIZE=2>name</FONT></P>
 
96
                </TD>
 
97
                <TD>
 
98
                        <P><FONT SIZE=2>std::string</FONT></P>
 
99
                </TD>
 
100
                <TD>
 
101
                        <P><FONT SIZE=2>void</FONT></P>
 
102
                </TD>
 
103
                <TD>
 
104
                        <P><FONT SIZE=2>Format name (e.g. &quot;GIF&quot;).</FONT></P>
 
105
                </TD>
 
106
        </TR>
 
107
        <TR>
 
108
                <TD>
 
109
                        <P ALIGN=CENTER><A NAME="description"></A><FONT SIZE=2>description</FONT></P>
 
110
                </TD>
 
111
                <TD>
 
112
                        <P><FONT SIZE=2>std::string</FONT></P>
 
113
                </TD>
 
114
                <TD>
 
115
                        <P><FONT SIZE=2>void</FONT></P>
 
116
                </TD>
 
117
                <TD>
 
118
                        <P><FONT SIZE=2>Format description (e.g. &quot;CompuServe graphics
 
119
                        interchange format&quot;).</FONT></P>
 
120
                </TD>
 
121
        </TR>
 
122
        <TR>
 
123
                <TD>
 
124
                        <P ALIGN=CENTER><A NAME="isReadable"></A><FONT SIZE=2>isReadable</FONT></P>
 
125
                </TD>
 
126
                <TD>
 
127
                        <P><FONT SIZE=2>bool</FONT></P>
 
128
                </TD>
 
129
                <TD>
 
130
                        <P><FONT SIZE=2>void</FONT></P>
 
131
                </TD>
 
132
                <TD>
 
133
                        <P><FONT SIZE=2>Format is readable.</FONT></P>
 
134
                </TD>
 
135
        </TR>
 
136
        <TR>
 
137
                <TD>
 
138
                        <P ALIGN=CENTER><A NAME="isWritable"></A><FONT SIZE=2>isWritable</FONT></P>
 
139
                </TD>
 
140
                <TD>
 
141
                        <P><FONT SIZE=2>bool</FONT></P>
 
142
                </TD>
 
143
                <TD>
 
144
                        <P><FONT SIZE=2>void</FONT></P>
 
145
                </TD>
 
146
                <TD>
 
147
                        <P><FONT SIZE=2>Format is writeable.</FONT></P>
 
148
                </TD>
 
149
        </TR>
 
150
        <TR>
 
151
                <TD>
 
152
                        <P ALIGN=CENTER><A NAME="isMultiFrame"></A><FONT SIZE=2>isMultiFrame</FONT></P>
 
153
                </TD>
 
154
                <TD>
 
155
                        <P><FONT SIZE=2>bool</FONT></P>
 
156
                </TD>
 
157
                <TD>
 
158
                        <P><FONT SIZE=2>void</FONT></P>
 
159
                </TD>
 
160
                <TD>
 
161
                        <P><FONT SIZE=2>Format supports multiple frames.</FONT></P>
 
162
                </TD>
 
163
        </TR>
 
164
</TABLE>
 
165
<P><BR><BR>
 
166
</P>
 
167
</BODY>
 
168
</HTML>
 
 
b'\\ No newline at end of file'