#include <YGraph.h>

Inheritance diagram for YGraph:

Collaboration diagram for YGraph:

Public Member Functions
virtual	~YGraph ()

virtual const char *	widgetClass () const

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 (void *graph)

virtual std::string	activatedNode () const

Public Member Functions inherited from YWidget
virtual	~YWidget ()

virtual std::string	debugLabel () const

std::string	helpText () const

void	setHelpText (const std::string &helpText)

bool	hasChildren () const

YWidget *	firstChild () const

YWidget *	lastChild () const

YWidgetListIterator	childrenBegin () const

YWidgetListIterator	childrenEnd () const

YWidgetListConstIterator	childrenConstBegin () const

YWidgetListConstIterator	childrenConstEnd () const

YWidgetListIterator	begin ()

YWidgetListIterator	end ()

int	childrenCount () const

bool	contains (YWidget *child) const

virtual void	addChild (YWidget *child)

virtual void	removeChild (YWidget *child)

void	deleteChildren ()

YWidget *	parent () const

bool	hasParent () const

void	setParent (YWidget *newParent)

YDialog *	findDialog ()

YWidget *	findWidget (YWidgetID *id, bool doThrow=true) const

virtual int	preferredWidth ()=0

virtual int	preferredHeight ()=0

virtual int	preferredSize (YUIDimension dim)

virtual void	setSize (int newWidth, int newHeight)=0

bool	isValid () const

bool	beingDestroyed () const

void *	widgetRep () const

void	setWidgetRep (void *toolkitWidgetRep)

bool	hasId () const

YWidgetID *	id () const

void	setId (YWidgetID *newId_disown)

virtual void	setEnabled (bool enabled=true)

void	setDisabled ()

virtual bool	isEnabled () const

virtual bool	stretchable (YUIDimension dim) const

void	setStretchable (YUIDimension dim, bool newStretch)

void	setDefaultStretchable (YUIDimension dim, bool newStretch)

virtual int	weight (YUIDimension dim)

bool	hasWeight (YUIDimension dim)

void	setWeight (YUIDimension dim, int weight)

void	setNotify (bool notify=true)

bool	notify () const

void	setNotifyContextMenu (bool notifyContextMenu=true)

bool	notifyContextMenu () const

bool	sendKeyEvents () const

void	setSendKeyEvents (bool doSend)

bool	autoShortcut () const

void	setAutoShortcut (bool _newAutoShortcut)

int	functionKey () const

bool	hasFunctionKey () const

virtual void	setFunctionKey (int fkey_no)

virtual bool	setKeyboardFocus ()

virtual std::string	shortcutString () const

virtual void	setShortcutString (const std::string &str)

virtual const char *	userInputProperty ()

void	dumpWidgetTree (int indentationLevel=0)

void	dumpDialogWidgetTree ()

void	setChildrenEnabled (bool enabled)

virtual void	saveUserInput (YMacroRecorder *macroRecorder)

void *	operator new (size_t size)

void	operator delete (void *ptr) noexcept

virtual void	startMultipleChanges ()

virtual void	doneMultipleChanges ()

Protected Member Functions
	YGraph (YWidget *parent, const std::string &filename, const std::string &layoutAlgorithm)

	YGraph (YWidget parent, void graph)

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

virtual void	renderGraph (void *graph)=0

Protected Member Functions inherited from YWidget
	YWidget (YWidget *parent)

YWidgetChildrenManager *	childrenManager () const

void	setChildrenManager (YWidgetChildrenManager *manager)

void	setBeingDestroyed ()

void	dumpWidget (YWidget *w, int indentationLevel)

Detailed Description

A graph with nodes and edges, rendered with Graphviz.

Constructor & Destructor Documentation

◆ YGraph() [1/2]

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

protected

Constructor.

Loads a graph in DOT format from filename and uses the layout algorithm layoutAlgorithm to layout and then render the graph. The layout algorithm can be any string accepted by the function gvLayout from graphviz, e.g. "dot" or "neato".

◆ YGraph() [2/2]

YGraph::YGraph	(	YWidget *	parent,
		void *	graph )

protected

Constructor.

Renders the graph. The graph must already contain layout information.

◆ ~YGraph()

YGraph::~YGraph ( )

virtual

Destructor.

Member Function Documentation

◆ activatedNode()

string YGraph::activatedNode ( ) const

virtual

Return name of activated node. Activation can happen due to e.g. single right mouse click (context menu) or double left mouse click.

◆ filename()

string YGraph::filename ( ) const

Return the filename that describes the graph.

◆ getProperty()

YPropertyValue YGraph::getProperty ( const std::string & propertyName )

virtual

Get a property. Reimplemented from YWidget.

This method may throw YUIPropertyExceptions.

Reimplemented from YWidget.

◆ layoutAlgorithm()

string YGraph::layoutAlgorithm ( ) const

Return the layout-algorithm used for the graph.

◆ propertySet()

const YPropertySet & YGraph::propertySet ( )

virtual

Return this class's property set. This also initializes the property upon the first call.

Reimplemented from YWidget.

◆ renderGraph() [1/2]

virtual void YGraph::renderGraph	(	const std::string &	filename,
		const std::string &	layoutAlgorithm )

protectedpure virtual

Render the graph from the filename. Derived classes are required to implement this.

◆ renderGraph() [2/2]

virtual void YGraph::renderGraph ( void * graph )

protectedpure virtual

Render the graph. Derived classes are required to implement this.

◆ setFilename()

void YGraph::setFilename ( const std::string & filename )

virtual

Set the filename that describes the graph and render the graph. Derived classes can reimplent this, but they should call this base class method in the new implementation. Most derived classes only need to implement renderGraph().

◆ setGraph()

void YGraph::setGraph ( void * graph )

virtual

Render the graph. Derived classes can reimplent this, but they should call this base class method in the new implementation. Most derived classes only need to implement renderGraph().

◆ setLayoutAlgorithm()

void YGraph::setLayoutAlgorithm ( const std::string & filename )

virtual

Set the layout-algorithm used for the graph. Derived classes can reimplent this, but they should call this base class method in the new implementation.

◆ setProperty()

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

virtual

Set a property. Reimplemented from YWidget.

This function may throw YUIPropertyExceptions.

This function returns 'true' if the value was successfully set and 'false' if that value requires special handling (not in error cases: those are covered by exceptions).

Reimplemented from YWidget.

◆ widgetClass()

virtual const char * YGraph::widgetClass ( ) const

inlinevirtual

Returns a descriptive name of this widget class for logging, debugging etc.

Reimplemented from YWidget.

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

/__w/libyui/libyui/libyui/src/YGraph.h
/__w/libyui/libyui/libyui/src/YGraph.cc

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ YGraph() [1/2]

◆ YGraph() [2/2]

◆ ~YGraph()

Member Function Documentation

◆ activatedNode()

◆ filename()

◆ getProperty()

◆ layoutAlgorithm()

◆ propertySet()

◆ renderGraph() [1/2]

◆ renderGraph() [2/2]

◆ setFilename()

◆ setGraph()

◆ setLayoutAlgorithm()

◆ setProperty()

◆ widgetClass()