1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189
|
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Crazy Eddies GUI System: CEGUI::FalagardStaticImage Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<script type="text/javascript">
function hasClass(ele,cls) {
return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
}
function addClass(ele,cls) {
if (!this.hasClass(ele,cls)) ele.className += " "+cls;
}
function removeClass(ele,cls) {
if (hasClass(ele,cls)) {
var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
ele.className=ele.className.replace(reg,' ');
}
}
function toggleVisibility(linkObj) {
var base = linkObj.getAttribute('id');
var summary = document.getElementById(base + '-summary');
var content = document.getElementById(base + '-content');
var trigger = document.getElementById(base + '-trigger');
if ( hasClass(linkObj,'closed') ) {
summary.style.display = 'none';
content.style.display = 'block';
trigger.src = 'open.png';
removeClass(linkObj,'closed');
addClass(linkObj,'opened');
} else if ( hasClass(linkObj,'opened') ) {
summary.style.display = 'block';
content.style.display = 'none';
trigger.src = 'closed.png';
removeClass(linkObj,'opened');
addClass(linkObj,'closed');
}
return false;
}
</script>
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">Crazy Eddies GUI System <span id="projectnumber">0.7.6</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceCEGUI.html">CEGUI</a> </li>
<li class="navelem"><a class="el" href="classCEGUI_1_1FalagardStaticImage.html">FalagardStaticImage</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-attribs">Static Public Attributes</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#pro-static-attribs">Static Protected Attributes</a> </div>
<div class="headertitle">
<div class="title">CEGUI::FalagardStaticImage Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="CEGUI::FalagardStaticImage" --><!-- doxytag: inherits="CEGUI::FalagardStatic" -->
<p>StaticImage class for the FalagardBase module.
<a href="classCEGUI_1_1FalagardStaticImage.html#details">More...</a></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::FalagardStaticImage:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1FalagardStaticImage__inherit__graph.gif" border="0" usemap="#CEGUI_1_1FalagardStaticImage_inherit__map" alt="Inheritance graph"/></div>
<map name="CEGUI_1_1FalagardStaticImage_inherit__map" id="CEGUI_1_1FalagardStaticImage_inherit__map">
<area shape="rect" id="node2" href="classCEGUI_1_1FalagardStatic.html" title="Static class for the FalagardBase module." alt="" coords="23,83,180,112"/><area shape="rect" id="node4" href="classCEGUI_1_1WindowRenderer.html" title="Base-class for the assignable WindowRenderer object." alt="" coords="15,5,188,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
<img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::FalagardStaticImage:</div>
<div id="dynsection-1-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-1-content" class="dyncontent" style="display:none;">
<div class="center"><img src="classCEGUI_1_1FalagardStaticImage__coll__graph.gif" border="0" usemap="#CEGUI_1_1FalagardStaticImage_coll__map" alt="Collaboration graph"/></div>
<map name="CEGUI_1_1FalagardStaticImage_coll__map" id="CEGUI_1_1FalagardStaticImage_coll__map">
<area shape="rect" id="node2" href="classCEGUI_1_1FalagardStatic.html" title="Static class for the FalagardBase module." alt="" coords="5,5,163,35"/><area shape="rect" id="node4" href="classCEGUI_1_1FalagardStaticImageProperties_1_1Image.html" title="Property to access the image for the FalagardStaticImage widget." alt="" coords="187,5,483,35"/><area shape="rect" id="node6" href="classCEGUI_1_1Image.html" title="Class that represents a single Image of an Imageset." alt="" coords="507,5,616,35"/></map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<p><a href="classCEGUI_1_1FalagardStaticImage-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abedce1505f88012b416dc50bc9a498bc"></a><!-- doxytag: member="CEGUI::FalagardStaticImage::FalagardStaticImage" ref="abedce1505f88012b416dc50bc9a498bc" args="(const String &type)" -->
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardStaticImage.html#abedce1505f88012b416dc50bc9a498bc">FalagardStaticImage</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &type)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a28e598c26931e22557268806b667ccbe"></a><!-- doxytag: member="CEGUI::FalagardStaticImage::setImage" ref="a28e598c26931e22557268806b667ccbe" args="(const Image *img)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardStaticImage.html#a28e598c26931e22557268806b667ccbe">setImage</a> (const <a class="el" href="classCEGUI_1_1Image.html">Image</a> *img)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the image for this <a class="el" href="classCEGUI_1_1FalagardStaticImage.html" title="StaticImage class for the FalagardBase module.">FalagardStaticImage</a> widget. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4a193897b6eb34235053825dac3bc49d"></a><!-- doxytag: member="CEGUI::FalagardStaticImage::getImage" ref="a4a193897b6eb34235053825dac3bc49d" args="(void) const " -->
const <a class="el" href="classCEGUI_1_1Image.html">Image</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardStaticImage.html#a4a193897b6eb34235053825dac3bc49d">getImage</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the image for this <a class="el" href="classCEGUI_1_1FalagardStaticImage.html" title="StaticImage class for the FalagardBase module.">FalagardStaticImage</a> widget. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardStaticImage.html#ac4db89847521cb4813456bda406ccf6d">render</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Populate render cache. <a href="#ac4db89847521cb4813456bda406ccf6d"></a><br/></td></tr>
<tr><td colspan="2"><h2><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a1fa19b5dfd641c250deef875d3367aff"></a><!-- doxytag: member="CEGUI::FalagardStaticImage::TypeName" ref="a1fa19b5dfd641c250deef875d3367aff" args="[]" -->
static const utf8 </td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1FalagardStaticImage.html#a1fa19b5dfd641c250deef875d3367aff">TypeName</a> []</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">type name for this widget. <br/></td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a69366e12208b21dd085e397ba2b04d95"></a><!-- doxytag: member="CEGUI::FalagardStaticImage::d_image" ref="a69366e12208b21dd085e397ba2b04d95" args="" -->
const <a class="el" href="classCEGUI_1_1Image.html">Image</a> * </td><td class="memItemRight" valign="bottom"><b>d_image</b></td></tr>
<tr><td colspan="2"><h2><a name="pro-static-attribs"></a>
Static Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22a1e74d0368d64a7355e4ad874b2c2a"></a><!-- doxytag: member="CEGUI::FalagardStaticImage::d_imageProperty" ref="a22a1e74d0368d64a7355e4ad874b2c2a" args="" -->
static <br class="typebreak"/>
<a class="el" href="classCEGUI_1_1FalagardStaticImageProperties_1_1Image.html">FalagardStaticImageProperties::Image</a> </td><td class="memItemRight" valign="bottom"><b>d_imageProperty</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>StaticImage class for the FalagardBase module. </p>
<p>This class requires LookNFeel to be assigned. The LookNFeel should provide the following:</p>
<p>States:</p>
<ul>
<li>Enabled - basic rendering for enabled state.</li>
<li>Disabled - basic rendering for disabled state.</li>
<li>EnabledFrame - frame rendering for enabled state</li>
<li>DisabledFrame - frame rendering for disabled state.</li>
<li>WithFrameEnabledBackground - backdrop rendering for enabled state with frame enabled.</li>
<li>WithFrameDisabledBackground - backdrop rendering for disabled state with frame enabled.</li>
<li>NoFrameEnabledBackground - backdrop rendering for enabled state with frame disabled.</li>
<li>NoFrameDisabledBackground - backdrop rendering for disabled state with frame disabled.</li>
<li>WithFrameImage - image rendering when frame is enabled</li>
<li>NoFrameImage - image rendering when frame is disabled (defaults to WithFrameImage if not present) </li>
</ul>
</div><hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="ac4db89847521cb4813456bda406ccf6d"></a><!-- doxytag: member="CEGUI::FalagardStaticImage::render" ref="ac4db89847521cb4813456bda406ccf6d" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void CEGUI::FalagardStaticImage::render </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Populate render cache. </p>
<p>This method must be implemented by all window renderers and should perform the rendering operations needed for this widget. Normally using the Falagard API... </p>
<p>Reimplemented from <a class="el" href="classCEGUI_1_1FalagardStatic.html#af7a954733aa528d3dd2dfe20fb59752d">CEGUI::FalagardStatic</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Sun Jan 22 2012 16:07:42 for Crazy Eddies GUI System by 
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>
|