UDK 3.2.7 C/C++ API Reference
Classes | Defines | Typedefs | Enumerations
registry/types.h File Reference
#include "sal/types.h"

Go to the source code of this file.

Classes

union  RTConstValueUnion
 specifies a variable container for field values. More...

Defines

#define RT_ACCESS_INVALID   0x0000
 specifies a unknown flag
#define RT_ACCESS_READONLY   0x0001
 specifies a readonly property/attribute
#define RT_ACCESS_OPTIONAL   0x0002
 specifies a property as optional that means that it must not be implemented.
#define RT_ACCESS_MAYBEVOID   0x0004
#define RT_ACCESS_BOUND   0x0008
#define RT_ACCESS_CONSTRAINED   0x0010
#define RT_ACCESS_TRANSIENT   0x0020
#define RT_ACCESS_MAYBEAMBIGUOUS   0x0040
#define RT_ACCESS_MAYBEDEFAULT   0x0080
#define RT_ACCESS_REMOVEABLE   0x0100
#define RT_ACCESS_ATTRIBUTE   0x0200
#define RT_ACCESS_PROPERTY   0x0400
 specifies that the field is a property
#define RT_ACCESS_CONST   0x0800
 specifies that the field is a constant or enum value
#define RT_ACCESS_READWRITE   0x1000
 specifies that the property/attribute has read/write access
#define RT_ACCESS_DEFAULT   0x2000
 only to describe a union default label
#define RT_ACCESS_PARAMETERIZED_TYPE   0x4000
 Indicates that a member of a polymorphic struct type template is of a parameterized type.
#define RT_ACCESS_PUBLISHED   0x8000
 Flag for published individual constants.

Typedefs

typedef sal_uInt16 RTFieldAccess
 specifies the type for the field access.

Enumerations

enum  RTTypeClass {
  RT_TYPE_INVALID, RT_TYPE_INTERFACE, RT_TYPE_MODULE, RT_TYPE_STRUCT,
  RT_TYPE_ENUM, RT_TYPE_EXCEPTION, RT_TYPE_TYPEDEF, RT_TYPE_SERVICE,
  RT_TYPE_SINGLETON, RT_TYPE_OBJECT, RT_TYPE_CONSTANTS, RT_TYPE_UNION
}
 specifies the typeclass of a binary type blob. More...
enum  RTValueType {
  RT_TYPE_NONE, RT_TYPE_BOOL, RT_TYPE_BYTE, RT_TYPE_INT16,
  RT_TYPE_UINT16, RT_TYPE_INT32, RT_TYPE_UINT32, RT_TYPE_INT64,
  RT_TYPE_UINT64, RT_TYPE_FLOAT, RT_TYPE_DOUBLE, RT_TYPE_STRING
}
 specifies the type of a field value. More...
enum  RTMethodMode {
  RT_MODE_INVALID, RT_MODE_ONEWAY, RT_MODE_ONEWAY_CONST, RT_MODE_TWOWAY,
  RT_MODE_TWOWAY_CONST, RT_MODE_ATTRIBUTE_GET, RT_MODE_ATTRIBUTE_SET
}
 specifies the mode of a method. More...
enum  RTParamMode {
  RT_PARAM_INVALID = 0, RT_PARAM_IN = 1, RT_PARAM_OUT = 2, RT_PARAM_INOUT = 3,
  RT_PARAM_REST = 4
}
 specifies the mode of a parameter. More...
enum  RTReferenceType {
  RT_REF_INVALID, RT_REF_SUPPORTS, RT_REF_OBSERVES, RT_REF_EXPORTS,
  RT_REF_NEEDS, RT_REF_TYPE_PARAMETER
}
 specifies the type of a reference used in a service description. More...

Define Documentation

#define RT_ACCESS_ATTRIBUTE   0x0200
See also:
com::sun::star::beans::PropertyAttribute
#define RT_ACCESS_BOUND   0x0008
See also:
com::sun::star::beans::PropertyAttribute
#define RT_ACCESS_CONST   0x0800

specifies that the field is a constant or enum value

#define RT_ACCESS_CONSTRAINED   0x0010
See also:
com::sun::star::beans::PropertyAttribute
#define RT_ACCESS_DEFAULT   0x2000

only to describe a union default label

#define RT_ACCESS_INVALID   0x0000

specifies a unknown flag

#define RT_ACCESS_MAYBEAMBIGUOUS   0x0040
See also:
com::sun::star::beans::PropertyAttribute
#define RT_ACCESS_MAYBEDEFAULT   0x0080
See also:
com::sun::star::beans::PropertyAttribute
#define RT_ACCESS_MAYBEVOID   0x0004
See also:
com::sun::star::beans::PropertyAttribute
#define RT_ACCESS_OPTIONAL   0x0002

specifies a property as optional that means that it must not be implemented.

#define RT_ACCESS_PARAMETERIZED_TYPE   0x4000

Indicates that a member of a polymorphic struct type template is of a parameterized type.

Only valid for fields that represent members of polymorphic struct type templates.

Since:
UDK 3.2.0
#define RT_ACCESS_PROPERTY   0x0400

specifies that the field is a property

#define RT_ACCESS_PUBLISHED   0x8000

Flag for published individual constants.

Used in combination with RT_ACCESS_CONST for individual constants (which are not members of constant groups).

Since:
UDK 3.2.0
#define RT_ACCESS_READONLY   0x0001

specifies a readonly property/attribute

#define RT_ACCESS_READWRITE   0x1000

