Class IdlSettings

Declaration :

- C++ : class IdlSettings : public UmlSettings
- Java : final class IdlSettings extends UmlSettings

This class manages settings concerning IDL, configured through
the 'Generation settings' dialog.
This class may be defined as a 'singleton', but I prefer to use static
members allowing to just write 'IdlSettings::member' rather than
'IdlSettings::instance()->member' or other long sentence like this.

Artifact : IdlSettings

Operation useDefaults

Declaration :

- C++ : public: static bool useDefaults()
- Java : public static boolean useDefaults()

returns TRUE when the created Java objects are initialized
with the default declaration/definition

Operation set_UseDefaults

Declaration :

- C++ : public: static bool set_UseDefaults(bool y)
- Java : public static void set_UseDefaults(boolean y) throws RuntimeException

if y is TRUE the future created Java objects will be initialized
with the default declaration/definition
On error : return FALSE in C++, produce a RuntimeException in Java

Operation type

Declaration :

- C++ : public: static QCString type(QCString s)
- Java : public static String type(String s)

returns the IDL type corresponding to the 'UML' type given in
argument, as it is configured in the first 'Generation settings'
dialog's tab

Operation set_Type

Declaration :

- C++ : public: static bool set_Type(QCString s, QCString v)
- Java : public static void set_Type(String s, String v) throws RuntimeException

set the IDL type corresponding to the 'UML' type given in
argument, as it is configured in the first 'Generation settings'
dialog's tab
On error : return FALSE in C++, produce a RuntimeException in Java

Operation umlType

Declaration :

- C++ : public: static QCString umlType(QCString s)
- Java : public static String umlType(String s)

reverse of the Type() operation, returns the 'UML' type corresponding
to the IDL type given in argument

Operation relationStereotype

Declaration :

- C++ : public: static QCString relationStereotype(const QCString & s)
- Java : public static String relationStereotype(String s)

returns the IDL stereotype corresponding to the 'UML' stereotype given
in argument

Operation set_RelationStereotype

Declaration :

- C++ : public: static bool set_RelationStereotype(QCString s, QCString v)
- Java : public static void set_RelationStereotype(String s, String v) throws RuntimeException

set the IDL stereotype corresponding to the 'UML' stereotype given
in argument
On error : return FALSE in C++, produce a RuntimeException in Java

Operation relationUmlStereotype

Declaration :

- C++ : public: static QCString relationUmlStereotype(QCString s)
- Java : public static String relationUmlStereotype(String s)

reverse of the RelationStereotype() operation, returns the 'UML'
stereotype corresponding to the IDL one given in argument

Operation classStereotype

Declaration :

- C++ : public: static QCString classStereotype(QCString s)
- Java : public static String classStereotype(String s)

returns the IDL stereotype corresponding to the 'UML' stereotype given
in argument

Operation set_ClassStereotype

Declaration :

- C++ : public: static bool set_ClassStereotype(QCString s, QCString v)
- Java : public static void set_ClassStereotype(String s, String v) throws RuntimeException

set the IDL stereotype corresponding to the 'UML' stereotype given
in argument
On error : return FALSE in C++, produce a RuntimeException in Java

Operation classUmlStereotype

Declaration :

- C++ : public: static QCString classUmlStereotype(QCString s)
- Java : public static String classUmlStereotype(String s)

reverse of the ClassStereotype() operation, returns the 'UML'
stereotype corresponding to the IDL one given in argument

Operation include

Declaration :

- C++ : public: static QCString include(QCString s)
- Java : public static String include(String s)

returns the #include or other form specified in the last
'Generation settings' tab for the Idl type given in argument.

Operation set_Include

Declaration :

- C++ : public: static bool set_Include(QCString s, QCString v)
- Java : public static void set_Include(String s, String v) throws RuntimeException

set the #include or other form specified in the last
'Generation settings' tab for the Idl type given in argument.
On error : return FALSE in C++, produce a RuntimeException in Java

Operation rootDir

Declaration :

