File: CastleWindow.TMenuItemRadioGroup.html

package info (click to toggle)
castle-game-engine 5.2.0-3
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 185,428 kB
  • sloc: pascal: 260,781; cpp: 1,363; objc: 713; makefile: 537; xml: 496; sh: 480; php: 4
file content (136 lines) | stat: -rw-r--r-- 9,237 bytes parent folder | download
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
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
<html>
<head>
<title>Castle Game Engine: CastleWindow: Class TMenuItemRadioGroup</title>
<meta name="generator" content="PasDoc 0.13.0">
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
</head>
<body>
<table class="container"><tr><td class="navigation">
<h2>Castle Game Engine</h2><p><a href="introduction.html" class="navigation">Introduction</a></p><p><a href="AllUnits.html" class="navigation">Units</a></p><p><a href="ClassHierarchy.html" class="navigation">Class Hierarchy</a></p><p><a href="AllClasses.html" class="navigation">Classes, Interfaces, Objects and Records</a></p><p><a href="AllTypes.html" class="navigation">Types</a></p><p><a href="AllVariables.html" class="navigation">Variables</a></p><p><a href="AllConstants.html" class="navigation">Constants</a></p><p><a href="AllFunctions.html" class="navigation">Functions and Procedures</a></p><p><a href="AllIdentifiers.html" class="navigation">Identifiers</a></p></td><td class="content">
<a name="TMenuItemRadioGroup"></a><h1 class="cio">Class TMenuItemRadioGroup</h1>
<table class="sections wide_list">
<tr>
<td><a class="section" href="#PasDoc-Description">Description</a></td><td><a class="section" href="#PasDoc-Hierarchy">Hierarchy</a></td><td>Fields</td><td><a class="section" href="#PasDoc-Methods">Methods</a></td><td><a class="section" href="#PasDoc-Properties">Properties</a></td></tr></table>
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
<p class="unitlink">
<a  href="CastleWindow.html">CastleWindow</a></p>
<h2 class="declaration">Declaration</h2>
<p class="declaration">
<code>type TMenuItemRadioGroup = class(specialize TFPGObjectList&lt;TMenuItemRadio&gt;)</code></p>
<h2 class="description">Description</h2>
<p>
A group of radio buttons.

<p>An instance of this object is always created and destroyed automatically by <a class="normal" href="CastleWindow.TMenuItemRadio.html">TMenuItemRadio</a> objects. All <a class="normal" href="CastleWindow.TMenuItemRadio.html">TMenuItemRadio</a> within the same group share the same <code>TMenuItemRadioGroup</code> instance.

<p>Never modify anything within this group using general TFPGObjectList properties. Instead always use methods defined here.</p>
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
<ul class="hierarchy"><li class="ancestor">TFPGObjectList</li>
<li class="thisitem">TMenuItemRadioGroup</li></ul><h2 class="overview">Overview</h2>
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a  href="CastleWindow.TMenuItemRadioGroup.html#Add">Add</a></b>(Item: <a  href="CastleWindow.TMenuItemRadio.html">TMenuItemRadio</a>);</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>procedure <b><a  href="CastleWindow.TMenuItemRadioGroup.html#Remove">Remove</a></b>(Item: <a  href="CastleWindow.TMenuItemRadio.html">TMenuItemRadio</a>);</code></td>
</tr>
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleWindow.TMenuItemRadioGroup.html#Previous">Previous</a></b>(out Item: <a  href="CastleWindow.TMenuItemRadio.html">TMenuItemRadio</a>): boolean;</code></td>
</tr>
<tr class="list2">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>function <b><a  href="CastleWindow.TMenuItemRadioGroup.html#Next">Next</a></b>(out Item: <a  href="CastleWindow.TMenuItemRadio.html">TMenuItemRadio</a>): boolean;</code></td>
</tr>
</table>
<a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
<table class="summary wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><code>property <b><a  href="CastleWindow.TMenuItemRadioGroup.html#Selected">Selected</a></b>: <a  href="CastleWindow.TMenuItemRadio.html">TMenuItemRadio</a> read FSelected write SetSelected;</code></td>
</tr>
</table>
<h2 class="description">Description</h2>
<h3 class="detail">Methods</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Add"></a><code>procedure <b>Add</b>(Item: <a  href="CastleWindow.TMenuItemRadio.html">TMenuItemRadio</a>);</code></td>
</tr>
<tr><td colspan="2">
<p>
Adds an existing radio menu item to this group. After this, Item.Group will point to this group object.

