kivio

KivioConnectorPoint Class Reference

List of all members.

Detailed Description

Definition at line 30 of file kivio_connector_point.h.


Public Member Functions

 KivioConnectorPoint (KivioStencil *, bool conn=true)
 KivioConnectorPoint ()
virtual ~KivioConnectorPoint ()
bool loadXML (const QDomElement &)
QDomElement saveXML (QDomDocument &)
KivioConnectorTarget * target () const
void setTarget (KivioConnectorTarget *)
KivioStencil * stencil () const
void setStencil (KivioStencil *p)
void setTargetId (int i)
int targetId () const
double x () const
double y () const
KoPoint position () const
void setX (double, bool updateStencil=true)
void setY (double, bool updateStencil=true)
void setPosition (double, double, bool updateStencil=true)
void moveBy (double _x, double _y, bool updateStencil=true)
bool connectable () const
void setConnectable (bool b)
void disconnect (bool removeFromTargetList=true)
bool isConnected ()

Protected Attributes

KoPoint m_pos
KivioConnectorTarget * m_pTarget
KivioStencil * m_pStencil
int m_targetId
bool m_connectable

Member Function Documentation

bool KivioConnectorPoint::loadXML ( const QDomElement &  e  ) 

Loads this object from an XML file.

Parameters:
e The QDomElement to load from.
This will load the necessary values from an XML file.

Definition at line 172 of file kivio_connector_point.cpp.

QDomElement KivioConnectorPoint::saveXML ( QDomDocument &  doc  ) 

Saves this object to an XML file.

Parameters:
doc The QDomDocument to save to.
This creates a new QDomElement and saves its data to it.

Returns:
The new element created and saved to.

Definition at line 192 of file kivio_connector_point.cpp.

void KivioConnectorPoint::setTarget ( KivioConnectorTarget *  pTarget  ) 

Sets the target to a value.

Parameters:
pTarget The target to connect to
This sets the KivioConnectorTarget we are attached to. In addition to setting the pointer, it also tells the target to add this as a connected point.

Definition at line 60 of file kivio_connector_point.cpp.

void KivioConnectorPoint::setX ( double  newX,
bool  updateStencil = true 
)

Sets the x coordinate.

Parameters:
newX The new value
updateStencil Whether or not the stencil's geometry should be updated (def=true)
Sets the X coordinate to a new value, and optionally updates the stencil's geometry if updateStencil is true.

Definition at line 91 of file kivio_connector_point.cpp.

void KivioConnectorPoint::setY ( double  newY,
bool  updateStencil = true 
)

Sets the y coordinate.

Parameters:
newY The new value
updateStencil Whether or not the stencil's geometry should be updated (def=true)
Sets the Y coordinate to a new value, and optionally updates the stencil's geometry if updateStencil is true.

Definition at line 110 of file kivio_connector_point.cpp.

void KivioConnectorPoint::setPosition ( double  newX,
double  newY,
bool  updateStencil = true 
)

Sets the coordinates.

Parameters:
newX The new x value
newY The new y value
updateStencil Whether or not the stencil's geometry should be updated (def=true)
Sets the X & Y coordinates to new values, and optionally updates the stencil's geometry if updateStencil is true.

Definition at line 130 of file kivio_connector_point.cpp.

void KivioConnectorPoint::disconnect ( bool  removeFromTargetList = true  ) 

Disconnects from the target, with optional behavior.

Parameters:
removeFromTargetList Whether we should tell the target to remove us from it's list or not. (Default=true).
Call this function if you want this connector to disconnect itself from it's target. If removeFromTargetList is true, then we call KivioConnectorTarget::removeConnectorPointFromList() which causes the target to look for us in his list of connections and remove us.

Definition at line 151 of file kivio_connector_point.cpp.

The documentation for this class was generated from the following files:

kivio

API Dox
KDE Home | KDE Accessibility Home | Description of Access Keys