koffice/kivio/kiviopart/kiviosdk/kivio_connector_point.cpp

/*
 * Kivio - Visual Modelling and Flowcharting
 * Copyright (C) 2000-2001 theKompany.com & Dave Marotti
 *
 * 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.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
#include "kivio_common.h"
#include "kivio_connector_point.h"
#include "kivio_connector_target.h"
#include "kivio_stencil.h"

KivioConnectorPoint::KivioConnectorPoint()
{
    m_pTarget = 0L;
    m_pStencil = 0L;
    m_targetId = -1;
    m_connectable = true;
}

KivioConnectorPoint::KivioConnectorPoint( KivioStencil *pParent, bool conn )
{
    m_pTarget = 0L;
    m_pStencil = pParent;
    m_targetId = -1;
    m_connectable = conn;
}

KivioConnectorPoint::~KivioConnectorPoint()
{
    if( m_pTarget )
    {
        m_pTarget->removeConnectorPointFromList( this );
        m_pTarget = 0L;
    }

    m_pStencil = 0L;
}

/**
 * Sets the target to a value.
 *
 * @param 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.
 */
void KivioConnectorPoint::setTarget( KivioConnectorTarget *pTarget  )
{
   if( m_connectable == false )
   {
      return;
   }

    if( m_pTarget )
    {
         m_pTarget->removeConnectorPointFromList( this );
    }


    m_pTarget = pTarget;

    m_pos.setX(pTarget->x());
    m_pos.setY(pTarget->y());

    m_pTarget->addConnectorPointToList( this );
}


/**
 * Sets the x coordinate.
 *
 * @param newX The new value
 * @param 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.
 */
void KivioConnectorPoint::setX( double newX, bool updateStencil )
{
  double oldX = m_pos.x();
  m_pos.setX(newX);

  if( updateStencil && m_pStencil )
    m_pStencil->updateConnectorPoints(this, oldX, m_pos.y());
}


/**
 * Sets the y coordinate.
 *
 * @param newY The new value
 * @param 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.
 */
void KivioConnectorPoint::setY( double newY, bool updateStencil )
{
   double oldY = m_pos.y();
    m_pos.setY(newY);

    if( updateStencil && m_pStencil )
        m_pStencil->updateConnectorPoints(this, m_pos.x(), oldY);
}


/**
 * Sets the coordinates.
 *
 * @param newX The new x value
 * @param newY The new y value
 * @param 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.
 */
 void KivioConnectorPoint::setPosition( double newX, double newY, bool updateStencil )
{
  double oldX = m_pos.x();
  double oldY = m_pos.y();

  m_pos.setCoords(newX, newY);

  if( updateStencil && m_pStencil )
    m_pStencil->updateConnectorPoints(this, oldX, oldY);
}


/**
 * Disconnects from the target, with optional behavior.
 *
 * @param 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.
 */
void KivioConnectorPoint::disconnect( bool removeFromTargetList )
{
    if( m_pTarget )
    {
        if( removeFromTargetList == true )
            m_pTarget->removeConnectorPointFromList(this);

        m_pTarget = 0L;
        m_targetId = -1;
    }

}


/**
 * Loads this object from an XML file.
 *
 * @param e The TQDomElement to load from.
 *
 * This will load the necessary values from an XML file.
 */
bool KivioConnectorPoint::loadXML( const TQDomElement &e )
{
    m_pos.setX(XmlReadFloat( e, "x", 1.0f ));
    m_pos.setY(XmlReadFloat( e, "y", 1.0f ));
    m_targetId = XmlReadInt( e, "targetId", -1 );
    m_connectable = (bool)XmlReadInt( e, "connectable", (int)true );

    return true;
}


/**
 * Saves this object to an XML file.
 *
 * @param doc The TQDomDocument to save to.
 *
 * This creates a new TQDomElement and saves its data to it.
 *
 * @returns The new element created and saved to.
 */
TQDomElement KivioConnectorPoint::saveXML( TQDomDocument &doc )
{
    TQDomElement e = doc.createElement("KivioConnectorPoint");

    XmlWriteFloat( e, "x", m_pos.x() );
    XmlWriteFloat( e, "y", m_pos.y() );
    XmlWriteInt( e, "connectable", (int)m_connectable );

    if( m_targetId != -1 )
        XmlWriteInt( e, "targetId", m_targetId );

    return e;
}

void KivioConnectorPoint::moveBy( double _x, double _y, bool updateStencil )
{
   m_pos += KoPoint(_x, _y);

  if( updateStencil && m_pStencil )
    m_pStencil->updateConnectorPoints(this, _x, _y);
}

bool KivioConnectorPoint::isConnected()
{
  return (m_pTarget != 0L);
}