---

13.5.6.1 Object-Oriented Variables

These commands allow you to define different sorts of variables in object-oriented programming languages.

@defcv category class name ¶

The @defcv command is the general definition command for variables associated with classes in object-oriented programming. The @defcv command is followed by three arguments: the category of thing being defined, the class to which it belongs, and its name. For instance:

@defcv {Class Option} Window border-pattern
…
@end defcv

produces:

Class Option of Window: border-pattern ¶

…

@defcv creates an entry in the index of variables.

@deftypecv category class data-type name ¶

The @deftypecv command is the definition command for typed class variables in object-oriented programming. It is analogous to @defcv with the addition of the data-type parameter to specify the type of the instance variable. Ordinarily, the data type is a programming language construct that should be marked with @code. For instance:

@deftypecv {Class Option} Window @code{int} border-pattern
…
@end deftypecv

produces:

Class Option of Window: int border-pattern ¶

…

@deftypecv creates an entry in the index of variables.

@defivar class name ¶

The @defivar command is the definition command for instance variables in object-oriented programming. @defivar is equivalent to ‘@defcv {Instance Variable} …’. For instance:

@defivar Window border-pattern
…
@end defivar

produces:

Instance Variable of Window: border-pattern ¶

…

@defivar creates an entry in the index of variables.

@deftypeivar class data-type name ¶

The @deftypeivar command is the definition command for typed instance variables in object-oriented programming. It is analogous to @defivar with the addition of the data-type parameter to specify the type of the instance variable. Ordinarily, the data type is a programming language construct that should be marked with @code. For instance:

@deftypeivar Window @code{int} border-pattern
…
@end deftypeivar

produces:

Instance Variable of Window: int border-pattern ¶

…

@deftypeivar creates an entry in the index of variables.