- C++ : public: static const QCString & rootDir()
- Java : public static String rootDir()

returns the 'root' directory

Operation set_RootDir

Declaration :

- C++ : public: static bool set_RootDir(QCString v)
- Java : public static void set_RootDir(String v) throws RuntimeException

set the 'root' directory
On error : return FALSE in C++, produce a RuntimeException in Java

Operation sourceContent

Declaration :

- C++ : public: static const QCString & sourceContent()
- Java : public static String sourceContent()

returns the default source file content

Operation set_SourceContent

Declaration :

- C++ : public: static bool set_SourceContent(QCString v)
- Java : public static void set_SourceContent(String v) throws RuntimeException

set the default source file content
On error : return FALSE in C++, produce a RuntimeException in Java

Operation sourceExtension

Declaration :

- C++ : public: static const QCString & sourceExtension()
- Java : public static String sourceExtension()

returns the extension of the files produced by the Idl code generator

Operation set_SourceExtension

Declaration :

- C++ : public: static bool set_SourceExtension(QCString v)
- Java : public static void set_SourceExtension(String v) throws RuntimeException

set the extension of the files produced by the Idl code generator
On error : return FALSE in C++, produce a RuntimeException in Java

Operation interfaceDecl

Declaration :

- C++ : public: static const QCString & interfaceDecl()
- Java : public static String interfaceDecl()

returns the default definition of an interface

Operation set_InterfaceDecl

Declaration :

- C++ : public: static bool set_InterfaceDecl(QCString v)
- Java : public static void set_InterfaceDecl(String v) throws RuntimeException

set the default definition of an interface
On error : return FALSE in C++, produce a RuntimeException in Java

Operation valuetypeDecl

Declaration :

- C++ : public: static const QCString & valuetypeDecl()
- Java : public static String valuetypeDecl()

returns the default definition of a valuetype

Operation set_ValuetypeDecl

Declaration :

- C++ : public: static bool set_ValuetypeDecl(QCString v)
- Java : public static void set_ValuetypeDecl(String v) throws RuntimeException

set the default definition of a valuetype
On error : return FALSE in C++, produce a RuntimeException in Java

Operation externalClassDecl

Declaration :

- C++ : public: static const QCString & externalClassDecl()
- Java : public static String externalClassDecl()

returns the default specification for an 'external' class

Operation set_ExternalClassDecl

Declaration :

- C++ : public: static bool set_ExternalClassDecl(QCString v)
- Java : public static void set_ExternalClassDecl(String v) throws RuntimeException

set the default specification for an 'external' class
On error : return FALSE in C++, produce a RuntimeException in Java

Operation structDecl

Declaration :

- C++ : public: static const QCString & structDecl()
- Java : public static String structDecl()

returns the default definition of a struct

Operation set_StructDecl

Declaration :

- C++ : public: static bool set_StructDecl(QCString v)
- Java : public static void set_StructDecl(String v) throws RuntimeException

set the default definition of a struct
On error : return FALSE in C++, produce a RuntimeException in Java

Operation typedefDecl

Declaration :

- C++ : public: static const QCString & typedefDecl()
- Java : public static String typedefDecl()

returns the default definition of a typedef

Operation set_TypedefDecl

Declaration :

- C++ : public: static bool set_TypedefDecl(QCString v)
- Java : public static void set_TypedefDecl(String v) throws RuntimeException

set the default definition of a typedef
On error : return FALSE in C++, produce a RuntimeException in Java

Operation exceptionDecl

Declaration :

- C++ : public: static const QCString & exceptionDecl()
- Java : public static String exceptionDecl()

returns the default definition of an exception

Operation set_ExceptionDecl

Declaration :

- C++ : public: static bool set_ExceptionDecl(QCString v)
- Java : public static void set_ExceptionDecl(String v) throws RuntimeException

set the default definition of an exception
On error : return FALSE in C++, produce a RuntimeException in Java

Operation unionDecl

Declaration :

- C++ : public: static const QCString & unionDecl()
- Java : public static String unionDecl()

