• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdesdk API Reference
  • KDE Home
  • Contact Us
 

umbrello/umbrello

Public Slots | Public Member Functions | Protected Member Functions | List of all members
CodeClassFieldDeclarationBlock Class Referenceabstract

#include <codeclassfielddeclarationblock.h>

Inheritance diagram for CodeClassFieldDeclarationBlock:
Inheritance graph
[legend]

Public Slots

virtual void syncToParent ()
 
- Public Slots inherited from OwnedCodeBlock
virtual void syncToParent ()
 

Public Member Functions

 CodeClassFieldDeclarationBlock (CodeClassField *parent)
 
virtual ~CodeClassFieldDeclarationBlock ()
 
CodeClassField * getParentClassField ()
 
UMLObject * getParentObject ()
 
virtual void loadFromXMI (QDomElement &root)
 
virtual void saveToXMI (QDomDocument &doc, QDomElement &root)
 
virtual void setAttributesFromObject (TextBlock *obj)
 
virtual void updateContent ()=0
 
- Public Member Functions inherited from OwnedCodeBlock
 OwnedCodeBlock (UMLObject *parent)
 
virtual ~OwnedCodeBlock ()
 
UMLObject * getParentObject ()
 
- Public Member Functions inherited from CodeBlockWithComments
 CodeBlockWithComments (CodeDocument *parent, const QString &body="", const QString &comment="")
 
virtual ~CodeBlockWithComments ()
 
CodeComment * getComment () const
 
void setComment (CodeComment *object)
 
void setOverallIndentationLevel (int level)
 
virtual QString toString () const
 
- Public Member Functions inherited from CodeBlock
 CodeBlock (CodeDocument *parent, const QString &body="")
 
virtual ~CodeBlock ()
 
ContentType contentType () const
 
void setContentType (ContentType new_var)
 
- Public Member Functions inherited from TextBlock
 TextBlock (CodeDocument *parent, const QString &text="")
 
virtual ~TextBlock ()
 
void appendText (const QString &text)
 
bool canDelete () const
 
virtual int firstEditableLine ()
 
int getIndentationLevel () const
 
QString getIndentationString (int level=0) const
 
virtual QString getNewEditorLine (int amount=0)
 
CodeDocument * getParentDocument () const
 
QString getTag () const
 
QString getText () const
 
bool getWriteOutText () const
 
virtual int lastEditableLine ()
 
void setIndentationLevel (int level)
 
void setTag (const QString &value)
 
void setText (const QString &text)
 
void setWriteOutText (bool write)
 
virtual QString unformatText (const QString &text, const QString &indent="")
 

Protected Member Functions

void forceRelease ()
 
virtual void release ()
 
virtual void setAttributesFromNode (QDomElement &element)
 
virtual void setAttributesOnNode (QDomDocument &doc, QDomElement &blockElement)
 
- Protected Member Functions inherited from TextBlock
void setCanDelete (bool canDelete)
 

Additional Inherited Members

- Public Types inherited from CodeBlock
enum  ContentType { AutoGenerated =0, UserGenerated }
 
- Static Public Member Functions inherited from CodeBlock
static QString enumToString (const ContentType &val)
 
- Static Public Member Functions inherited from TextBlock
static QString decodeText (const QString &text, const QString &endLine)
 
static QString encodeText (const QString &text, const QString &endLine)
 
static QString formatMultiLineText (const QString &work, const QString &linePrefix, const QString &breakStr, bool addBreak=true, bool lastLineHasBreak=true)
 
static QString getIndentation ()
 
static QString getNewLineEndingChars ()
 

Detailed Description

Used to declare classifier fields (e.g.

either class attributes or classifier associations) in the code document for any given code classfield. This is a special CodeBlockWithComments which is "sync'd" to the parent CodeClassField. Note: keep the inheritance sequence: QObject needs to be first in inheritance list. Basicially a class to allow for synchronization of the contents based on the values of the parentClassField's parentObject.

