types.h 文件参考

This file contains a number of basic enums and types. 更多...

#include "qcstring.h"

types.h 的引用(Include)关系图:

此图展示该文件直接或间接的被哪些文件引用了:

浏览源代码.

类
struct	Grouping
	Grouping info 更多...
class	LocalToc

枚举
enum	Protection { Public, Protected, Private, Package }
	Protection level of members 更多...
enum	Specifier { Normal, Virtual, Pure }
	Virtualness of a member. 更多...
enum	MethodTypes {   Method, Signal, Slot, DCOP,   Property, Event }
	Kind of method 更多...
enum	RelatesType { Simple, Duplicate, MemberOf }
	Type of member relation 更多...
enum	Relationship { Member, Related, Foreign }
	Kind of member relationship 更多...
enum	SrcLangExt {   SrcLangExt_Unknown = 0x00000, SrcLangExt_IDL = 0x00008, SrcLangExt_Java = 0x00010, SrcLangExt_CSharp = 0x00020,   SrcLangExt_D = 0x00040, SrcLangExt_PHP = 0x00080, SrcLangExt_ObjC = 0x00100, SrcLangExt_Cpp = 0x00200,   SrcLangExt_JS = 0x00400, SrcLangExt_Python = 0x00800, SrcLangExt_Fortran = 0x01000, SrcLangExt_VHDL = 0x02000,   SrcLangExt_XML = 0x04000, SrcLangExt_Markdown = 0x10000, SrcLangExt_SQL = 0x20000, SrcLangExt_Slice = 0x40000,   SrcLangExt_Lex = 0x80000 }
	Language as given by extension 更多...