returns the default definition of an union

Operation set_UnionDecl

Declaration :

- C++ : public: static bool set_UnionDecl(QCString v)
- Java : public static void set_UnionDecl(String v) throws RuntimeException

set the default definition of an union
On error : return FALSE in C++, produce a RuntimeException in Java

Operation enumDecl

Declaration :

- C++ : public: static const QCString & enumDecl()
- Java : public static String enumDecl()

returns the default definition of an enum

Operation set_EnumDecl

Declaration :

- C++ : public: static bool set_EnumDecl(QCString v)
- Java : public static void set_EnumDecl(String v) throws RuntimeException

set the default definition of an enum
On error : return FALSE in C++, produce a RuntimeException in Java

Operation attributeDecl

Declaration :

- C++ : public: static const QCString & attributeDecl()
- Java : public static String attributeDecl()

returns the default definition of an attribute

Operation set_AttributeDecl

Declaration :

- C++ : public: static bool set_AttributeDecl(QCString v)
- Java : public static void set_AttributeDecl(String v) throws RuntimeException

set the default definition of an attribute
On error : return FALSE in C++, produce a RuntimeException in Java

Operation valuetypeAttributeDecl

Declaration :

- C++ : public: static const QCString & valuetypeAttributeDecl()
- Java : public static String valuetypeAttributeDecl()

returns the default definition of an attribute
placed in a valuetype

Operation set_ValuetypeAttributeDecl

Declaration :

- C++ : public: static bool set_ValuetypeAttributeDecl(QCString v)
- Java : public static void set_ValuetypeAttributeDecl(String v) throws RuntimeException

set the default definition of an attribute
placed in a valuetype
On error : return FALSE in C++, produce a RuntimeException in Java

Operation unionItemDecl

Declaration :

- C++ : public: static const QCString & unionItemDecl()
- Java : public static String unionItemDecl()

returns the default definition of an union item

Operation set_UnionItemDecl

Declaration :

- C++ : public: static bool set_UnionItemDecl(QCString v)
- Java : public static void set_UnionItemDecl(String v) throws RuntimeException

set the default definition of an union item
On error : return FALSE in C++, produce a RuntimeException in Java

Operation enumItemDecl

Declaration :

- C++ : public: static const QCString & enumItemDecl()
- Java : public static String enumItemDecl()

returns the default definition of an enumeration item

Operation set_EnumItemDecl

Declaration :

- C++ : public: static bool set_EnumItemDecl(QCString v)
- Java : public static void set_EnumItemDecl(String v) throws RuntimeException

set the default definition of an enumeration item
On error : return FALSE in C++, produce a RuntimeException in Java

Operation constDecl

Declaration :

- C++ : public: static const QCString & constDecl()
- Java : public static String constDecl()

returns the default definition of a constant attribute

Operation set_ConstDecl

Declaration :

- C++ : public: static bool set_ConstDecl(QCString v)
- Java : public static void set_ConstDecl(String v) throws RuntimeException

set the default definition of a constant attribute
On error : return FALSE in C++, produce a RuntimeException in Java

Operation relationDecl

Declaration :

- C++ : public: static const QCString & relationDecl(const char * multiplicity)
- Java : public static String relationDecl(String multiplicity)

returns the default definition of a relation depending on the
multiplicity given in argument.

Operation set_RelationDecl

Declaration :

- C++ : public: static bool set_RelationDecl(const char * multiplicity, QCString v)
- Java : public static void set_RelationDecl(String multiplicity, String v) throws RuntimeException

set the default definition of a relation depending on the
multiplicity given in argument.
On error : return FALSE in C++, produce a RuntimeException in Java

Operation valuetypeRelationDecl

Declaration :

- C++ : public: static const QCString & valuetypeRelationDecl(const char * multiplicity)
- Java : public static String valuetypeRelationDecl(String multiplicity)

returns the default definition of a relation in a valuetype
depending on the multiplicity given in argument.

Operation set_ValuetypeRelationDecl

Declaration :

