Overview   Project   Class   Tree   Deprecated   Index 
SourceFlow 1.0.beta API Documentation
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD

Org.SourceFlow.VisualBasic
Class VisualBasicEnumeration

IComparable
   |
   +--CodeElement
         |
         +--CodeContainer
               |
               +--VisualBasicType
                     |
                     +--VisualBasicEnumeration

   in VisualBasicEnumeration.cs

public class VisualBasicEnumeration
extends VisualBasicType

A class generating a Visual Basic enumeration declaration.


Field Summary
 override int Category
          Returns a numeric category number for the code element.
 const int FRIEND
          The friend access modifier constant.
 const int PRIVATE
          The private access modifier constant.
 const int PROTECTED
          The protected access modifier constant.
 const int PROTECTED_FRIEND
          The protected friend access modifier constant.
 const int PUBLIC
          The public access modifier constant.
 const int SHADOWS
          The shadows modifier constant.
   
Fields inherited from class VisualBasicType
modifiers, name, extendTypes, comment
   
Fields inherited from class CodeContainer
Count
   
Fields inherited from class CodeElement
Category
 
Constructor Summary
VisualBasicEnumeration( string name )
          Creates a new enumeration code generator with public access.
VisualBasicEnumeration( int modifiers, string name )
          Creates a new enumeration code generator with the specified modifiers.
 
Method Summary
 void AddConstant( string name )
          Adds a constant to the enumeration.
 void AddConstant( string name, string value )
          Adds a constant to the enumeration.
 void AddConstant( string name, string value, VisualBasicComment comment )
          Adds a constant to the enumeration.
 override void Print( StreamWriter output, CodeStyle style, int indent )
          Prints the code element to the specified output stream.
   
Methods inherited from class VisualBasicType
ToString, AddComment, Print
   
Methods inherited from class CodeContainer
AddElement, PrintContents
   
Methods inherited from class CodeElement
CompareTo, Print, PrintSeparator
 

Field Detail

Category

public override int Category;
Returns a numeric category number for the code element. A lower category number implies that the code element should be placed before code elements with a higher category number within a declaration.
Returns:
the category number

FRIEND

public const int FRIEND;
The friend access modifier constant.

PRIVATE

public const int PRIVATE;
The private access modifier constant. May only be used when declared inside another type.

PROTECTED

public const int PROTECTED;
The protected access modifier constant. May only be used when declared inside another type.

PROTECTED_FRIEND

public const int PROTECTED_FRIEND;
The protected friend access modifier constant. May only be used when declared inside another type.

PUBLIC

public const int PUBLIC;
The public access modifier constant.

SHADOWS

public const int SHADOWS;
The shadows modifier constant. May only be used when declared inside another type.


Constructor Detail

VisualBasicEnumeration

public VisualBasicEnumeration( string name );
Creates a new enumeration code generator with public access.
Parameters:
name - the enumeration name

VisualBasicEnumeration

public VisualBasicEnumeration( int modifiers, string name );
Creates a new enumeration code generator with the specified modifiers.
Parameters:
modifiers - the modifier flag constants
name - the enumeration name


Method Detail

AddConstant

public void AddConstant( string name );
Adds a constant to the enumeration.
Parameters:
name - the constant name

AddConstant

public void AddConstant( string name, string value );
Adds a constant to the enumeration.
Parameters:
name - the constant name
value - the constant value

AddConstant

public void AddConstant( string name, string value, VisualBasicComment comment );
Adds a constant to the enumeration.
Parameters:
name - the constant name
value - the constant value, or null
comment - the constant comment

Print

public override void Print( StreamWriter output, CodeStyle style, int indent );
Prints the code element to the specified output stream.
Parameters:
output - the output stream
style - the code style to use
indent - the indentation level

 Overview   Project   Class   Tree   Deprecated   Index 
SourceFlow 1.0.beta API Documentation
FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD