KDE 4.5 API Reference umbrello/umbrello
CodeClassField Class Reference
class CodeClassField a special type of parameter. More...
#include <codeclassfield.h>
Detailed Description
class CodeClassField a special type of parameter.
. occurs on class declarations.
Definition at line 29 of file codeclassfield.h.
Member Enumeration Documentation
Definition at line 34 of file codeclassfield.h.
Constructor & Destructor Documentation
| CodeClassField::CodeClassField | ( | ClassifierCodeDocument * | parentDoc, | |
| UMLAttribute * | attrib | |||
| ) |
Constructors.
Definition at line 38 of file codeclassfield.cpp.
| CodeClassField::CodeClassField | ( | ClassifierCodeDocument * | parentDoc, | |
| UMLRole * | role | |||
| ) |
Definition at line 31 of file codeclassfield.cpp.
| CodeClassField::~CodeClassField | ( | ) | [virtual] |
Empty Destructor.
Definition at line 45 of file codeclassfield.cpp.
Member Function Documentation
| bool CodeClassField::addMethod | ( | CodeAccessorMethod * | add | ) | [protected] |
Add a Method object to the m_methodVector List.
Definition at line 149 of file codeclassfield.cpp.
A little utility method to make life easier for code document programmers.
Definition at line 366 of file codeclassfield.cpp.
| bool CodeClassField::fieldIsSingleValue | ( | ) |
Determine whether the parent object in this classfield indicates that it is a single variable or a List (Vector).
One day this will be done correctly with special multiplicity object.
Definition at line 597 of file codeclassfield.cpp.
| CodeAccessorMethod * CodeClassField::findMethodByType | ( | CodeAccessorMethod::AccessorType | type, | |
| int | role_id = -1 | |||
| ) |
Utility method to allow finding particular accessor method of this code class field by its type identifier.
Definition at line 407 of file codeclassfield.cpp.
| void CodeClassField::finishInitialization | ( | ) |
Finish off initializations of the object.
This is necessary as a separate method because we cannot call virtual methods that are reimplemented in a language specific class during our own construction (the own object is not finished being constructed and therefore the C++ dispatch mechanism does not yet work as expected.)
Definition at line 640 of file codeclassfield.cpp.
| QString CodeClassField::fixInitialStringDeclValue | ( | const QString & | val, | |
| const QString & | type | |||
| ) | [protected] |
Another utility method to make life easier for code document programmers this one fixes the initial declared value of string attributes so that if it is empty or lacking quotations, it comes out as "".
Definition at line 376 of file codeclassfield.cpp.
| CodeClassField::ClassFieldType CodeClassField::getClassFieldType | ( | ) | const |
Get the type of classfield this is.
Definition at line 128 of file codeclassfield.cpp.
| CodeClassFieldDeclarationBlock * CodeClassField::getDeclarationCodeBlock | ( | ) |
Return the declaration statement for this class field object.
will be empty until this (abstract) class is inherited in elsewhere.
Definition at line 213 of file codeclassfield.cpp.
| QString CodeClassField::getListObjectType | ( | ) |
Definition at line 105 of file codeclassfield.cpp.
| CodeAccessorMethodList CodeClassField::getMethodList | ( | ) | const |
Get the list of Method objects held by m_methodVector.
- Returns:
- QPtrList<CodeMethodBlock *> list of Method objects held by m_methodVector
Definition at line 183 of file codeclassfield.cpp.
| QString CodeClassField::getTypeName | ( | ) | [virtual] |
Get the value of m_dialog.
- Returns:
- the value of m_dialog
Reimplemented from CodeParameter.
Reimplemented in DCodeClassField, JavaCodeClassField, and RubyCodeClassField.
Definition at line 87 of file codeclassfield.cpp.
Definition at line 141 of file codeclassfield.cpp.
| bool CodeClassField::getWriteOutMethods | ( | ) | const |
Determine if we will *allow* methods to be viewable.
this flag is often used to toggle autogeneration of accessor methods in the code class field.
Definition at line 193 of file codeclassfield.cpp.
| void CodeClassField::loadFromXMI | ( | QDomElement & | root | ) | [virtual] |
Load params from the appropriate XMI element node.
Definition at line 221 of file codeclassfield.cpp.
| int CodeClassField::maximumListOccurances | ( | ) |
Find the maximum number of things that can occur in an association If mistakenly called on attribute CF's the default value of is "1" is returned.
If the association (role) CF doesn't have a multiplicty or has a "*" specified then '-1' (unbounded) is returned.
Definition at line 342 of file codeclassfield.cpp.
| int CodeClassField::minimumListOccurances | ( | ) |
Find the minimum number of things that can occur in an association If mistakenly called on attribute CF's the default value of is "0" is returned.
Similarly, if the association (role) CF doesn't have a multiplicty 0 is returned.
Definition at line 318 of file codeclassfield.cpp.
| void CodeClassField::modified | ( | ) | [signal] |
| bool CodeClassField::parentIsAttribute | ( | ) | const |
Get the value of m_isAbstract.
- Returns:
- the value of m_isAbstract
Definition at line 119 of file codeclassfield.cpp.
| bool CodeClassField::removeMethod | ( | CodeAccessorMethod * | remove | ) | [protected] |
Remove a Method object from m_methodVector List.
Definition at line 170 of file codeclassfield.cpp.
| void CodeClassField::saveToXMI | ( | QDomDocument & | doc, | |
| QDomElement & | root | |||
| ) | [virtual] |
Save the XMI representation of this object.
Definition at line 303 of file codeclassfield.cpp.
| void CodeClassField::setListClassName | ( | const QString & | className | ) | [protected] |
| void CodeClassField::setParentUMLObject | ( | UMLObject * | obj | ) | [protected] |
Set the parent UMLobject appropriately.
Definition at line 67 of file codeclassfield.cpp.
| void CodeClassField::setWriteOutMethods | ( | bool | val | ) |
Determine if we will *allow* methods to be viewable.
this flag is often used to toggle autogeneration of accessor methods in the code class field.
Definition at line 203 of file codeclassfield.cpp.
| void CodeClassField::synchronize | ( | ) | [virtual] |
Force the synchronization of the content (methods and declarations) of this class field.
Definition at line 393 of file codeclassfield.cpp.
| void CodeClassField::updateContent | ( | ) | [virtual] |
Updates the status of the accessor methods as to whether or not they should be written out.
Implements CodeParameter.
Definition at line 499 of file codeclassfield.cpp.
The documentation for this class was generated from the following files:
