YGraph.h

/*
  Copyright (C) 2000-2012 Novell, Inc
  This library is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as
  published by the Free Software Foundation; either version 2.1 of the
  License, or (at your option) version 3.0 of the License. This library
  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 Lesser General Public
  License for more details. You should have received a copy of the GNU
  Lesser General Public License along with this library; if not, write
  to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  Floor, Boston, MA 02110-1301 USA
*/


/*-/

  File:     YGraph.h

  Author:   Arvin Schnell <aschnell@suse.de>

/-*/

#ifndef YGraph_h
#define YGraph_h

#include "YWidget.h"

/*
 * Do not include graphviz/types.h here since it conflicts with ncurses
 * headers. People should finally start to use C++ and namespaces!
 *
 * The previous workaround of inserting the graph_t definition here does not
 * work with graphviz >= 2.30.0 since it depends on the define WITH_CGRAPH.
 *
 * For that reason a lot of functions simply take a void* instead of graph_t*.
 */

class YGraphPrivate;

class YGraph : public YWidget
{
protected:

    YGraph( YWidget * parent, const std::string & filename, const std::string & layoutAlgorithm );

    YGraph( YWidget * parent, /* graph_t */ void * graph );

public:

    virtual ~YGraph();

    virtual const char * widgetClass() const { return "YGraph"; }

    virtual bool setProperty( const std::string    & propertyName,
                  const YPropertyValue & val );

    virtual YPropertyValue getProperty( const std::string & propertyName );

    virtual const YPropertySet & propertySet();

    std::string filename() const;

    virtual void setFilename( const std::string & filename );

    std::string layoutAlgorithm() const;

    virtual void setLayoutAlgorithm( const std::string & filename );

    virtual void setGraph( /* graph_t */ void * graph );

    virtual std::string activatedNode() const;

protected:

    virtual void renderGraph( const std::string & filename, const std::string & layoutAlgorithm ) = 0;

    virtual void renderGraph( /* graph_t */ void * graph ) = 0;

private:

    ImplPtr<YGraphPrivate> priv;

};


#endif // YGraph_h