rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Graph Layout Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

report.h File Reference

#include <ilviews/layout/macros.h>
#include <ilviews/util/runtime.h>
#include <ilviews/intrface/value.h>

Classes

class  IlvGraphLayoutReport
 The base class of the objects used to store information about the behavior of the layout algorithms. More...

Enumerations

enum  IlvLayoutReportType {
  IlvLayoutReportInitialCode, IlvLayoutReportLayoutDone, IlvLayoutReportNotNeeded, IlvLayoutReportEmptyGrapher,
  IlvLayoutReportNoMoveableNode, IlvLayoutReportNoReshapeableLink, IlvLayoutReportLayoutStarted, IlvLayoutReportLayoutFinished,
  IlvLayoutReportGreatestCode
}
 

This enumeration defines values used to indicate the status and behavior of the layout algorithm.

More...

Detailed Description

[library ilvlayout ilviews/layout/report.h] Declaration of graph layout report classes.


Enumeration Type Documentation

This enumeration defines values used to indicate the status and behavior of the layout algorithm.

Enumerator:
IlvLayoutReportInitialCode 

The initial value of the code.

The method IlvGraphLayoutReport::getCode() returns this value if you have never set a different code using IlvGraphLayoutReport::setCode(IlvLayoutReportType).

IlvLayoutReportLayoutDone 

The layout was performed normally.

IlvLayoutReportNotNeeded 

The layout was not performed because there was no significant change in the graph since the last time the layout was performed successfully.

This normally means that there was no change in topology (no nodes and no links were added or removed), no change in position (no nodes and no links were moved), and no change in parameter values.

IlvLayoutReportEmptyGrapher 

The layout was not performed because the graph is empty.

IlvLayoutReportNoMoveableNode 

The layout was not performed because there are no moveable nodes (all nodes are fixed).

This may occur only if the subclass of IlvGraphLayout supports the preservation of fixed nodes and the method IlvGraphLayout::setPreserveFixedNodes(IlBoolean) has been called with an IlTrue argument.

See also:
IlvGraphLayout::supportsPreserveFixedLinks().
IlvLayoutReportNoReshapeableLink 

The layout was not performed because there are no reshapeable links (all links are fixed).

This may only occur if the subclass of IlvGraphLayout supports the preservation of fixed links and the method IlvGraphLayout::setPreserveFixedLinks(IlBoolean) has been called with an IlTrue argument.

See also:
IlvGraphLayout::supportsPreserveFixedLinks().
IlvLayoutReportLayoutStarted 

The layout was started.

IlvLayoutReportLayoutFinished 

The layout was finished.

IlvLayoutReportGreatestCode 

The greatest integer value used as a code.

You can use the value IlvLayoutReportGreatestCode+1 for the definition of a new code.


© Copyright 2012, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.