enum	MemberListType {   MemberListType_privateLists = 0x0800, MemberListType_detailedLists = 0x1000, MemberListType_declarationLists = 0x2000, MemberListType_documentationLists = 0x4000,   MemberListType_pubMethods = 0, MemberListType_proMethods = 1, MemberListType_pacMethods = 2, MemberListType_priMethods = 3 + MemberListType_privateLists,   MemberListType_pubStaticMethods = 4, MemberListType_proStaticMethods = 5, MemberListType_pacStaticMethods = 6, MemberListType_priStaticMethods = 7 + MemberListType_privateLists,   MemberListType_pubSlots = 8, MemberListType_proSlots = 9, MemberListType_priSlots = 10 + MemberListType_privateLists, MemberListType_pubAttribs = 11,   MemberListType_proAttribs = 12, MemberListType_pacAttribs = 13, MemberListType_priAttribs = 14 + MemberListType_privateLists, MemberListType_pubStaticAttribs = 15,   MemberListType_proStaticAttribs = 16, MemberListType_pacStaticAttribs = 17, MemberListType_priStaticAttribs = 18 + MemberListType_privateLists, MemberListType_pubTypes = 19,   MemberListType_proTypes = 20, MemberListType_pacTypes = 21, MemberListType_priTypes = 22 + MemberListType_privateLists, MemberListType_related = 23,   MemberListType_signals = 24, MemberListType_friends = 25, MemberListType_dcopMethods = 26, MemberListType_properties = 27,   MemberListType_events = 28, MemberListType_typedefMembers = 29 + MemberListType_detailedLists, MemberListType_enumMembers = 30 + MemberListType_detailedLists, MemberListType_enumValMembers = 31 + MemberListType_detailedLists,   MemberListType_functionMembers = 32 + MemberListType_detailedLists, MemberListType_relatedMembers = 33 + MemberListType_detailedLists, MemberListType_variableMembers = 34 + MemberListType_detailedLists, MemberListType_propertyMembers = 35 + MemberListType_detailedLists,   MemberListType_eventMembers = 36 + MemberListType_detailedLists, MemberListType_constructors = 37 + MemberListType_detailedLists, MemberListType_allMembersList = 38, MemberListType_decDefineMembers = 39 + MemberListType_declarationLists,   MemberListType_decProtoMembers = 40 + MemberListType_declarationLists, MemberListType_decTypedefMembers = 41 + MemberListType_declarationLists, MemberListType_decEnumMembers = 42 + MemberListType_declarationLists, MemberListType_decFuncMembers = 43 + MemberListType_declarationLists,   MemberListType_decVarMembers = 44 + MemberListType_declarationLists, MemberListType_decEnumValMembers = 45 + MemberListType_declarationLists, MemberListType_decPubSlotMembers = 46 + MemberListType_declarationLists, MemberListType_decProSlotMembers = 47 + MemberListType_declarationLists,   MemberListType_decPriSlotMembers = 48 + MemberListType_declarationLists, MemberListType_decSignalMembers = 49 + MemberListType_declarationLists, MemberListType_decEventMembers = 50 + MemberListType_declarationLists, MemberListType_decFriendMembers = 51 + MemberListType_declarationLists,   MemberListType_decPropMembers = 52 + MemberListType_declarationLists, MemberListType_docDefineMembers = 53 + MemberListType_documentationLists, MemberListType_docProtoMembers = 54 + MemberListType_documentationLists, MemberListType_docTypedefMembers = 55 + MemberListType_documentationLists,   MemberListType_docEnumMembers = 56 + MemberListType_documentationLists, MemberListType_docFuncMembers = 57 + MemberListType_documentationLists, MemberListType_docVarMembers = 58 + MemberListType_documentationLists, MemberListType_docEnumValMembers = 59 + MemberListType_documentationLists,   MemberListType_docPubSlotMembers = 60 + MemberListType_documentationLists, MemberListType_docProSlotMembers = 61 + MemberListType_documentationLists, MemberListType_docPriSlotMembers = 62 + MemberListType_documentationLists, MemberListType_docSignalMembers = 63 + MemberListType_documentationLists,   MemberListType_docEventMembers = 64 + MemberListType_documentationLists, MemberListType_docFriendMembers = 65 + MemberListType_documentationLists, MemberListType_docPropMembers = 66 + MemberListType_documentationLists, MemberListType_redefinedBy = 67,   MemberListType_enumFields = 68, MemberListType_memberGroup = 69, MemberListType_interfaces = 70, MemberListType_interfaceMembers = 71 + MemberListType_detailedLists,   MemberListType_services = 72, MemberListType_serviceMembers = 73 + MemberListType_detailedLists, MemberListType_decSequenceMembers = 74 + MemberListType_declarationLists, MemberListType_docSequenceMembers = 75 + MemberListType_documentationLists,   MemberListType_decDictionaryMembers = 76 + MemberListType_declarationLists, MemberListType_docDictionaryMembers = 77 + MemberListType_documentationLists }
enum	MemberListContainer { MemberListContainer::File, MemberListContainer::Namespace, MemberListContainer::Group, MemberListContainer::Class }
enum	CodeSymbolType {   CodeSymbolType::Default, CodeSymbolType::Class, CodeSymbolType::Struct, CodeSymbolType::Union,   CodeSymbolType::Interface, CodeSymbolType::Protocol, CodeSymbolType::Category, CodeSymbolType::Exception,   CodeSymbolType::Service, CodeSymbolType::Singleton, CodeSymbolType::Concept, CodeSymbolType::Namespace,   CodeSymbolType::Package, CodeSymbolType::Define, CodeSymbolType::Function, CodeSymbolType::Variable,   CodeSymbolType::Typedef, CodeSymbolType::EnumValue, CodeSymbolType::Enumeration, CodeSymbolType::Signal,   CodeSymbolType::Slot, CodeSymbolType::Friend, CodeSymbolType::DCOP, CodeSymbolType::Property,   CodeSymbolType::Event, CodeSymbolType::Sequence, CodeSymbolType::Dictionary }
enum	MemberType {   MemberType_Define, MemberType_Function, MemberType_Variable, MemberType_Typedef,   MemberType_Enumeration, MemberType_EnumValue, MemberType_Signal, MemberType_Slot,   MemberType_Friend, MemberType_DCOP, MemberType_Property, MemberType_Event,   MemberType_Interface, MemberType_Service, MemberType_Sequence, MemberType_Dictionary }
enum	FortranFormat { FortranFormat_Unknown, FortranFormat_Free, FortranFormat_Fixed }