specifies that the property/attribute has read/write access

#define RT_ACCESS_REMOVEABLE   0x0100
See also:
com::sun::star::beans::PropertyAttribute
#define RT_ACCESS_TRANSIENT   0x0020
See also:
com::sun::star::beans::PropertyAttribute

Typedef Documentation

typedef sal_uInt16 RTFieldAccess

specifies the type for the field access.

Fields in a type blob are used for different types. Among others they were used for properties of services and these poperties can have several flags.

See also:
RT_ACCESS_INVALID
RT_ACCESS_READONLY
RT_ACCESS_OPTIONAL
RT_ACCESS_MAYBEVOID
RT_ACCESS_BOUND
RT_ACCESS_CONSTRAINED
RT_ACCESS_TRANSIENT
RT_ACCESS_MAYBEAMBIGUOUS
RT_ACCESS_MAYBEDEFAULT
RT_ACCESS_REMOVEABLE
RT_ACCESS_ATTRIBUTE
RT_ACCESS_PROPERTY
RT_ACCESS_CONST
RT_ACCESS_READWRITE
RT_ACCESS_DEFAULT
RT_ACCESS_PARAMETERIZED_TYPE
RT_ACCESS_PUBLISHED

Enumeration Type Documentation

specifies the mode of a method.

A method can be synchron or asynchron (oneway). The const attribute for methods was removed so that the const values are deprecated.

Enumerator:
RT_MODE_INVALID 

indicates an invalid mode

RT_MODE_ONEWAY 

indicates the asynchronous mode of a method

RT_MODE_ONEWAY_CONST 
Deprecated:
RT_MODE_TWOWAY 

indicated the synchronous mode of a method

RT_MODE_TWOWAY_CONST 
Deprecated:
RT_MODE_ATTRIBUTE_GET 

Indicates an extended attribute getter (that has a 'raises' clause) of an interface type.

Since:
UDK 3.2.0
RT_MODE_ATTRIBUTE_SET 

Indicates an extended attribute setter (that has a 'raises' clause) of an interface type.

Since:
UDK 3.2.0

specifies the mode of a parameter.

There are three paramter modes which have impact of the handling of the paramter in the UNO bridges and the UNO code generation.

Enumerator:
RT_PARAM_INVALID 

indicates an invalid parameter mode

RT_PARAM_IN 

indicates a pure in parameter which is used by value

RT_PARAM_OUT 

indicates a pure out parameter which is used by reference

RT_PARAM_INOUT 

indicates a in and out parameter which is used also by reference

RT_PARAM_REST 

Indicates a rest parameter (currently only valid for service constructors).

This value can be combined with any of RT_PARAM_IN, RT_PARAM_OUT, and RT_PARAM_INOUT (however, service constructors currently only allow RT_PARAM_IN, anyway).

Since:
UDK 3.2.0

specifies the type of a reference used in a service description.

Enumerator:
RT_REF_INVALID 

the reference type is unknown

RT_REF_SUPPORTS 

the service support the interface that means a implementation of this service must implement this interface.

RT_REF_OBSERVES 
Deprecated:
the service observes the interface.
RT_REF_EXPORTS 

the service exports the specified service that means this service provides also the specified service.

RT_REF_NEEDS 
Deprecated:
the service needs the specified service that means in the context of this service the specified service will be used or must be available.
RT_REF_TYPE_PARAMETER 

Indicates a type parameter of a polymorphic struct type template.

Since:
UDK 3.2.0

specifies the typeclass of a binary type blob.

The general structure of a binary type blob is always the same. It depends on the typeclass which parts of the blob are filled with data or not.

Enumerator:
RT_TYPE_INVALID 

specifies that the structure of the given blob is unknown and can't be read.

RT_TYPE_INTERFACE 

specifies that the blob represents an interface type.

An interface blob can contain a base interface, attributes and methods.

RT_TYPE_MODULE 

specifies that the blob represents a module type.

A module blob can contain a base module and constant members (fields).

RT_TYPE_STRUCT 

specifies that the blob represents a struct type.

A struct blob can contain a base struct and members (fields).

RT_TYPE_ENUM 

specifies that the blob represents an enum type.

An enum blob can contain enum values which are accessible as fields.

RT_TYPE_EXCEPTION 

specifies that the blob represents an exception type.

An exception blob can contain a base exception and members (fields).

RT_TYPE_TYPEDEF 

specifies that the blob represents a typedef type.

A typedef blob can contain a base type.

RT_TYPE_SERVICE 

specifies that the blob represents a service type.

A service blob can contain a base service, properties (fields), references to services or interfaces.

RT_TYPE_SINGLETON 

specifies that the blob represents a singleton type (a named object) which refers exactly one existing service.

RT_TYPE_OBJECT 

deprecated, not used.

RT_TYPE_CONSTANTS 

specifies that the blob represents a constants type.

A constants blob can contain constant types as fields.

RT_TYPE_UNION 
Deprecated:
a union type was evaluated but currently not supported.

specifies the type of a field value.

A field can have a value if it repsresents a constant or an enum value.

Enumerator:
RT_TYPE_NONE 
RT_TYPE_BOOL 
RT_TYPE_BYTE 
RT_TYPE_INT16 
RT_TYPE_UINT16 
RT_TYPE_INT32 
RT_TYPE_UINT32 
RT_TYPE_INT64 
RT_TYPE_UINT64 
RT_TYPE_FLOAT 
RT_TYPE_DOUBLE 
RT_TYPE_STRING 
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines