diff options
Diffstat (limited to 'www/api/attribute.html')
| -rw-r--r-- | www/api/attribute.html | 123 |
1 files changed, 59 insertions, 64 deletions
diff --git a/www/api/attribute.html b/www/api/attribute.html index 3d2dee5..3887cf7 100644 --- a/www/api/attribute.html +++ b/www/api/attribute.html @@ -1,12 +1,14 @@ -<?xml version="1.0" encoding="utf-8" ?> -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> -<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<!DOCTYPE html> +<html lang="en"> <head> -<meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> -<meta name="generator" content="Docutils 0.16: http://docutils.sourceforge.net/" /> -<title>attribute</title> -<link rel="stylesheet" href="../docutils-api.css" type="text/css" /> + <meta charset="utf-8"> + <meta content="en" name="language"> + <title>attribute</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <link media="screen" href="../docutils-api.css" type="text/css" rel="stylesheet"> + </head> + <body> <div class="banner"> @@ -19,6 +21,7 @@ </form> </div> + <div class="navmenu"> <ul> <li><a href="../index.html">Home</a></li> @@ -32,28 +35,26 @@ <li><a href="../reference.html">Reference</a></li> </ul> </div> + <div class="document" id="attribute"> <h1 class="title">attribute</h1> -<h2 class="subtitle" id="access-key-value-image-attributes">Access key,value image attributes</h2> - +<p class="subtitle" id="access-key-value-image-attributes">Access key,value image attributes</p> <div class="contents topic" id="contents"> <p class="topic-title">Contents</p> <ul class="simple"> -<li><a class="reference internal" href="#cloneimageattributes" id="id9">CloneImageAttributes</a></li> -<li><a class="reference internal" href="#destroyimageattributes" id="id10">DestroyImageAttributes</a></li> -<li><a class="reference internal" href="#getimageattribute" id="id11">GetImageAttribute</a></li> -<li><a class="reference internal" href="#getimageclippingpathattribute" id="id12">GetImageClippingPathAttribute</a></li> -<li><a class="reference internal" href="#setimageattribute" id="id13">SetImageAttribute</a></li> +<li><p><a class="reference internal" href="#cloneimageattributes" id="id9">CloneImageAttributes</a></p></li> +<li><p><a class="reference internal" href="#destroyimageattributes" id="id10">DestroyImageAttributes</a></p></li> +<li><p><a class="reference internal" href="#getimageattribute" id="id11">GetImageAttribute</a></p></li> +<li><p><a class="reference internal" href="#getimageclippingpathattribute" id="id12">GetImageClippingPathAttribute</a></p></li> +<li><p><a class="reference internal" href="#setimageattribute" id="id13">SetImageAttribute</a></p></li> </ul> </div> <div class="section" id="cloneimageattributes"> <h1><a class="toc-backref" href="#id9">CloneImageAttributes</a></h1> <div class="section" id="synopsis"> <h2>Synopsis</h2> -<pre class="literal-block"> -MagickPassFail CloneImageAttributes( <a class="reference external" href="../api/types.html#image">Image</a> *clone_image, - const <a class="reference external" href="../api/types.html#image">Image</a> *original_image ); -</pre> +<pre class="literal-block">MagickPassFail CloneImageAttributes( <a class="reference external" href="../api/types.html#image">Image</a> *clone_image, + const <a class="reference external" href="../api/types.html#image">Image</a> *original_image );</pre> </div> <div class="section" id="description"> <h2>Description</h2> @@ -62,15 +63,15 @@ Any text attributes in the destination image are preserved. CloneImageAttributes returns MagickPass if all of the attribututes are successfully cloned or MagickFail if there is a memory allocation error.</p> <p>The format of the CloneImageAttributes method is:</p> -<pre class="literal-block"> -MagickPassFail CloneImageAttributes( <a class="reference external" href="../api/types.html#image">Image</a> *clone_image, - const <a class="reference external" href="../api/types.html#image">Image</a> *original_image ); -</pre> -<dl class="docutils"> +<pre class="literal-block">MagickPassFail CloneImageAttributes( <a class="reference external" href="../api/types.html#image">Image</a> *clone_image, + const <a class="reference external" href="../api/types.html#image">Image</a> *original_image );</pre> +<dl class="simple"> <dt>clone_image:</dt> -<dd>The destination image.</dd> +<dd><p>The destination image.</p> +</dd> <dt>original_image:</dt> -<dd>The source image.</dd> +<dd><p>The source image.</p> +</dd> </dl> </div> </div> @@ -78,22 +79,19 @@ MagickPassFail CloneImageAttributes( <a class="reference external" href="../api/ <h1><a class="toc-backref" href="#id10">DestroyImageAttributes</a></h1> <div class="section" id="id1"> <h2>Synopsis</h2> -<pre class="literal-block"> -DestroyImageAttributes( <a class="reference external" href="../api/types.html#image">Image</a> *image ); -</pre> +<pre class="literal-block">DestroyImageAttributes( <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre> </div> <div class="section" id="id2"> <h2>Description</h2> <p>DestroyImageAttributes() deallocates memory associated with the image attribute list.</p> <p>The format of the DestroyImageAttributes method is:</p> -<pre class="literal-block"> -DestroyImageAttributes( <a class="reference external" href="../api/types.html#image">Image</a> *image ); -</pre> +<pre class="literal-block">DestroyImageAttributes( <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> </dl> </div> </div> @@ -101,24 +99,22 @@ DestroyImageAttributes( <a class="reference external" href="../api/types.html#im <h1><a class="toc-backref" href="#id11">GetImageAttribute</a></h1> <div class="section" id="id3"> <h2>Synopsis</h2> -<pre class="literal-block"> -const ImageAttribute *GetImageAttribute( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *key ); -</pre> +<pre class="literal-block">const ImageAttribute *GetImageAttribute( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *key );</pre> </div> <div class="section" id="id4"> <h2>Description</h2> <p>GetImageAttribute() searches the list of image attributes and returns a pointer to the attribute if it exists otherwise NULL.</p> <p>The format of the GetImageAttribute method is:</p> -<pre class="literal-block"> -const ImageAttribute *GetImageAttribute( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *key ); -</pre> -<dl class="docutils"> +<pre class="literal-block">const ImageAttribute *GetImageAttribute( const <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *key );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>key:</dt> -<dd>These character strings are the name of an image attribute to -return.</dd> +<dd><p>These character strings are the name of an image attribute to +return.</p> +</dd> </dl> </div> </div> @@ -126,25 +122,23 @@ return.</dd> <h1><a class="toc-backref" href="#id12">GetImageClippingPathAttribute</a></h1> <div class="section" id="id5"> <h2>Synopsis</h2> -<pre class="literal-block"> -const ImageAttribute *GetImageClippingPathAttribute( const <a class="reference external" href="../api/types.html#image">Image</a> *image ); -</pre> +<pre class="literal-block">const ImageAttribute *GetImageClippingPathAttribute( const <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre> </div> <div class="section" id="id6"> <h2>Description</h2> <p>Method GetImageClippingPathAttribute searches the list of image attributes and returns a pointer to a clipping path if it exists otherwise NULL.</p> <p>The format of the GetImageClippingPathAttribute method is:</p> -<pre class="literal-block"> -const ImageAttribute *GetImageClippingPathAttribute( const <a class="reference external" href="../api/types.html#image">Image</a> *image ); -</pre> +<pre class="literal-block">const ImageAttribute *GetImageClippingPathAttribute( const <a class="reference external" href="../api/types.html#image">Image</a> *image );</pre> <p>A description of each parameter follows:</p> -<dl class="docutils"> +<dl class="simple"> <dt>attribute:</dt> -<dd>Method GetImageClippingPathAttribute returns the clipping -path if it exists otherwise NULL.</dd> +<dd><p>Method GetImageClippingPathAttribute returns the clipping +path if it exists otherwise NULL.</p> +</dd> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> </dl> </div> </div> @@ -152,9 +146,7 @@ path if it exists otherwise NULL.</dd> <h1><a class="toc-backref" href="#id13">SetImageAttribute</a></h1> <div class="section" id="id7"> <h2>Synopsis</h2> -<pre class="literal-block"> -unsigned int SetImageAttribute( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *key, const char *value ); -</pre> +<pre class="literal-block">unsigned int SetImageAttribute( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *key, const char *value );</pre> </div> <div class="section" id="id8"> <h2>Description</h2> @@ -177,23 +169,26 @@ being concatenated to it as when setting other attributes.</p> embedded format specifications are translated according to the formatting rules of TranslateText().</p> <p>The format of the SetImageAttribute method is:</p> -<pre class="literal-block"> -unsigned int SetImageAttribute( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *key, const char *value ); -</pre> -<dl class="docutils"> +<pre class="literal-block">unsigned int SetImageAttribute( <a class="reference external" href="../api/types.html#image">Image</a> *image, const char *key, const char *value );</pre> +<dl class="simple"> <dt>image:</dt> -<dd>The image.</dd> +<dd><p>The image.</p> +</dd> <dt>key,value:</dt> -<dd>These character strings are the name and value of an image -attribute to replace or add to the list.</dd> +<dd><p>These character strings are the name and value of an image +attribute to replace or add to the list.</p> +</dd> </dl> </div> </div> </div> + <hr class="docutils"> <div class="document"> - <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2022<!--SPONSOR_LOGO--></p> + <p><a href="../Copyright.html">Copyright</a> © GraphicsMagick Group 2002 - 2023<!--SPONSOR_LOGO--></p> +</div> + </div> </body> </html> |