blob: 65ca92867ba8de6cbb6c27ef0407758a7a70ee8f [file]
<!DOCTYPE html>
<html>
<!-- Created by Texinfo 6.8dev+dev, http://www.gnu.org/software/texinfo/ -->
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!-- This manual is for GNU Texinfo (version 6.8dev, 23 February 2022),
a documentation system that can produce both online information and a
printed manual from a single source using semantic markup.
Copyright (C) 1988, 1990-1993, 1995-1999, 2001-2022 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
Texts. A copy of the license is included in the section entitled
"GNU Free Documentation License". -->
<title>Object-Oriented Variables (GNU Texinfo 6.8dev)</title>
<meta name="description" content="Object-Oriented Variables (GNU Texinfo 6.8dev)">
<meta name="keywords" content="Object-Oriented Variables (GNU Texinfo 6.8dev)">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="texi2any">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link href="index.html" rel="start" title="Top">
<link href="Command-and-Variable-Index.html" rel="index" title="Command and Variable Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="Abstract-Objects.html" rel="up" title="Abstract Objects">
<link href="Object_002dOriented-Methods.html" rel="next" title="Object-Oriented Methods">
<style type="text/css">
<!--
a.copiable-link {visibility: hidden; text-decoration: none; line-height: 0em}
div.example {margin-left: 3.2em}
span:hover a.copiable-link {visibility: visible}
-->
</style>
</head>
<body lang="en">
<div class="subsubsection-level-extent" id="Object_002dOriented-Variables">
<div class="nav-panel">
<p>
Next: <a href="Object_002dOriented-Methods.html" accesskey="n" rel="next">Object-Oriented Methods</a>, Up: <a href="Abstract-Objects.html" accesskey="u" rel="up">Object-Oriented Programming</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<h4 class="subsubsection" id="Object_002dOriented-Variables-1">13.5.6.1 Object-Oriented Variables</h4>
<a class="index-entry-id" id="index-Variables_002c-object_002doriented"></a>
<p>These commands allow you to define different sorts of variables in
object-oriented programming languages.
</p>
<dl class="table">
<dt id='index-defcv'><span><code class="code">@defcv <var class="var">category</var> <var class="var">class</var> <var class="var">name</var></code><a class="copiable-link" href='#index-defcv'> &para;</a></span></dt>
<dd><p>The <code class="code">@defcv</code> command is the general definition command for
variables associated with classes in object-oriented programming. The
<code class="code">@defcv</code> command is followed by three arguments: the category of
thing being defined, the class to which it belongs, and its
name. For instance:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">@defcv {Class Option} Window border-pattern
&hellip;
@end defcv
</pre></div></div>
<p>produces:
</p><dl class="first-defcv">
<dt class="defcv" id="index-border_002dpattern"><span>Class Option of Window: <strong class="strong">border-pattern</strong><a class="copiable-link" href='#index-border_002dpattern'> &para;</a></span></dt>
<dd><p>&hellip;
</p></dd></dl>
<p><code class="code">@defcv</code> creates an entry in the index of variables.
</p>
</dd>
<dt id='index-deftypecv'><span><code class="code">@deftypecv <var class="var">category</var> <var class="var">class</var> <var class="var">data-type</var> <var class="var">name</var></code><a class="copiable-link" href='#index-deftypecv'> &para;</a></span></dt>
<dd><p>The <code class="code">@deftypecv</code> command is the definition command for typed
class variables in object-oriented programming. It is analogous to
<code class="code">@defcv</code> with the addition of the <var class="var">data-type</var> parameter to
specify the type of the instance variable. Ordinarily, the data type
is a programming language construct that should be marked with
<code class="code">@code</code>. For instance:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">@deftypecv {Class Option} Window @code{int} border-pattern
&hellip;
@end deftypecv
</pre></div></div>
<p>produces:
</p>
<dl class="first-deftypecv">
<dt class="deftypecv" id="index-border_002dpattern-of-Window"><span>Class Option of Window: <em class="emph"><code class="code">int</code></em> <strong class="strong">border-pattern</strong><a class="copiable-link" href='#index-border_002dpattern-of-Window'> &para;</a></span></dt>
<dd><p>&hellip;
</p></dd></dl>
<p><code class="code">@deftypecv</code> creates an entry in the index of variables.
</p>
</dd>
<dt id='index-defivar'><span><code class="code">@defivar <var class="var">class</var> <var class="var">name</var></code><a class="copiable-link" href='#index-defivar'> &para;</a></span></dt>
<dd><p>The <code class="code">@defivar</code> command is the definition command for instance
variables in object-oriented programming. <code class="code">@defivar</code> is
equivalent to &lsquo;<samp class="samp">@defcv {Instance Variable} &hellip;</samp>&rsquo;. For
instance:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">@defivar Window border-pattern
&hellip;
@end defivar
</pre></div></div>
<p>produces:
</p>
<dl class="first-defcv first-defivar-alias-first-defcv">
<dt class="defcv defivar-alias-defcv" id="index-border_002dpattern-of-Window-1"><span>Instance Variable of Window: <strong class="strong">border-pattern</strong><a class="copiable-link" href='#index-border_002dpattern-of-Window-1'> &para;</a></span></dt>
<dd><p>&hellip;
</p></dd></dl>
<p><code class="code">@defivar</code> creates an entry in the index of variables.
</p>
</dd>
<dt id='index-deftypeivar'><span><code class="code">@deftypeivar <var class="var">class</var> <var class="var">data-type</var> <var class="var">name</var></code><a class="copiable-link" href='#index-deftypeivar'> &para;</a></span></dt>
<dd><p>The <code class="code">@deftypeivar</code> command is the definition command for typed
instance variables in object-oriented programming. It is analogous to
<code class="code">@defivar</code> with the addition of the <var class="var">data-type</var> parameter to
specify the type of the instance variable. Ordinarily, the data type
is a programming language construct that should be marked with
<code class="code">@code</code>. For instance:
</p>
<div class="example">
<div class="group"><pre class="example-preformatted">@deftypeivar Window @code{int} border-pattern
&hellip;
@end deftypeivar
</pre></div></div>
<p>produces:
</p>
<dl class="first-deftypecv first-deftypeivar-alias-first-deftypecv">
<dt class="deftypecv deftypeivar-alias-deftypecv" id="index-border_002dpattern-of-Window-2"><span>Instance Variable of Window: <em class="emph"><code class="code">int</code></em> <strong class="strong">border-pattern</strong><a class="copiable-link" href='#index-border_002dpattern-of-Window-2'> &para;</a></span></dt>
<dd><p>&hellip;
</p></dd></dl>
<p><code class="code">@deftypeivar</code> creates an entry in the index of variables.
</p>
</dd>
</dl>
</div>
<hr>
<div class="nav-panel">
<p>
Next: <a href="Object_002dOriented-Methods.html">Object-Oriented Methods</a>, Up: <a href="Abstract-Objects.html">Object-Oriented Programming</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Command-and-Variable-Index.html" title="Index" rel="index">Index</a>]</p>
</div>
</body>
</html>