Definition at line 29 of file codeclassfielddeclarationblock.h.

Constructor & Destructor Documentation

CodeClassFieldDeclarationBlock::CodeClassFieldDeclarationBlock ( CodeClassField *  parent)
explicit

Constructor.

Definition at line 20 of file codeclassfielddeclarationblock.cpp.

CodeClassFieldDeclarationBlock::~CodeClassFieldDeclarationBlock ( )
virtual

Empty Destructor.

Definition at line 30 of file codeclassfielddeclarationblock.cpp.

Member Function Documentation

void CodeClassFieldDeclarationBlock::forceRelease ( )
protected

So parent can actually release this block.

Definition at line 65 of file codeclassfielddeclarationblock.cpp.

CodeClassField * CodeClassFieldDeclarationBlock::getParentClassField ( )

Get the value of m_parentclassfield.

Returns
the value of m_parentclassfield

Definition at line 40 of file codeclassfielddeclarationblock.cpp.

UMLObject * CodeClassFieldDeclarationBlock::getParentObject ( )

A utility method to get the parent object of the parentCodeClassfield.

Definition at line 48 of file codeclassfielddeclarationblock.cpp.

void CodeClassFieldDeclarationBlock::loadFromXMI ( QDomElement &  root)
virtual

Load params from the appropriate XMI element node.

Reimplemented from CodeBlockWithComments.

Definition at line 90 of file codeclassfielddeclarationblock.cpp.

void CodeClassFieldDeclarationBlock::release ( )
protectedvirtual

Causes the text block to release all of its connections and any other text blocks that it 'owns'.

Needed to be called prior to deletion of the textblock.

Reimplemented from OwnedCodeBlock.

Definition at line 57 of file codeclassfielddeclarationblock.cpp.

void CodeClassFieldDeclarationBlock::saveToXMI ( QDomDocument &  doc,
QDomElement &  root 
)
virtual

Save the XMI representation of this object.

Reimplemented from CodeBlockWithComments.

Definition at line 80 of file codeclassfielddeclarationblock.cpp.

void CodeClassFieldDeclarationBlock::setAttributesFromNode ( QDomElement &  element)
protectedvirtual

Set the class attributes of this object from the passed element node.

Reimplemented from CodeBlockWithComments.

Definition at line 110 of file codeclassfielddeclarationblock.cpp.

void CodeClassFieldDeclarationBlock::setAttributesFromObject ( TextBlock *  obj)
virtual

Set the class attributes from a passed object.

Reimplemented from CodeBlockWithComments.

Definition at line 122 of file codeclassfielddeclarationblock.cpp.

void CodeClassFieldDeclarationBlock::setAttributesOnNode ( QDomDocument &  doc,
QDomElement &  blockElement 
)
protectedvirtual

Set attributes of the node that represents this class in the XMI document.

Reimplemented from CodeBlockWithComments.

Definition at line 99 of file codeclassfielddeclarationblock.cpp.

void CodeClassFieldDeclarationBlock::syncToParent ( )
virtualslot

Definition at line 136 of file codeclassfielddeclarationblock.cpp.

virtual void CodeClassFieldDeclarationBlock::updateContent ( )
pure virtual

Implements OwnedCodeBlock.

Implemented in CPPHeaderCodeClassFieldDeclarationBlock, CPPSourceCodeClassFieldDeclarationBlock, RubyCodeClassFieldDeclarationBlock, DCodeClassFieldDeclarationBlock, and JavaCodeClassFieldDeclarationBlock.


The documentation for this class was generated from the following files:
  • codeclassfielddeclarationblock.h
  • codeclassfielddeclarationblock.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:06:01 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

umbrello/umbrello

Skip menu "umbrello/umbrello"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdesdk API Reference

Skip menu "kdesdk API Reference"
  • kapptemplate
  • kcachegrind
  • kompare
  • lokalize
  • okteta
  • umbrello
  •   umbrello

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal