types.hxx File Reference

#include <sal/types.h>
#include <o3tl/typed_flags_set.hxx>

Include dependency graph for types.hxx:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	o3tl::typed_flags< RTFieldAccess >
union	RTConstValueUnion
	specifies a variable container for field values. More...

Namespaces
namespace	o3tl

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 class	RTFieldAccess {   NONE = 0x0000 ,   INVALID = 0x0000 ,   READONLY = 0x0001 ,   OPTIONAL = 0x0002 ,   MAYBEVOID = 0x0004 ,   BOUND = 0x0008 ,   CONSTRAINED = 0x0010 ,   TRANSIENT = 0x0020 ,   MAYBEAMBIGUOUS = 0x0040 ,   MAYBEDEFAULT = 0x0080 ,   REMOVABLE = 0x0100 ,   ATTRIBUTE = 0x0200 ,   PROPERTY = 0x0400 ,   CONST = 0x0800 ,   READWRITE = 0x1000 ,   DEFAULT = 0x2000 ,   PARAMETERIZED_TYPE = 0x4000 ,   PUBLISHED = 0x8000 }
	specifies the type for the field access. 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 class	RTMethodMode {   INVALID ,   ONEWAY ,   ONEWAY_CONST ,   TWOWAY ,   TWOWAY_CONST ,   ATTRIBUTE_GET ,   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 class	RTReferenceType {   INVALID ,   SUPPORTS ,   OBSERVES ,   EXPORTS ,   NEEDS ,   TYPE_PARAMETER }
	specifies the type of a reference used in a service description. More...

Enumeration Type Documentation

RTFieldAccess

enum class RTFieldAccess

strong

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 properties can have several flags.

See also

RTFieldAccess::INVALID

RTFieldAccess::READONLY

RTFieldAccess::OPTIONAL

RTFieldAccess::MAYBEVOID

RTFieldAccess::BOUND

RTFieldAccess::CONSTRAINED

RTFieldAccess::TRANSIENT

RTFieldAccess::MAYBEAMBIGUOUS

RTFieldAccess::MAYBEDEFAULT

RTFieldAccess::REMOVABLE

RTFieldAccess::ATTRIBUTE

RTFieldAccess::PROPERTY

RTFieldAccess::CONST

RTFieldAccess::READWRITE

RTFieldAccess::DEFAULT

RTFieldAccess::PARAMETERIZED_TYPE

RTFieldAccess::PUBLISHED

Enumerator
NONE
INVALID	specifies an unknown flag
READONLY	specifies a readonly property/attribute
OPTIONAL	specifies a property as optional that means that it must not be implemented.
MAYBEVOID	See also com::sun::star::beans::PropertyAttribute
BOUND	See also com::sun::star::beans::PropertyAttribute
CONSTRAINED	See also com::sun::star::beans::PropertyAttribute
TRANSIENT	See also com::sun::star::beans::PropertyAttribute
MAYBEAMBIGUOUS	See also com::sun::star::beans::PropertyAttribute
MAYBEDEFAULT	See also com::sun::star::beans::PropertyAttribute
REMOVABLE	See also com::sun::star::beans::PropertyAttribute
ATTRIBUTE	See also com::sun::star::beans::PropertyAttribute
PROPERTY	specifies that the field is a property
CONST	specifies that the field is a constant or enum value
READWRITE	specifies that the property/attribute has read/write access
DEFAULT	only to describe a union default label
PARAMETERIZED_TYPE	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. Available since: \n UDK 3.2.0
PUBLISHED	Flag for published individual constants. Used in combination with RTFieldAccess::CONST for individual constants (which are not members of constant groups). Available since: \n UDK 3.2.0

Definition at line 132 of file types.hxx.

RTMethodMode

enum class RTMethodMode

strong

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
INVALID	indicates an invalid mode
ONEWAY	indicates the asynchronous mode of a method
ONEWAY_CONST	Deprecated:
TWOWAY	indicated the synchronous mode of a method
TWOWAY_CONST	Deprecated:
ATTRIBUTE_GET	Indicates an extended attribute getter (that has a 'raises' clause) of an interface type. Available since: \n UDK 3.2.0
ATTRIBUTE_SET	Indicates an extended attribute setter (that has a 'raises' clause) of an interface type. Available since: \n UDK 3.2.0

Definition at line 234 of file types.hxx.

RTParamMode

enum RTParamMode

specifies the mode of a parameter.

There are three parameter modes which have impact of the handling of the parameter 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). Available since: \n UDK 3.2.0

Definition at line 273 of file types.hxx.

RTReferenceType

enum class RTReferenceType

strong

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

Enumerator
INVALID	the reference type is unknown
SUPPORTS	the service support the interface that means an implementation of this service must implement this interface.
OBSERVES	Deprecated: the service observes the interface.
EXPORTS	the service exports the specified service that means this service provides also the specified service.
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.
TYPE_PARAMETER	Indicates a type parameter of a polymorphic struct type template. Available since: \n UDK 3.2.0

Definition at line 302 of file types.hxx.

RTTypeClass

enum RTTypeClass

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.

Definition at line 30 of file types.hxx.

RTValueType

enum RTValueType

specifies the type of a field value.

A field can have a value if it represents 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

Definition at line 197 of file types.hxx.