函数
constexpr const char *	codeSymbolType2Str (CodeSymbolType type)

详细描述

This file contains a number of basic enums and types.

在文件 types.h 中定义.

枚举类型说明

CodeSymbolType

enum CodeSymbolType

strong

枚举值
Default
Class
Struct
Union
Interface
Protocol
Category
Exception
Service
Singleton
Concept
Namespace
Package
Define
Function
Variable
Typedef
EnumValue
Enumeration
Signal
Slot
Friend
DCOP
Property
Event
Sequence
Dictionary

在文件 types.h 第 204 行定义.

{
  Default,
  // Class types
  Class,
  Struct,
  Union,
  Interface,
  Protocol,
  Category,
  Exception,
  Service,
  Singleton,
  // Other container types
  Concept,
  Namespace,
  Package,
  // Member types
  Define,
  Function,
  Variable,
  Typedef,
  EnumValue,
  Enumeration,
  Signal,
  Slot,
  Friend,
  DCOP,
  Property,
  Event,
  Sequence,
  Dictionary
};

FortranFormat

enum FortranFormat

枚举值
FortranFormat_Unknown
FortranFormat_Free
FortranFormat_Fixed

在文件 types.h 第 294 行定义.

{
  FortranFormat_Unknown,
  FortranFormat_Free,
  FortranFormat_Fixed
};

MemberListContainer

enum MemberListContainer

strong

枚举值
File
Namespace
Group
Class

在文件 types.h 第 196 行定义.

{
  File,
  Namespace,
  Group,
  Class
};

MemberListType

enum MemberListType

枚举值
MemberListType_privateLists
MemberListType_detailedLists
MemberListType_declarationLists
MemberListType_documentationLists
MemberListType_pubMethods
MemberListType_proMethods
MemberListType_pacMethods
MemberListType_priMethods
MemberListType_pubStaticMethods
MemberListType_proStaticMethods
MemberListType_pacStaticMethods
MemberListType_priStaticMethods
MemberListType_pubSlots
MemberListType_proSlots
MemberListType_priSlots
MemberListType_pubAttribs
MemberListType_proAttribs
MemberListType_pacAttribs
MemberListType_priAttribs
MemberListType_pubStaticAttribs
MemberListType_proStaticAttribs
MemberListType_pacStaticAttribs
MemberListType_priStaticAttribs
MemberListType_pubTypes
MemberListType_proTypes
MemberListType_pacTypes
MemberListType_priTypes
MemberListType_related
MemberListType_signals
MemberListType_friends
MemberListType_dcopMethods
MemberListType_properties
MemberListType_events
MemberListType_typedefMembers
MemberListType_enumMembers
MemberListType_enumValMembers
MemberListType_functionMembers
MemberListType_relatedMembers
MemberListType_variableMembers
MemberListType_propertyMembers
MemberListType_eventMembers
MemberListType_constructors
MemberListType_allMembersList
MemberListType_decDefineMembers
MemberListType_decProtoMembers
MemberListType_decTypedefMembers
MemberListType_decEnumMembers
MemberListType_decFuncMembers
MemberListType_decVarMembers
MemberListType_decEnumValMembers
MemberListType_decPubSlotMembers
MemberListType_decProSlotMembers
MemberListType_decPriSlotMembers
MemberListType_decSignalMembers
MemberListType_decEventMembers
MemberListType_decFriendMembers
MemberListType_decPropMembers
MemberListType_docDefineMembers
MemberListType_docProtoMembers
MemberListType_docTypedefMembers
MemberListType_docEnumMembers
MemberListType_docFuncMembers
MemberListType_docVarMembers
MemberListType_docEnumValMembers
MemberListType_docPubSlotMembers
MemberListType_docProSlotMembers
MemberListType_docPriSlotMembers
MemberListType_docSignalMembers
MemberListType_docEventMembers
MemberListType_docFriendMembers
MemberListType_docPropMembers
MemberListType_redefinedBy
MemberListType_enumFields
MemberListType_memberGroup
MemberListType_interfaces
MemberListType_interfaceMembers
MemberListType_services
MemberListType_serviceMembers
MemberListType_decSequenceMembers
MemberListType_docSequenceMembers
MemberListType_decDictionaryMembers
MemberListType_docDictionaryMembers

