GraphvizLayouterBackend Class Reference

#include <graphvizlayouterbackend_p.h>

Public Types
enum	LayoutMode { RecursiveMode , NonRecursiveMode }

Public Member Functions
	GraphvizLayouterBackend ()
	GraphvizLayouterBackend (const GraphvizLayouterBackend &other)=delete
	~GraphvizLayouterBackend ()
QRectF	boundingRect () const
void	buildState (KDSME::State *state)
void	buildTransition (KDSME::Transition *transition)
void	buildTransitions (const KDSME::State *state)
void	closeLayout ()
void	import ()
void	layout ()
LayoutMode	layoutMode () const
void	openLayout (KDSME::State *state, const KDSME::LayoutProperties *properties)
GraphvizLayouterBackend &	operator= (const GraphvizLayouterBackend &)=delete
void	saveToFile (const QString &filePath, const QString &format=QStringLiteral("png"))
void	setLayoutMode (LayoutMode mode)

Detailed Description

Definition at line 33 of file graphvizlayouterbackend_p.h.

Member Enumeration Documentation

LayoutMode

enum GraphvizLayouterBackend::LayoutMode

Enumerator
RecursiveMode	Performs a recursive import of all state machine elements,. See also buildState and buildTransitions
NonRecursiveMode	Only a direct import of state machine elements.

Definition at line 36 of file graphvizlayouterbackend_p.h.

Constructor & Destructor Documentation

GraphvizLayouterBackend() [1/2]

GraphvizLayouterBackend::GraphvizLayouterBackend

(

)

Definition at line 542 of file graphvizlayouterbackend.cpp.

References lt_preloaded_symbols.

~GraphvizLayouterBackend()

GraphvizLayouterBackend::~GraphvizLayouterBackend

(

)

Definition at line 556 of file graphvizlayouterbackend.cpp.

References closeLayout().

GraphvizLayouterBackend() [2/2]

GraphvizLayouterBackend::GraphvizLayouterBackend ( const GraphvizLayouterBackend &  other )

delete

Member Function Documentation

boundingRect()

QRectF GraphvizLayouterBackend::boundingRect

(

)

const

Definition at line 650 of file graphvizlayouterbackend.cpp.

Referenced by KDSME::GraphvizLayerLayouter::layout(), and KDSME::GraphvizLayouter::layout().

buildState()

void GraphvizLayouterBackend::buildState

(

KDSME::State *

state

)

Fill the Graphviz with nodes based on attributes of state state

Note

If RecursiveMode is selected, all descendants of state will get imported as well

Definition at line 630 of file graphvizlayouterbackend.cpp.

Referenced by KDSME::GraphvizLayerLayouter::layout(), and KDSME::GraphvizLayouter::layout().

buildTransition()

void GraphvizLayouterBackend::buildTransition

(

KDSME::Transition *

transition

)

Definition at line 640 of file graphvizlayouterbackend.cpp.

Referenced by KDSME::GraphvizLayerLayouter::layout().

buildTransitions()

void GraphvizLayouterBackend::buildTransitions

(

const KDSME::State *

state

)

Fill Graphviz with edges based on attributes of the transitions of state

Note

If RecursiveMode is selected, transitions of descendants of state will get imported as well

Definition at line 635 of file graphvizlayouterbackend.cpp.

Referenced by KDSME::GraphvizLayouter::layout().

closeLayout()

void GraphvizLayouterBackend::closeLayout

(

)

Definition at line 625 of file graphvizlayouterbackend.cpp.

Referenced by ~GraphvizLayouterBackend(), KDSME::GraphvizLayerLayouter::layout(), and KDSME::GraphvizLayouter::layout().

import()

void GraphvizLayouterBackend::import

(

)

Definition at line 645 of file graphvizlayouterbackend.cpp.

Referenced by KDSME::GraphvizLayerLayouter::layout(), and KDSME::GraphvizLayouter::layout().

layout()

void GraphvizLayouterBackend::layout

(

)

Definition at line 578 of file graphvizlayouterbackend.cpp.

References KDSME::GVUtils::_gvLayout(), KDSME::ObjectHelper::addressToString(), KDSME::Element::label, KDSME::State::machine(), and saveToFile().

Referenced by KDSME::GraphvizLayerLayouter::layout(), and KDSME::GraphvizLayouter::layout().

layoutMode()

GraphvizLayouterBackend::LayoutMode GraphvizLayouterBackend::layoutMode

(

)

const

Defines the layout mode for this instance

Note

Default is RecursiveMode

Definition at line 568 of file graphvizlayouterbackend.cpp.

openLayout()

void GraphvizLayouterBackend::openLayout	(	KDSME::State *	state,
		const KDSME::LayoutProperties *	properties
	)

Definition at line 617 of file graphvizlayouterbackend.cpp.

References KDSME::ObjectHelper::addressToString().

Referenced by KDSME::GraphvizLayerLayouter::layout(), and KDSME::GraphvizLayouter::layout().

operator=()

GraphvizLayouterBackend & GraphvizLayouterBackend::operator= ( const GraphvizLayouterBackend &  )

delete

saveToFile()

void GraphvizLayouterBackend::saveToFile	(	const QString &	filePath,
		const QString &	format = QStringLiteral("png")
	)

Render the current context to file at filePath

Parameters

filePath	the file path
format	'format' argument to gvRenderFilename (e.g. "png" or "dot")

Note

Context must be open

Definition at line 597 of file graphvizlayouterbackend.cpp.

Referenced by layout().

setLayoutMode()

void GraphvizLayouterBackend::setLayoutMode

(

LayoutMode

mode

)

Definition at line 573 of file graphvizlayouterbackend.cpp.

Referenced by KDSME::GraphvizLayerLayouter::GraphvizLayerLayouter().

---

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

• graphvizlayouterbackend_p.h
• graphvizlayouterbackend.cpp