umbrello API Documentation

umbrello Class List

Here are the classes, structs, unions and interfaces with brief descriptions:
ActivityDialogDisplays the properties for a ActivityWidget
ActivityPage
ActivityWidgetThis class is the graphical version of a UML Activity. A graphical version of a UML Activity
ActorWidgetThis class is the graphical version of a UML Actor. A graphical version of a UML Actor
AdaImportAda code import
AdaWriterClass AdaWriter is a code generator for UMLClassifier objects
AlignToolBarThis toolbar provides tools for alignment. Toolbar providing alignment tools
ArtifactWidgetDefines a graphical version of the Artifact. A graphical version of a Artifact
AssocGenPageDisplays properties of a UMLObject in a dialog box. Display properties on a UMLObject
AssociationWidgetThis class represents an association inside a diagram. This class represents an association inside a diagram. Bugs and comments to uml-devel@lists.sf.net or http://bugs.kde.org
AssocPageDisplays a page on the tabbed dialog window of ClassPropDlg. The page shows all the Associations that belong to a ConceptWidget
AssocPropDlgBased off of AssocPropDlg class
AssocRolePageDisplays properties of a UMLObject in a dialog box. Display properties on a UMLObject
AssocRulesUsed to determine rules for associations
ASWriterClass ASWriter is a ActionScript code generator for UMLClassifier objects Just call writeClass and feed it a UMLClassifier;
Autolayout::AutolayouterThis is the super class of any class which encapsulate an autolayout algorithm
Autolayout::AutolayouterAdapter
BoxWidgetDisplays a rectangular box. Displays a box
Autolayout::Canvas
ClassGenPageDisplays properties of a UMLObject in a dialog box. Display properties on a UMLObject
ClassifierCodeDocumentClass ClassifierCodeDocument A CodeDocument which represents a UMLClassifier (e.g
ClassifierInfoClass ClassInfo is an object to hold summary information about a classifier in a convenient form for easy access by a code generator
ClassifierListPageA dialog page to display classifier list properties. A dialog page to display classifier properties
ClassifierWidgetCommon implementation for class widget and interface widget
ClassImportInterfaces classparser library to uml models Abstract base for programming language specific import classes
ClassOptionsPageA dialog page to display options for a UMLWidget and its children. A dialog page to display the options for a UMLWidget
ClassPropDlg
ClassWizard
CmdLineExportAllViewsEventThis class provides an event that is posted to the UMLApp when the "export all views" option was set in the command line
CodeBlockClass CodeBlock A "chunk" of code within the code document
CodeBlockWithCommentsClass CodeBlockWithComments A very common type of text block in any type of code
CodeClassFieldClass CodeClassField a special type of parameter.
CodeClassFieldDeclarationBlockClass CodeClassFieldDeclarationBlock Used to declare classifier fields (e.g
CodeCommentClass CodeComment Text which will be comments
CodeDocumentClass CodeDocument A document containing the code for one file
CodeGenerationOptionsPage
CodeGenerationPolicyClass CodeGenerationPolicy This class describes the code generation policy for this project
CodeGenerationPolicyPage
CodeGenerationWizard
CodeGeneratorCodeGenerator is the base class for all CodeGenerators
CodeGenObjectWithTextBlocksClass CodeGenObjectWithTextBlocks This abstract class is for code generator objects which 'own' text blocks
CodeGenPolicyExtBase class for programming language specific code generation policy extensions
CodeMethodBlockClass CodeMethodBlock A common type of "code block" that occurs in OO code
CodeParameterClass CodeParameter A parameter on some type of code
CodeViewerDialogThis class is sooo ugly I don't know where to begin
CodeViewerOptionsPage
Settings::CodeViewerStateConfigurable params for the code viewer tool
ComponentWidgetDefines a graphical version of the Component. A graphical version of a Component
Umbrello::Configurable
CPPCodeCommentClass CPPCodeComment A CPP code comment
CPPCodeDocumentationClass CPPCodeDocumentation A CPP code comment
CPPCodeGenerationForm
CPPCodeGenerationPolicyPage
CPPHeaderCodeDocumentClass CPPHeaderCodeDocument A CPP UMLClassifier Header Code Document
CppImportC++ code import
CPPMakefileCodeDocumentClass CPPMakefileCodeDocument Represents
CPPSourceCodeDocumentClass CPPSourceCodeDocument A CPP UMLClassifier Source Code Document
CppWriterClass CppWriter is a code generator for UMLClassifier objects
CSharpWriterClass CSharpWriter is a C# code generator for UMLClassifier objects Just call writeClass and feed it a UMLClassifier;
DatatypeWidgetDefines a graphical version of the datatype. A graphical version of an datatype
DiagramPrintPageThis is a page on the print dialog to select what diagram(s) you wish to print. A print dialog page
DocbookGeneratorClass DocbookGenerator is a documentation generator for UML documents
DocWindow
Autolayout::DotAutolayouter
DWriterClass DWriter is a code generator for UMLClassifier objects
EntityWidgetDefines a graphical version of the entity. A graphical version of an entity
EnumWidgetDefines a graphical version of the enum. A graphical version of an enum
ExportAllViewsDialogDialog for collecting the "Export all views" params
FloatingTextWidgetThis is a multipurpose class. Displays a line of text or an operation
FloatingTextWidgetControllerController for FloatingTextWidget
ForkJoinWidgetDisplays a fork/join plate in a state diagram
Autolayout::Graph
Autolayout::GraphvizAutolayouter
Autolayout::GraphvizGraph
Autolayout::GraphvizNode
HashEntryAn entry in a hash table
HashTableA hash table Usually the hashtable is generated by the create_hash_table script, from a .table file
IDChangeLogThis class contains all the ID translations done for each UMLObject pasted
IDLImportCORBA IDL code import
IDLWriterClass IDLWriter is a code generator for UMLClassifier objects
JavaANTCodeDocumentClass JavaANTCodeDocument Represents
JavaClassifierCodeDocumentClass JavaClassifierCodeDocument A Java UMLClassifier Code Document
JavaCodeCommentClass JavaCodeComment A Java code comment
JavaCodeDocumentationClass JavaCodeDocumentation A Java code comment
JavaCodeGenerationPolicyPage
JavaImportJava code import
JavaWriterClass JavaWriter is a code generator for UMLClassifier objects
JSWriterClass JSWriter is a JavaScript code generator for UMLClassifier objects Just call writeClass and feed it a UMLClassifier;
LinePath
LinePath::CircleDraw a (hollow) circle
LinkWidgetThis is an interface realized by AssociationWidget and MessageWidget. Interface to FloatingTextWidget for AssociationWidget and MessageWidget
ListPopupMenuA popup menu that depending on what type it is set to will display a different menu. Displays a popup menu
LookupFast keyword lookup
MessageWidgetUsed to display a message on a sequence diagram. Displays a message
MessageWidgetControllerController for MessageWidget
Model_Utils::NameAndTypeData structure filled by parseAttribute()
NativeImportBaseIntermediate base class for native Umbrello implementations of programming language import Base class for native implementations of language import
Autolayout::Node
NodeWidgetDefines a graphical version of the Node. A graphical version of a Node
NoteDialog
NoteWidgetDisplays a note box to allow multiple lines of text to be displayed. Displays a note box
NoteWidgetControllerController for NoteWidget
ObjectWidgetDisplays an instance UMLObject of a concept. Displays an instance of a Concept
ObjectWidgetControllerController for ObjectWidget
Model_Utils::OpDescriptorData structure filled by parseOperation()
OverwriteDialogueUsed by CodeGenerator::findFileName when it needs to ask the user if they want to overwrite and existing file, generate a similar name or cancel
OwnedCodeBlockClass OwnedCodeBlock Describes any codeblock which is 'owned' by a UMLobject of some sort and should be in sync with that parent
OwnedHierarchicalCodeBlockClass OwnedHierarchicalCodeBlock A "chunk" of code within the code document that is "owned" by some umlobject
PackageWidgetDefines a graphical version of the Package. A graphical version of a Package
ParmPropDlgDisplays a dialog box that displays properties of a paramater. A properties dialog box for a parameter
PascalImportPascal code import
PascalWriterPascal class writer
PerlWriterClass PerlWriter is a Perl code generator for UMLClassifier objects Just call writeClass and feed it a UMLClassifier;
PetalNodeRose petal node - parse tree for model import
PetalNode::StringOrNodeUse `string' if it is not empty
Php5WriterClass Php5Writer is a PHP code generator for UMLClassifier objects Just call writeClass and feed it a UMLClassifier;
PhpWriterClass PhpWriter is a PHP code generator for UMLClassifier objects Just call writeClass and feed it a UMLClassifier;
PkgContentsPageThe page shows all the objects that belong to a UMLPackage
KPlayerPopupFrameKPlayer popup frame
KPlayerPopupSliderActionAction representing a popup slider activated by a toolbar button
KPlayerSliderKPlayer's slider widget
KPlayerSliderActionSlider action suitable for insertion into a toolbar
Umbrello::Plugin
Umbrello::PluginLoader
PythonImportPython code import
PythonWriterClass PythonWriter is a python code generator for UMLClassifier objects Just call writeClass and feed it a UMLClassifier;
RubyClassifierCodeDocumentClass RubyClassifierCodeDocument A Ruby UMLClassifier Code Document
RubyCodeCommentClass RubyCodeComment A Ruby code comment
RubyCodeDocumentationClass RubyCodeDocumentation A Ruby code comment
RubyCodeGenerationPolicyPage
RubyWriterClass RubyWriter is a ruby code generator for UMLClassifier objects Just call writeClass and feed it a UMLClassifier;
SelectOpDlgA dialog used to select an operation. A dialog to select an operation
SeqLineWidgetWidget class for graphical representation of sequence lines
SeqLineWidget::DestructionBoxThe destruction box
SettingsDlg
Autolayout::SimpleCanvas
SimpleCodeGeneratorA simple code generator interface designed to work with the existing codewriters
SQLWriterClass SQLWriter is a code generator for UMLClassifier objects
KStartupLogoDisplays a startup splash screen
StateDialogDisplays the properties for a StateWidget
StateWidgetThis class is the graphical version of a UML State. A graphical version of a UML State
TclWriterClass TclWriter is a code generator for UMLClassifier objects
TextBlockClass TextBlock The fundemental unit of text within an output file containing code
ToolBarStateBase class for toolbar states
ToolBarStateArrowArrow tool for select, move and resize widgets and associations
ToolBarStateAssociationAssociation tool to create associations between widgets
ToolBarStateFactoryThe ToolBarStateFactory keeps track of all the toolbar states
ToolBarStateMessagesMessages tool to create messages between objects in sequence diagrams
ToolBarStateOtherOther tool creates almost all the objects (except associations and messages)
ToolBarStatePoolBase class for tools that can use the same state but with different button
UMLActorThis class contains the non-graphical information required for a UML Actor. Information for a non-graphical UML Actor
UMLAppThe base class for UML application windows
UMLArtifactThis class contains the non-graphical information required for a UML Artifact. Non-graphical information for a Artifact
UMLAssociationThis class contains the non-graphic representation of an association. Sets up association information
UMLAttributeThis class is used to set up information for an attribute. Sets up attribute information
UMLAttributeDialog
UMLAttributeListThis sub-class adds copyInto and clone to the QPtrList<UMLAttribute> base class
UMLCanvasObjectThis class contains the non-graphical information required for UMLObjects which appear as moveable widgets on the canvas. Non-graphical information for a UMLCanvasObject
UMLClassifierThis class defines the non-graphical information required for a UML Classifier (ie a class or interface). Information for a non-graphical Concept/Class
UMLClassifierListItemClassifiers (classes, interfaces) have lists of operations, attributes, templates and others. A base class for classifier list items (e.g. attributes)
UMLClassifierListItemListThis sub-class adds copyInto and clone to the QPtrList<UMLClassifierListItem> base class
UMLClipboardThis class manages the uml's interaction with the KDE Clipboard. Clipboard management class
UMLComponentThis class contains the non-graphical information required for a UML Component. Non-graphical information for a Component
UMLDocUMLDoc provides a document object for a document-view model
UMLDragThis class provides encoding and decoding for the uml data that will be used in a drag and drop operation or in a copy or paste operation
UMLEntityThis class contains the non-graphical information required for a UML Entity. Non-graphical Information for an Entity
UMLEntityAttributeThis class is used to set up information for an entityattribute. Sets up entityattribute information
UMLEntityAttributeDialog
UMLEntityAttributeListThis sub-class adds copyInto and clone to the QPtrList<UMLEntityAttribute> base class
UMLEnumThis class contains the non-graphical information required for a UML Enum. Non-graphical Information for an Enum
UMLEnumLiteralThis class is used to set up information for an enum literal. Sets up attribute information
UMLFolderThis class manages the UMLObjects and UMLViews of a Folder. Non-graphical management of objects and diagrams of a Folder
UMLListViewThis is one of the main classes used in this program. Displays the list view for the program
UMLListViewItemItems used by the class UMLListView. Items used by UMLListView
UMLNodeThis class contains the non-graphical information required for a UML Node. Non-graphical information for a Node
UMLObjectThis class is the non-graphical version of UMLWidget. The base class for UML objects
UMLObjectListThis sub-class adds copyInto and clone to the QPtrList<UMLObject> base class
UMLOperationThis class represents an operation in the UML model
UMLOperationDialog
UMLPackageThis class contains the non-graphical information required for a UML Package. Non-graphical information for a Package
UMLRoleThis class contains the non-graphic representation of an association role
UMLRoleDialog
UMLRolePropertiesDisplays properties of a UMLRole in a widget which may be used as a properties page or a stand-alone dialog
UMLStereotypeThis class is used to set up information for a stereotype. Sets up stereotype information
UMLTemplateThis class holds information used by template classes, called paramaterised class in UML and a generic in Java. Sets up template information
UMLTemplateDialogA dialog to edit the properties of a class template (paramaterised class)
UMLUseCaseThis class contains the non-graphical information required for a UML UseCase. Information for a non-graphical UML UseCase
UMLViewUMLView instances represent diagrams
UMLViewCanvas
UMLViewDialog
UMLViewImageExporterExports the view as an image
UMLViewImageExporterAllExports all the views in the UML document as images
UMLViewImageExporterModelExports an UMLView in various image formats
UMLWidgetThis is the base class for nearly all graphical widgets. The base class for graphical UML objects
UMLWidgetColorPage
UMLWidgetControllerController for UMLWidget This class takes care of user interaction with UMLWidgets: select, deselect, move, resize..
UseCaseWidgetThis class is the graphical version of a UML UseCase. A graphical version of a UML UseCase
WidgetBaseCommon base class for UMLWidget and AssociationWidget
WorkToolBarThis is the toolbar that is displayed on the right-hand side of the program window. The toolbar that is different for each type of diagram
XhtmlGeneratorClass XhtmlGenerator is a documentation generator for UML documents
XMLCodeCommentClass XMLCodeDocumentation A XML (code) comment
XMLSchemaWriterClass XMLSchemaWriter is a code generator for UMLClassifier objects
KDE Logo
This file is part of the documentation for umbrello Version 3.1.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Tue Jun 26 08:08:03 2007 by doxygen 1.4.1 written by Dimitri van Heesch, © 1997-2003