~ubuntu-branches/debian/wheezy/cegui-mk2/wheezy

« back to all changes in this revision

Viewing changes to docs/classCEGUI_1_1MultiLineEditboxWindowRenderer.html

  • Committer: Package Import Robot
  • Author(s): Muammar El Khatib
  • Date: 2011-10-13 12:43:12 UTC
  • mfrom: (10.1.5 experimental)
  • Revision ID: package-import@ubuntu.com-20111013124312-qch0o3fayloxgxu3
Tags: 0.7.5-7
Moved to unstable. (Closes: #645109)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 
5
<title>Crazy Eddies GUI System: CEGUI::MultiLineEditboxWindowRenderer Class Reference</title>
 
6
<link href="tabs.css" rel="stylesheet" type="text/css"/>
 
7
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
 
8
</head>
 
9
<body>
 
10
<!-- Generated by Doxygen 1.7.2 -->
 
11
<script type="text/javascript">
 
12
function hasClass(ele,cls) {
 
13
  return ele.className.match(new RegExp('(\\s|^)'+cls+'(\\s|$)'));
 
14
}
 
15
 
 
16
function addClass(ele,cls) {
 
17
  if (!this.hasClass(ele,cls)) ele.className += " "+cls;
 
18
}
 
19
 
 
20
function removeClass(ele,cls) {
 
21
  if (hasClass(ele,cls)) {
 
22
    var reg = new RegExp('(\\s|^)'+cls+'(\\s|$)');
 
23
    ele.className=ele.className.replace(reg,' ');
 
24
  }
 
25
}
 
26
 
 
27
function toggleVisibility(linkObj) {
 
28
 var base = linkObj.getAttribute('id');
 
29
 var summary = document.getElementById(base + '-summary');
 
30
 var content = document.getElementById(base + '-content');
 
31
 var trigger = document.getElementById(base + '-trigger');
 
32
 if ( hasClass(linkObj,'closed') ) {
 
33
   summary.style.display = 'none';
 
34
   content.style.display = 'block';
 
35
   trigger.src = 'open.png';
 
36
   removeClass(linkObj,'closed');
 
37
   addClass(linkObj,'opened');
 
38
 } else if ( hasClass(linkObj,'opened') ) {
 
39
   summary.style.display = 'block';
 
40
   content.style.display = 'none';
 
41
   trigger.src = 'closed.png';
 
42
   removeClass(linkObj,'opened');
 
43
   addClass(linkObj,'closed');
 
44
 }
 
45
 return false;
 
46
}
 
47
</script>
 
48
<div class="navigation" id="top">
 
49
  <div class="tabs">
 
50
    <ul class="tablist">
 
51
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
 
52
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
 
53
      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
 
54
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
 
55
      <li><a href="files.html"><span>Files</span></a></li>
 
56
    </ul>
 
57
  </div>
 
58
  <div class="tabs2">
 
59
    <ul class="tablist">
 
60
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
 
61
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
 
62
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
 
63
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
 
64
    </ul>
 
65
  </div>
 
66
  <div class="navpath">
 
67
    <ul>
 
68
      <li><a class="el" href="namespaceCEGUI.html">CEGUI</a>      </li>
 
69
      <li><a class="el" href="classCEGUI_1_1MultiLineEditboxWindowRenderer.html">MultiLineEditboxWindowRenderer</a>      </li>
 
70
    </ul>
 
71
  </div>
 
72
</div>
 
73
<div class="header">
 
74
  <div class="summary">
 
75
<a href="#pub-methods">Public Member Functions</a> &#124;
 
76
<a href="#pro-methods">Protected Member Functions</a>  </div>
 
77
  <div class="headertitle">
 
78
<h1>CEGUI::MultiLineEditboxWindowRenderer Class Reference</h1>  </div>
 
79
</div>
 
80
<div class="contents">
 
81
<!-- doxytag: class="CEGUI::MultiLineEditboxWindowRenderer" --><!-- doxytag: inherits="CEGUI::WindowRenderer" -->
 
82
<p>Base class for multi-line edit box window renderer objects.  
 
83
<a href="#_details">More...</a></p>
 
84
<!-- startSectionHeader --><div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
 
85
  <img id="dynsection-0-trigger" src="closed.png"/> Inheritance diagram for CEGUI::MultiLineEditboxWindowRenderer:<!-- endSectionHeader --></div>
 
86
<!-- startSectionSummary --><div id="dynsection-0-summary" class="dynsummary" style="display:block;">
 
87
<!-- endSectionSummary --></div>
 
88
<!-- startSectionContent --><div id="dynsection-0-content" class="dyncontent" style="display:none;">
 
89
<div class="center"><img src="classCEGUI_1_1MultiLineEditboxWindowRenderer__inherit__graph.gif" border="0" usemap="#CEGUI_1_1MultiLineEditboxWindowRenderer_inherit__map" alt="Inheritance graph"/></div>
 
90
<map name="CEGUI_1_1MultiLineEditboxWindowRenderer_inherit__map" id="CEGUI_1_1MultiLineEditboxWindowRenderer_inherit__map">
 
91
<area shape="rect" id="node5" href="classCEGUI_1_1FalagardMultiLineEditbox.html" title="MultiLineEditbox class for the FalagardBase module." alt="" coords="31,160,257,189"/><area shape="rect" id="node2" href="classCEGUI_1_1WindowRenderer.html" title="Base&#45;class for the assignable WindowRenderer object." alt="" coords="57,5,231,35"/></map>
 
92
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
 
93
<!-- startSectionHeader --><div id="dynsection-1" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
 
94
  <img id="dynsection-1-trigger" src="closed.png"/> Collaboration diagram for CEGUI::MultiLineEditboxWindowRenderer:<!-- endSectionHeader --></div>
 
95
<!-- startSectionSummary --><div id="dynsection-1-summary" class="dynsummary" style="display:block;">
 
96
<!-- endSectionSummary --></div>
 
97
<!-- startSectionContent --><div id="dynsection-1-content" class="dyncontent" style="display:none;">
 
98
<div class="center"><img src="classCEGUI_1_1MultiLineEditboxWindowRenderer__coll__graph.gif" border="0" usemap="#CEGUI_1_1MultiLineEditboxWindowRenderer_coll__map" alt="Collaboration graph"/></div>
 
99
<map name="CEGUI_1_1MultiLineEditboxWindowRenderer_coll__map" id="CEGUI_1_1MultiLineEditboxWindowRenderer_coll__map">
 
100
<area shape="rect" id="node2" href="classCEGUI_1_1WindowRenderer.html" title="Base&#45;class for the assignable WindowRenderer object." alt="" coords="164,199,337,228"/><area shape="rect" id="node6" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv..." alt="" coords="307,387,424,416"/><area shape="rect" id="node4" href="classCEGUI_1_1String.html" title="String class used within the GUI system." alt="" coords="315,5,421,35"/></map>
 
101
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center><!-- endSectionContent --></div>
 
102
 
 
103
<p><a href="classCEGUI_1_1MultiLineEditboxWindowRenderer-members.html">List of all members.</a></p>
 
104
<table class="memberdecls">
 
105
<tr><td colspan="2"><h2><a name="pub-methods"></a>
 
106
Public Member Functions</h2></td></tr>
 
107
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a25be292ec046815f1ef66c0866918468"></a><!-- doxytag: member="CEGUI::MultiLineEditboxWindowRenderer::MultiLineEditboxWindowRenderer" ref="a25be292ec046815f1ef66c0866918468" args="(const String &amp;name)" -->
 
108
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MultiLineEditboxWindowRenderer.html#a25be292ec046815f1ef66c0866918468">MultiLineEditboxWindowRenderer</a> (const <a class="el" href="classCEGUI_1_1String.html">String</a> &amp;name)</td></tr>
 
109
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <br/></td></tr>
 
110
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="classCEGUI_1_1Rect.html">Rect</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MultiLineEditboxWindowRenderer.html#ac7d2daac486d9f21bcb7e801f38210cb">getTextRenderArea</a> (void) const =0</td></tr>
 
111
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object describing, in un-clipped pixels, the window relative area that the text should be rendered in to.  <a href="#ac7d2daac486d9f21bcb7e801f38210cb"></a><br/></td></tr>
 
112
<tr><td colspan="2"><h2><a name="pro-methods"></a>
 
113
Protected Member Functions</h2></td></tr>
 
114
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a783968dde37124bdd91e6adb7903f586"></a><!-- doxytag: member="CEGUI::MultiLineEditboxWindowRenderer::onLookNFeelAssigned" ref="a783968dde37124bdd91e6adb7903f586" args="()" -->
 
115
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classCEGUI_1_1MultiLineEditboxWindowRenderer.html#a783968dde37124bdd91e6adb7903f586">onLookNFeelAssigned</a> ()</td></tr>
 
116
<tr><td class="mdescLeft">&#160;</td><td class="mdescRight">Handler called when a Look'N'Feel is assigned to our window. <br/></td></tr>
 
117
</table>
 
118
<hr/><a name="_details"></a><h2>Detailed Description</h2>
 
119
<p>Base class for multi-line edit box window renderer objects. </p>
 
120
<hr/><h2>Member Function Documentation</h2>
 
121
<a class="anchor" id="ac7d2daac486d9f21bcb7e801f38210cb"></a><!-- doxytag: member="CEGUI::MultiLineEditboxWindowRenderer::getTextRenderArea" ref="ac7d2daac486d9f21bcb7e801f38210cb" args="(void) const =0" -->
 
122
<div class="memitem">
 
123
<div class="memproto">
 
124
      <table class="memname">
 
125
        <tr>
 
126
          <td class="memname">virtual <a class="el" href="classCEGUI_1_1Rect.html">Rect</a> CEGUI::MultiLineEditboxWindowRenderer::getTextRenderArea </td>
 
127
          <td>(</td>
 
128
          <td class="paramtype">void&#160;</td>
 
129
          <td class="paramname">&#160;)</td>
 
130
          <td> const<code> [pure virtual]</code></td>
 
131
        </tr>
 
132
      </table>
 
133
</div>
 
134
<div class="memdoc">
 
135
 
 
136
<p>Return a <a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object describing, in un-clipped pixels, the window relative area that the text should be rendered in to. </p>
 
137
<dl class="return"><dt><b>Returns:</b></dt><dd><a class="el" href="classCEGUI_1_1Rect.html" title="Class encapsulating operations on a Rectangle.">Rect</a> object describing the area of the <a class="el" href="classCEGUI_1_1Window.html" title="An abstract base class providing common functionality and specifying the required interface for deriv...">Window</a> to be used for rendering text. </dd></dl>
 
138
 
 
139
<p>Implemented in <a class="el" href="classCEGUI_1_1FalagardMultiLineEditbox.html#ac1fb842219eb440ec8f4f6af99d238dc">CEGUI::FalagardMultiLineEditbox</a>.</p>
 
140
 
 
141
</div>
 
142
</div>
 
143
</div>
 
144
<hr class="footer"/><address class="footer"><small>Generated on Fri Nov 19 2010 12:01:22 for Crazy Eddies GUI System by&#160;
 
145
<a href="http://www.doxygen.org/index.html">
 
146
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.2 </small></address>
 
147
</body>
 
148
</html>