< Home

< Table of Contents

REFERENCE MANUAL

SprocketPath Class Reference
Inheritance diagram for SprocketPath:
Sprocket Object

Public Member Functions

bool Equals (SprocketPath const &in_that) const
 
Canvas GetCanvas () const
 
KeyPath GetKeyPath () const
 
Layout GetLayout () const
 
Model GetModel () const
 
View GetView () const
 
Type ObjectType () const
 
bool operator!= (SprocketPath const &in_that) const
 
SprocketPathoperator= (SprocketPath const &in_that)
 
bool operator== (SprocketPath const &in_that) const
 
void Set (SprocketPath const &in_that)
 
 SprocketPath (Model const &in_model, View const &in_view, Layout const &in_layout, Canvas const &in_canvas)
 
 SprocketPath (Canvas const &in_canvas, Layout const &in_layout, View const &in_view, Model const &in_model)
 
 SprocketPath (Canvas const &in_canvas, size_t in_layer=0)
 
 SprocketPath (SprocketPath const &that)
 
- Public Member Functions inherited from Sprocket
 Sprocket (Sprocket &&in_that)
 
- Public Member Functions inherited from Object
virtual bool Empty () const
 
intptr_t GetClassID () const
 
intptr_t GetInstanceID () const
 
bool HasType (Type in_mask) const
 
 Object (Object &&in_that)
 
Objectoperator= (Object const &other_object)
 
Objectoperator= (Object &&in_that)
 
virtual void Reset ()
 
Type Type () const
 

Additional Inherited Members

- Public Types inherited from Sprocket
enum  UpdateType { Synchronous, Asynchronous }
 
- Static Public Member Functions inherited from Object
template<typename T >
static intptr_t ClassID ()
 

Member Function Documentation

Canvas SprocketPath::GetCanvas ( ) const

Returns the Canvas associated with this SprocketPath

KeyPath SprocketPath::GetKeyPath ( ) const

Creates a key path from the model segment up to the canvas window key, including all segments and include keys along the way. This can be used to facilitate highlighting or gathering of net attributes.

Returns
A key path from the model segment to the canvas window key.
Layout SprocketPath::GetLayout ( ) const

Returns the Layout associated with this SprocketPath

Model SprocketPath::GetModel ( ) const

Returns the Model associated with this SprocketPath

View SprocketPath::GetView ( ) const

Returns the View associated with this SprocketPath

Type SprocketPath::ObjectType ( ) const
inlinevirtual

This function returns the type the object, as declared. This does not necessarily give the true type of the underlying object.

Returns
The declared type of the object in question, which may differ from the true, underlying type.

Reimplemented from Object.


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