class UMLWidget

* This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. More...

Definition#include <./umlwidget.h>
InheritsQCanvasRectangle (unknown) [public ], QObject (unknown) [public ], Uml [public ]
Inherited byActivityWidget, ActorWidget, ConceptWidget, FloatingText, MessageWidget, NoteWidget, ObjectWidget, StateWidget, UseCaseWidget
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

Public Methods

Public Slots

Signals

Protected Methods

Protected Members


Detailed Description

* This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * *************************************************************************

 UMLWidget ( UMLView * view, UMLObject * o, UMLWidgetData * pData )

UMLWidget

Creates a UMLWidget object.

Parameters:
viewThe view to be displayed on.
oThe UMLObject to represent.
pDataThe UMLWidgetData for this UMLWidget, it must not be null

 UMLWidget ( UMLView * view, int id, UMLWidgetData * pData)

UMLWidget

Creates a UMLWidget object.

Parameters:
viewThe view to be displayed on.
idThe id of the widget.
pDataThe UMLWidgetData for this UMLWidget, it must not be null

 UMLWidget ( UMLView * view, UMLWidgetData * pData )

UMLWidget

Creates a UMLWidget object.

Parameters:
viewThe view to be displayed on.
pDataThe UMLWidgetData for this UMLWidget, it must not be null

 ~UMLWidget ()

~UMLWidget

Standard deconstructor

Uml::UMLWidget_Type  getBaseType ()

getBaseType

[virtual]

Returns the type of object this represents.

Returns: Returns the type of object this represents.

int  getID ()

getID

[virtual]

Returns the ID of this object.

Returns: Returns the ID this object.

void  setID (int Id)

setID

[virtual]

Sets the id og the UMLWidget.

Parameters:
idThe id to set the widget to.

void  addAssoc (AssociationWidget* pAssoc)

addAssoc

Adds one to the amount of association this object is connected to.

void  removeAssoc (AssociationWidget* pAssoc)

removeAssoc

Removes one from the count of the amount of associations this object is connected to.

UMLObject *  getUMLObject ()

getUMLObject

Returns the UMLObject set to represent.

void  setUMLObject (UMLObject * o)

setUMLObject

Sets the UMLObject to represent.

Parameters:
oThe object to represent.

bool  serialize (QDataStream *s, bool archive)

serialize

[virtual]

Use to save or load this classes information

Parameters:
sPointer to the datastream (file) to save/load from.
archiveIf true will save the classes information, else will load the information.

Returns: Returns the status of the operation.

long  getClipSizeOf ()

getClipSizeOf

[virtual]

Returns the amount of bytes needed to serialize an instance object to the clipboard

void  mouseReleaseEvent (QMouseEvent * me)

mouseReleaseEvent

[virtual]

Overrides the standard operation.

void  mouseDoubleClickEvent (QMouseEvent * )

mouseDoubleClickEvent

[virtual]

Overrides the standard operation.

bool  getUseFillColor ()

getUseFillColor

Return the status of using fill color.

Returns: Return the status of using fill color.

QColor  getBGColor ()

getBGColor

Return the background color.

Returns: Return the background color.

QColor  getLineColor ()

getLineColor

Return the line color.

Returns: Return the line color.

void  mouseMoveEvent (QMouseEvent *me)

mouseMoveEvent

[virtual]

Overrides the standard operation.

bool  isText ()

isText

[virtual]

Returns wether this is a line of text. Used for transparency in printing.

void  setUseFillColor (bool fc)

setUseFillColor

Set the status of using fill color.

Parameters:
fcthe status of using fill color.

void  setSelected (bool _select)

setSelected

[virtual]

Sets the state of whether the widget is selected.

Parameters:
_selectThe state of whether the widget is selected.

bool  getSelected ()

getSelected

Returns the state of whether the widget is selected.

Returns: Returns the state of whether the widget is selected.

void  setView (UMLView * v)

setView

Sets the view the widget is on.

Parameters:
vThe view the widget is on.

int  getOldID ()

getOldID

[virtual]

Returns the old id of the widget. Used for copy/cut operations.

Returns: Returns the old id of the widget.

void  setOldID (int _id)

setOldID

[virtual]

Sets the old id of the widget. Used for copy/cut operations.

Parameters:
_idSets the old id of the widget.

bool  Activate (IDChangeLog* ChangeLog = 0)

Activate

[virtual]

Activate the object after serializing it from a QDataStream

bool  onWidget (const QPoint & p)

onWidget

[virtual]

Returns true if the given point is in the boundaries of the widget

void  draw ( QPainter & p, int offsetX, int offsetY )

draw

[virtual]

Draws the UMLWidget on the given paint device

void  setFont ( QFont font )