- C++ : public: static bool set_ValuetypeRelationDecl(const char * multiplicity, QCString v)
- Java : public static void set_ValuetypeRelationDecl(String multiplicity, String v) throws RuntimeException

set the default definition of a relation in a valuetype
depending on the multiplicity given in argument.
On error : return FALSE in C++, produce a RuntimeException in Java

Operation unionRelationDecl

Declaration :

- C++ : public: static const QCString & unionRelationDecl(const char * multiplicity)
- Java : public static String unionRelationDecl(String multiplicity)

returns the default definition of a relation in an union
depending on the multiplicity given in argument.

Operation set_UnionRelationDecl

Declaration :

- C++ : public: static bool set_UnionRelationDecl(const char * multiplicity, QCString v)
- Java : public static void set_UnionRelationDecl(String multiplicity, String v) throws RuntimeException

set the default definition of a relation in an union
depending on the multiplicity given in argument.
On error : return FALSE in C++, produce a RuntimeException in Java

Operation operationDecl

Declaration :

- C++ : public: static const QCString & operationDecl()
- Java : public static String operationDecl()

returns the default declaration of an operation

Operation set_OperationDecl

Declaration :

- C++ : public: static bool set_OperationDecl(QCString v)
- Java : public static void set_OperationDecl(String v) throws RuntimeException

set the default declaration of an operation
On error : return FALSE in C++, produce a RuntimeException in Java

Operation getName

Declaration :

- C++ : public: static const QCString & getName()
- Java : public static String getName()

returns the default name of a 'get' operation generated through
the attribute and relation 'add get operation' menu

Operation set_GetName

Declaration :

- C++ : public: static bool set_GetName(QCString v)
- Java : public static void set_GetName(String v) throws RuntimeException

set the default name of a 'get' operation generated through
the attribute and relation 'add get operation' menu
On error : return FALSE in C++, produce a RuntimeException in Java

Operation setName

Declaration :

- C++ : public: static const QCString & setName()
- Java : public static String setName()

returns the default name of a 'set' operation generated
through the attribute and relation 'add set operation' menu

Operation set_SetName

Declaration :

- C++ : public: static bool set_SetName(QCString v)
- Java : public static void set_SetName(String v) throws RuntimeException

set the default name of a 'set' operation generated
through the attribute and relation 'add set operation' menu
On error : return FALSE in C++, produce a RuntimeException in Java

Operation isSetOneway

Declaration :

- C++ : public: static bool isSetOneway()
- Java : public static boolean isSetOneway()

returns if a 'set' operation generated through the attribute
and relation 'add set operation' menu is oneway by default

Operation set_IsSetOneway

Declaration :

- C++ : public: static bool set_IsSetOneway(bool v)
- Java : public static void set_IsSetOneway(boolean v) throws RuntimeException

set if a 'set' operation generated through the attribute
and relation 'add set operation' menu is oneway by default
On error : return FALSE in C++, produce a RuntimeException in Java

Operation IdlSettings

Declaration :

- C++ : private: IdlSettings()
- Java : private IdlSettings()

never called !

Attribut _defined

Declaration :

- C++ : private: static bool _defined
- Java : private static boolean _defined

Attribut _root

Declaration :

- C++ : private: static QCString _root
- Java : private static String _root

Attribut _interface_decl

Declaration :

- C++ : private: static QCString _interface_decl
- Java : private static String _interface_decl

Attribut _valuetype_decl

Declaration :

- C++ : private: static QCString _valuetype_decl
- Java : private static String _valuetype_decl

Attribut _struct_decl

Declaration :

- C++ : private: static QCString _struct_decl
- Java : private static String _struct_decl

Attribut _typedef_decl

Declaration :

- C++ : private: static QCString _typedef_decl
- Java : private static String _typedef_decl

Attribut _exception_decl

Declaration :

- C++ : private: static QCString _exception_decl
- Java : private static String _exception_decl

Attribut _union_decl

Declaration :

- C++ : private: static QCString _union_decl
- Java : private static String _union_decl