在文件 types.h 第 100 行定义.

{
  MemberListType_privateLists       = 0x0800,
  MemberListType_detailedLists      = 0x1000,
  MemberListType_declarationLists   = 0x2000,
  MemberListType_documentationLists = 0x4000,
 
  MemberListType_pubMethods              = 0,
  MemberListType_proMethods              = 1,
  MemberListType_pacMethods              = 2,
  MemberListType_priMethods              = 3 + MemberListType_privateLists,
  MemberListType_pubStaticMethods        = 4,
  MemberListType_proStaticMethods        = 5,
  MemberListType_pacStaticMethods        = 6,
  MemberListType_priStaticMethods        = 7 + MemberListType_privateLists,
  MemberListType_pubSlots                = 8,
  MemberListType_proSlots                = 9,
  MemberListType_priSlots                = 10 + MemberListType_privateLists,
  MemberListType_pubAttribs              = 11,
  MemberListType_proAttribs              = 12,
  MemberListType_pacAttribs              = 13,
  MemberListType_priAttribs              = 14 + MemberListType_privateLists,
  MemberListType_pubStaticAttribs        = 15,
  MemberListType_proStaticAttribs        = 16,
  MemberListType_pacStaticAttribs        = 17,
  MemberListType_priStaticAttribs        = 18 + MemberListType_privateLists,
  MemberListType_pubTypes                = 19,
  MemberListType_proTypes                = 20,
  MemberListType_pacTypes                = 21,
  MemberListType_priTypes                = 22 + MemberListType_privateLists,
  MemberListType_related                 = 23,
  MemberListType_signals                 = 24,
  MemberListType_friends                 = 25,
  MemberListType_dcopMethods             = 26,
  MemberListType_properties              = 27,
  MemberListType_events                  = 28,
 
  MemberListType_typedefMembers          = 29 + MemberListType_detailedLists,
  MemberListType_enumMembers             = 30 + MemberListType_detailedLists,
  MemberListType_enumValMembers          = 31 + MemberListType_detailedLists,
  MemberListType_functionMembers         = 32 + MemberListType_detailedLists,
  MemberListType_relatedMembers          = 33 + MemberListType_detailedLists,
  MemberListType_variableMembers         = 34 + MemberListType_detailedLists,
  MemberListType_propertyMembers         = 35 + MemberListType_detailedLists,
  MemberListType_eventMembers            = 36 + MemberListType_detailedLists,
  MemberListType_constructors            = 37 + MemberListType_detailedLists,
 
  MemberListType_allMembersList          = 38,
 
  MemberListType_decDefineMembers        = 39 + MemberListType_declarationLists,
  MemberListType_decProtoMembers         = 40 + MemberListType_declarationLists,
  MemberListType_decTypedefMembers       = 41 + MemberListType_declarationLists,
  MemberListType_decEnumMembers          = 42 + MemberListType_declarationLists,
  MemberListType_decFuncMembers          = 43 + MemberListType_declarationLists,
  MemberListType_decVarMembers           = 44 + MemberListType_declarationLists,
  MemberListType_decEnumValMembers       = 45 + MemberListType_declarationLists,
  MemberListType_decPubSlotMembers       = 46 + MemberListType_declarationLists,
  MemberListType_decProSlotMembers       = 47 + MemberListType_declarationLists,
  MemberListType_decPriSlotMembers       = 48 + MemberListType_declarationLists,
  MemberListType_decSignalMembers        = 49 + MemberListType_declarationLists,
  MemberListType_decEventMembers         = 50 + MemberListType_declarationLists,
  MemberListType_decFriendMembers        = 51 + MemberListType_declarationLists,
  MemberListType_decPropMembers          = 52 + MemberListType_declarationLists,
 
  MemberListType_docDefineMembers        = 53 + MemberListType_documentationLists,
  MemberListType_docProtoMembers         = 54 + MemberListType_documentationLists,
  MemberListType_docTypedefMembers       = 55 + MemberListType_documentationLists,
  MemberListType_docEnumMembers          = 56 + MemberListType_documentationLists,
  MemberListType_docFuncMembers          = 57 + MemberListType_documentationLists,
  MemberListType_docVarMembers           = 58 + MemberListType_documentationLists,
  MemberListType_docEnumValMembers       = 59 + MemberListType_documentationLists,
  MemberListType_docPubSlotMembers       = 60 + MemberListType_documentationLists,
  MemberListType_docProSlotMembers       = 61 + MemberListType_documentationLists,
  MemberListType_docPriSlotMembers       = 62 + MemberListType_documentationLists,
  MemberListType_docSignalMembers        = 63 + MemberListType_documentationLists,
  MemberListType_docEventMembers         = 64 + MemberListType_documentationLists,
  MemberListType_docFriendMembers        = 65 + MemberListType_documentationLists,
  MemberListType_docPropMembers          = 66 + MemberListType_documentationLists,
 
  MemberListType_redefinedBy             = 67,
  MemberListType_enumFields              = 68,
  MemberListType_memberGroup             = 69,
 
  // this one is for the summary section on the class page
  MemberListType_interfaces              = 70,
  // this one is for the detailed section on the class page
  MemberListType_interfaceMembers        = 71 + MemberListType_detailedLists,
  MemberListType_services                = 72,
  MemberListType_serviceMembers          = 73 + MemberListType_detailedLists,
 
  MemberListType_decSequenceMembers      = 74 + MemberListType_declarationLists,
  MemberListType_docSequenceMembers      = 75 + MemberListType_documentationLists,
  MemberListType_decDictionaryMembers    = 76 + MemberListType_declarationLists,
  MemberListType_docDictionaryMembers    = 77 + MemberListType_documentationLists
};

MemberType

enum MemberType

枚举值
MemberType_Define
MemberType_Function
MemberType_Variable
MemberType_Typedef
MemberType_Enumeration
MemberType_EnumValue
MemberType_Signal
MemberType_Slot
MemberType_Friend
MemberType_DCOP
MemberType_Property
MemberType_Event
MemberType_Interface
MemberType_Service
MemberType_Sequence
MemberType_Dictionary

在文件 types.h 第 274 行定义.

{
  MemberType_Define,
  MemberType_Function,
  MemberType_Variable,
  MemberType_Typedef,
  MemberType_Enumeration,
  MemberType_EnumValue,
  MemberType_Signal,
  MemberType_Slot,
  MemberType_Friend,
  MemberType_DCOP,
  MemberType_Property,
  MemberType_Event,
  MemberType_Interface,
  MemberType_Service,
  MemberType_Sequence,
  MemberType_Dictionary
};

MethodTypes

enum MethodTypes

Kind of method

枚举值
Method
Signal
Slot
DCOP
Property
Event

在文件 types.h 第 32 行定义.

{ Method, Signal, Slot, DCOP, Property, Event };

Protection

enum Protection

Protection level of members

枚举值
Public
Protected
Private
Package

在文件 types.h 第 26 行定义.

{ Public, Protected, Private, Package } ;

RelatesType

enum RelatesType

Type of member relation

枚举值
Simple
Duplicate
MemberOf

在文件 types.h 第 35 行定义.

{ Simple, Duplicate, MemberOf };

Relationship

enum Relationship

Kind of member relationship

枚举值
Member
Related
Foreign

在文件 types.h 第 38 行定义.

{ Member, Related, Foreign };

Specifier

enum Specifier

Virtualness of a member.

枚举值
Normal
Virtual
Pure

在文件 types.h 第 29 行定义.

{ Normal, Virtual, Pure } ;

SrcLangExt

enum SrcLangExt

Language as given by extension

枚举值
SrcLangExt_Unknown
SrcLangExt_IDL
SrcLangExt_Java
SrcLangExt_CSharp
SrcLangExt_D
SrcLangExt_PHP
SrcLangExt_ObjC
SrcLangExt_Cpp
SrcLangExt_JS
SrcLangExt_Python
SrcLangExt_Fortran
SrcLangExt_VHDL
SrcLangExt_XML
SrcLangExt_Markdown
SrcLangExt_SQL
SrcLangExt_Slice
SrcLangExt_Lex

在文件 types.h 第 41 行定义.

{
  SrcLangExt_Unknown  = 0x00000,
  SrcLangExt_IDL      = 0x00008,
  SrcLangExt_Java     = 0x00010,
  SrcLangExt_CSharp   = 0x00020,
  SrcLangExt_D        = 0x00040,
  SrcLangExt_PHP      = 0x00080,
  SrcLangExt_ObjC     = 0x00100,
  SrcLangExt_Cpp      = 0x00200,
  SrcLangExt_JS       = 0x00400,
  SrcLangExt_Python   = 0x00800,
  SrcLangExt_Fortran  = 0x01000,
  SrcLangExt_VHDL     = 0x02000,
  SrcLangExt_XML      = 0x04000,
  //SrcLangExt_Tcl      = 0x08000, // no longer supported
  SrcLangExt_Markdown = 0x10000,
  SrcLangExt_SQL      = 0x20000,
  SrcLangExt_Slice    = 0x40000,
  SrcLangExt_Lex      = 0x80000
};

函数说明

codeSymbolType2Str()

constexpr const char* codeSymbolType2Str ( CodeSymbolType  type )

constexpr

在文件 types.h 第 238 行定义.

{
  switch (type)
  {
    case CodeSymbolType::Class:       return "class";
    case CodeSymbolType::Struct:      return "struct";
    case CodeSymbolType::Union:       return "union";
    case CodeSymbolType::Interface:   return "interface";
    case CodeSymbolType::Protocol:    return "protocol";
    case CodeSymbolType::Category:    return "category";
    case CodeSymbolType::Exception:   return "exception";
    case CodeSymbolType::Service:     return "service";
    case CodeSymbolType::Singleton:   return "singleton";
    case CodeSymbolType::Concept:     return "concept";
    case CodeSymbolType::Namespace:   return "namespace";
    case CodeSymbolType::Package:     return "package";
    case CodeSymbolType::Define:      return "define";
    case CodeSymbolType::Function:    return "function";
    case CodeSymbolType::Variable:    return "variable";
    case CodeSymbolType::Typedef:     return "typedef";
    case CodeSymbolType::EnumValue:   return "enumvalue";
    case CodeSymbolType::Enumeration: return "enumeration";
    case CodeSymbolType::Signal:      return "signal";
    case CodeSymbolType::Slot:        return "slot";
    case CodeSymbolType::Friend:      return "friend";
    case CodeSymbolType::DCOP:        return "dcop";
    case CodeSymbolType::Property:    return "property";
    case CodeSymbolType::Event:       return "event";
    case CodeSymbolType::Sequence:    return "sequence";
    case CodeSymbolType::Dictionary:  return "dictionary";
    default:
      return 0;
  }
}

引用了 Category, Class, Concept, DCOP, Define, Dictionary, Enumeration, EnumValue, Event, Exception, Friend, Function, Interface, Namespace, Package, Property, Protocol, Sequence, Service, Signal, Singleton, Slot, Struct, Typedef, Union , 以及 Variable.

被这些函数引用 HtmlCodeGenerator::writeCodeLink().