setFont

[virtual]

Sets the font the widget is to use.

QFont  getFont ()

getFont

[virtual]

Returns the font the widget is too use.

bool  getStartMove ()

getStartMove

Returns whether we triggered the update of position movement. If so, you probably don't want to move it.

void  setX ( int x )

setX

Sets the x-coordinate.

void  setY ( int y )

setY

Sets the y-coordinate.

QString  getDoc ()

getDoc

[virtual]

Used by some child classes to get documentation.

void  setDoc ( QString )

setDoc

[virtual]

Used by some child classes to set documentation.

const bool&  IsActivated ()

IsActivated

[virtual]

Returns true if the Activate method has been called for this instance

UMLWidgetData*  getData ()

getData

[virtual]

Return a UMLWidgetData Containing all information about this instance of UMLWidget

void  SynchronizeData ()

SynchronizeData

[virtual]

Synchronize the Widget's m_pData member with its display properties, for example: the X and Y positions of the widget, etc

void  SetName (QString strName)

SetName

[virtual]

Sets the m_Name property

QString  GetName ()

GetName

[virtual]

Returns a copy of m_Name

void  StartPopupMenu (QPoint At)

StartPopupMenu

Starts the popup menu.

void  AdjustAssocs (int x, int y)

AdjustAssocs

Adjusts associations with the given co-ordinates

void  SetActivated (bool Active = true)

SetActivated

Set the m_bActivated flag of a widget but does not perform the Activate method

void  cleanup ()

cleanup

[virtual]

Used to cleanup any other widget it may need to delete. Used by child classes. This should be called before deleting a widget of a diagram.

void  drawSelected (QPainter * p, int offsetX, int offsetY)

drawSelected

[protected virtual]

Draws that the widhet is selected.

void  drawShape (QPainter &p )

drawShape

[protected virtual]

Overrides default method.

void  mousePressEvent (QMouseEvent *me)

mousePressEvent

[protected virtual]

Overrides the standard operation.

void  moveEvent (QMoveEvent *)

moveEvent

[protected virtual]

Overrides the standard operation.

void  calculateSize ()

calculateSize

[protected virtual]

Calculates the size of the widget.

void  init ()

init

[protected]

Initializes key attributes of the class.

bool m_bMouseDown

m_bMouseDown

[protected]

bool m_bMouseOver

m_bMouseOver

[protected]

bool m_bSelected

m_bSelected

[protected]

bool m_bStartMove

m_bStartMove

[protected]

int m_nOldX

m_nOldX

[protected]

int m_nOldY

m_nOldY

[protected]

int m_nPosX

m_nPosX

[protected]

int m_nOldID

m_nOldID

[protected]

UMLObject * m_pObject

m_pObject

[protected]

UMLView * m_pView

m_pView

[protected]

ListPopupMenu * m_pMenu

m_pMenu

[protected]

QColor m_FillColor

m_FillColor

[protected]

QColor m_LineColor

m_LineColor

[protected]

bool m_bResizing

m_bResizing

[protected]

UMLWidgetData* m_pData

m_pData

[protected]

int m_nPressOffsetX

m_nPressOffsetX

[protected]

int m_nPressOffsetY

m_nPressOffsetY

[protected]

int m_nOldH

m_nOldH

[protected]

int m_nOldW

m_nOldW

[protected]

bool m_bActivated

m_bActivated

[protected]

QString m_Name

m_Name

[protected]

void  slotRemovePopupMenu ()

slotRemovePopupMenu

[virtual slot]

This slot is entered when an event has occurred on the views display, most likely a mouse event. Before it sends out that mouse event all children should make sure that they don't have a menu active or there could be more than one popup menu displayed.

void  slotChangeWidget (UMLObject * o)

slotChangeWidget

[virtual slot]

Whena widget changes this slot captures that signal.

void  slotMenuSelection (int sel)

slotMenuSelection

[virtual slot]

Captures any popup menu signals for menus it created.

void  slotWidgetMoved (int id)

slotWidgetMoved

[virtual slot]

Captures when another widget moves if it is link to it that signal.

void  slotColorChanged (int viewID)

slotColorChanged

[virtual slot]

Captures a color change signal.

void  slotClearAllSelected ()

slotClearAllSelected

[slot]

Captures a sigClearAllSelected signal sent by UMLView

void  slotSnapToGrid ()

slotSnapToGrid

[slot]

Tells the widget to snap to grid. Will use the grid settings of the UMLView it belongs to.

void  sigWidgetMoved (int)

sigWidgetMoved

[signal]

Emit when the widget moves its' position.


Generated by: jr on radge on Wed Sep 25 00:11:47 2002, using kdoc 2.0a54.