~ubuntu-branches/ubuntu/utopic/castle-game-engine/utopic

« back to all changes in this revision

Viewing changes to doc/pasdoc/html/CastleWindow.TMenuEntryWithCaption.html

  • Committer: Package Import Robot
  • Author(s): Abou Al Montacir
  • Date: 2013-04-27 18:06:40 UTC
  • Revision ID: package-import@ubuntu.com-20130427180640-eink4nmwzuivez1c
Tags: upstream-4.0.1
ImportĀ upstreamĀ versionĀ 4.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/1999/REC-html401-19991224/loose.dtd">
 
2
<html>
 
3
<head>
 
4
<title>Castle Game Engine: CastleWindow: Class TMenuEntryWithCaption</title>
 
5
<meta name="generator" content="PasDoc 0.12.1">
 
6
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1">
 
7
<link rel="StyleSheet" type="text/css" href="pasdoc.css">
 
8
</head>
 
9
<body>
 
10
<table class="container"><tr><td class="navigation">
 
11
<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">
 
12
<a name="TMenuEntryWithCaption"></a><h1 class="cio">Class TMenuEntryWithCaption</h1>
 
13
<table class="sections wide_list">
 
14
<tr>
 
15
<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>
 
16
<a name="PasDoc-Description"></a><h2 class="unit">Unit</h2>
 
17
<p class="unitlink">
 
18
<a  href="CastleWindow.html">CastleWindow</a></p>
 
19
<h2 class="declaration">Declaration</h2>
 
20
<p class="declaration">
 
21
<code>type TMenuEntryWithCaption = class(<a class="normal" href="CastleWindow.TMenuEntry.html">TMenuEntry</a>)</code></p>
 
22
<h2 class="description">Description</h2>
 
23
<div class="nodescription">no description available, TMenuEntry description follows</div><p>
 
24
A basic class representing basic menu building block. This can be a separator, clickable menu item or something that expands to submenu.</p>
 
25
<a name="PasDoc-Hierarchy"></a><h2 class="hierarchy">Hierarchy</h2>
 
26
<ul class="hierarchy"><li class="ancestor">TObject</li>
 
27
<li class="ancestor"><a class="normal" href="CastleWindow.TMenuEntry.html">TMenuEntry</a></li>
 
28
<li class="thisitem">TMenuEntryWithCaption</li></ul><h2 class="overview">Overview</h2>
 
29
<a name="PasDoc-Methods"></a><h3 class="summary">Methods</h3>
 
30
<table class="summary wide_list">
 
31
<tr class="list">
 
32
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
33
<td class="itemcode"><code>constructor <b><a  href="CastleWindow.TMenuEntryWithCaption.html#Create">Create</a></b>(const ACaption: String);</code></td>
 
34
</tr>
 
35
</table>
 
36
<a name="PasDoc-Properties"></a><h3 class="summary">Properties</h3>
 
37
<table class="summary wide_list">
 
38
<tr class="list">
 
39
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
40
<td class="itemcode"><code>property <b><a  href="CastleWindow.TMenuEntryWithCaption.html#Caption">Caption</a></b>: String read FCaption write SetCaption;</code></td>
 
41
</tr>
 
42
<tr class="list2">
 
43
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
44
<td class="itemcode"><code>property <b><a  href="CastleWindow.TMenuEntryWithCaption.html#Enabled">Enabled</a></b>: boolean read FEnabled write SetEnabled
 
45
      default true;</code></td>
 
46
</tr>
 
47
</table>
 
48
<h2 class="description">Description</h2>
 
49
<h3 class="detail">Methods</h3>
 
50
<table class="detail wide_list">
 
51
<tr class="list">
 
52
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
53
<td class="itemcode"><a name="Create"></a><code>constructor <b>Create</b>(const ACaption: String);</code></td>
 
54
</tr>
 
55
<tr><td colspan="2">
 
56
&nbsp;</td></tr>
 
57
</table>
 
58
<h3 class="detail">Properties</h3>
 
59
<table class="detail wide_list">
 
60
<tr class="list">
 
61
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
62
<td class="itemcode"><a name="Caption"></a><code>property <b>Caption</b>: String read FCaption write SetCaption;</code></td>
 
63
</tr>
 
64
<tr><td colspan="2">
 
65
<p>
 
66
Caption of this menu entry. Will be shown to user.
 
67
 
 
68
<p>To indicate that some letter of a caption is a mnemonic for this menu item put '_' (underscore) char before this letter. Depending on <a class="normal" href="CastleWindow.html">CastleWindow</a>-backend-dependent, mnemonics should allow user to easier activate this menu item with keyboard (e.g. Alt+mnemonic to dropdown item in MainMenu).
 
69
 
 
70
<p>You can put two consecutive underscore chars in Caption to indicate that here Caption should display literally one underscore character.
 
71
 
 
72
<p>(Convention to mark mnemonics with '_' is just copied from gtk, from gtk_label_new_with_mnemonic. So no, I didn't invent another new convention here.)
 
73
 
 
74
<p>It is undefined what will happen if you put underscore chars before *two* or more letters in Caption. I.e. you can't define multiple mnemonics for one menu item. I.e. this will not crash your program, but results may be <a class="normal" href="CastleWindow.html">CastleWindow</a>-backend-dependent.
 
75
 
 
76
<p>Just like in GTK toolkit gtk_label_new_with_mnemonic and gtk_menu_item_new_with_mnemonic.</p>
 
77
</td></tr>
 
78
</table>
 
79
<table class="detail wide_list">
 
80
<tr class="list">
 
81
<td class="visibility"><a  href="legend.html"><img  src="public.gif" alt="Public" title="Public"></a></td>
 
82
<td class="itemcode"><a name="Enabled"></a><code>property <b>Enabled</b>: boolean read FEnabled write SetEnabled
 
83
      default true;</code></td>
 
84
</tr>
 
85
<tr><td colspan="2">
 
86
&nbsp;</td></tr>
 
87
</table>
 
88
<hr noshade size="1"><span class="appinfo"><em>Generated by <a  href="http://pasdoc.sourceforge.net/">PasDoc 0.12.1</a> on 2013-02-04 20:26:53</em>
 
89
</span>
 
90
</td></tr></table></body></html>