Attribut _enum_decl

Declaration :

- C++ : private: static QCString _enum_decl
- Java : private static String _enum_decl

Attribut _external_class_decl

Declaration :

- C++ : private: static QCString _external_class_decl
- Java : private static String _external_class_decl

Attribut _attr_decl

Declaration :

- C++ : private: static QCString _attr_decl
- Java : private static String _attr_decl

Attribut _valuetype_attr_decl

Declaration :

- C++ : private: static QCString _valuetype_attr_decl
- Java : private static String _valuetype_attr_decl

Attribut _union_item_decl

Declaration :

- C++ : private: static QCString _union_item_decl
- Java : private static String _union_item_decl

Attribut _enum_item_decl

Declaration :

- C++ : private: static QCString _enum_item_decl
- Java : private static String _enum_item_decl

Attribut _const_decl

Declaration :

- C++ : private: static QCString _const_decl
- Java : private static String _const_decl

Attribut _rel_decl

Declaration :

- C++ : private: static QCString _rel_decl[3/*multiplicity*/]
- Java : private static String[] _rel_decl

Attribut _valuetype_rel_decl

Declaration :

- C++ : private: static QCString _valuetype_rel_decl[3/*multiplicity*/]
- Java : private static String[] _valuetype_rel_decl

Attribut _union_rel_decl

Declaration :

- C++ : private: static QCString _union_rel_decl[3/*multiplicity*/]
- Java : private static String[] _union_rel_decl

Attribut _oper_decl

Declaration :

- C++ : private: static QCString _oper_decl
- Java : private static String _oper_decl

Attribut _get_name

Declaration :

- C++ : private: static QCString _get_name
- Java : private static String _get_name

Attribut _set_name

Declaration :

- C++ : private: static QCString _set_name
- Java : private static String _set_name

Attribut _is_set_oneway

Declaration :

- C++ : private: static bool _is_set_oneway
- Java : private static boolean _is_set_oneway

Attribut _src_content

Declaration :

- C++ : private: static QCString _src_content
- Java : private static String _src_content

Attribut _ext

Declaration :

- C++ : private: static QCString _ext
- Java : private static String _ext

Attribut _map_includes

Declaration :

- C++ : private: static QDict<QCString> _map_includes
- Java : private static Hashtable _map_includes

Operation read_

Declaration :

- C++ : protected: static void read_()
- Java : protected static void read_()

internal, do NOT use it

Operation read_if_needed_

Declaration :

- C++ : protected: static void read_if_needed_()
- Java : protected static void read_if_needed_()

internal, do NOT use it

All public operations : artifactDescription , attributeDecl , attributeDescription , classDescription , classStereotype , classUmlStereotype , constDecl , enumDecl , enumItemDecl , exceptionDecl , externalClassDecl , getName , include , interfaceDecl , isSetOneway , operationDecl , operationDescription , relationDecl , relationDescription , relationStereotype , relationUmlStereotype , rootDir , set_ArtifactDescription , set_AttributeDecl , set_AttributeDescription , set_ClassDescription , set_ClassStereotype , set_ConstDecl , set_EnumDecl , set_EnumItemDecl , set_ExceptionDecl , set_ExternalClassDecl , set_GetName , set_Include , set_InterfaceDecl , set_IsSetOneway , set_OperationDecl , set_OperationDescription , set_RelationDecl , set_RelationDescription , set_RelationStereotype , set_RootDir , set_SetName , set_SourceContent , set_SourceExtension , set_StructDecl , set_Type , set_TypedefDecl , set_UnionDecl , set_UnionItemDecl , set_UnionRelationDecl , set_UseDefaults , set_ValuetypeAttributeDecl , set_ValuetypeDecl , set_ValuetypeRelationDecl , setName , sourceContent , sourceExtension , structDecl , type , typedefDecl , umlType , unionDecl , unionItemDecl , unionRelationDecl , useDefaults , valuetypeAttributeDecl , valuetypeDecl , valuetypeRelationDecl