<p>Note that Item.Checked may be changed to <code>False</code> if there already is a selected item in this group. If the added item already has Item.Checked = <code>False</code> then for sure it will not be changed (SelectedIndex can be left as -1).</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Remove"></a><code>procedure <b>Remove</b>(Item: <a  href="CastleWindow.TMenuItemRadio.html">TMenuItemRadio</a>);</code></td>
</tr>
<tr><td colspan="2">
&nbsp;</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Previous"></a><code>function <b>Previous</b>(out Item: <a  href="CastleWindow.TMenuItemRadio.html">TMenuItemRadio</a>): boolean;</code></td>
</tr>
<tr><td colspan="2">
<p>
Return <code>previous</code> (from <a class="normal" href="CastleWindow.TMenuItemRadioGroup.html#Selected">Selected</a>) menu item in this group. If there is no <code>previous</code> item, but still <a class="normal" href="CastleWindow.TMenuItemRadioGroup.html#Selected">Selected</a> &lt;&gt; nil, return <a class="normal" href="CastleWindow.TMenuItemRadioGroup.html#Selected">Selected</a>. Only when there's no <a class="normal" href="CastleWindow.TMenuItemRadioGroup.html#Selected">Selected</a> item, returns <code>False</code>.</p>
</td></tr>
</table>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Next"></a><code>function <b>Next</b>(out Item: <a  href="CastleWindow.TMenuItemRadio.html">TMenuItemRadio</a>): boolean;</code></td>
</tr>
<tr><td colspan="2">
<p>
Return <code>next</code> (from <a class="normal" href="CastleWindow.TMenuItemRadioGroup.html#Selected">Selected</a>) menu item in this group. If there is no <code>next</code> item, but still <a class="normal" href="CastleWindow.TMenuItemRadioGroup.html#Selected">Selected</a> &lt;&gt; nil, return <a class="normal" href="CastleWindow.TMenuItemRadioGroup.html#Selected">Selected</a>. Only when there's no <a class="normal" href="CastleWindow.TMenuItemRadioGroup.html#Selected">Selected</a> item, returns <code>False</code>.</p>
</td></tr>
</table>
<h3 class="detail">Properties</h3>
<table class="detail wide_list">
<tr class="list">
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
<td class="itemcode"><a name="Selected"></a><code>property <b>Selected</b>: <a  href="CastleWindow.TMenuItemRadio.html">TMenuItemRadio</a> read FSelected write SetSelected;</code></td>
</tr>
<tr><td colspan="2">
<p>
This is the only currently Checked item.

<p>It can be nil if no item is checked currently (this can happen if you added all initial items with Checked = <code>False</code>, or if you later removed the checked item from the group; we need a state to represent this situation, that's why it's allowed for radio group to have none radio item chosen).</p>
</td></tr>
</table>
<!-- Piwik -->
<script type="text/javascript">
  var _paq = _paq || [];
  _paq.push(["trackPageView"]);
  _paq.push(["enableLinkTracking"]);

  (function() {
    var u=(("https:" == document.location.protocol) ? "https" : "http") + "://michalis.ii.uni.wroc.pl/piwik-castle-engine/";
    _paq.push(["setTrackerUrl", u+"piwik.php"]);
    _paq.push(["setSiteId", "1"]);
    var d=document, g=d.createElement("script"), s=d.getElementsByTagName("script")[0]; g.type="text/javascript";
    g.defer=true; g.async=true; g.src=u+"piwik.js"; s.parentNode.insertBefore(g,s);
  })();
</script>
<!-- End Piwik Code -->

<noscript>
<!-- Piwik Image Tracker -->
<img src="http://michalis.ii.uni.wroc.pl/piwik-castle-engine/piwik.php?idsite=1&amp;rec=1" style="border:0" alt="" />
<!-- End Piwik -->
</noscript>
<hr noshade size="1"><span class="appinfo"><em>Generated by <a  href="http://pasdoc.sourceforge.net/">PasDoc 0.13.0</a> on 2015-06-15 04:43:13</em>
</span>
</td></tr></table></body></html>