SCENE C++ API  2.0.22
Public Member Functions | List of all members
LSWorkspaceEvent Class Reference

The LSWorkspaceEvent class represents events associated to a specific workspace. More...

#include <lsworkspaceevent.h>

+ Inheritance diagram for LSWorkspaceEvent:

Public Member Functions

 LSWorkspaceEvent (ref_ptr< LSWorkspace > workspace)
 Constructor. More...
 
ref_ptr< LSWorkspacegetWorkspace () const
 Gets the workspace instance for which the event is triggered. More...
 
- Public Member Functions inherited from LSEvent
 LSEvent ()
 Constructor. More...
 
virtual ~LSEvent ()
 Destructor. More...
 
bool isConsumed () const
 Query whether this event has been consumed. More...
 
void consume ()
 Consumes this event if the event can be consumed. More...
 

Additional Inherited Members

- Protected Member Functions inherited from LSRefType
void ref () const
 Increments the internal reference counter. More...
 
void unref () const
 Decrements the internal reference counter. More...
 

Detailed Description

The LSWorkspaceEvent class represents events associated to a specific workspace.

Version
SCENE API Version 2.0.0.

Constructor & Destructor Documentation

◆ LSWorkspaceEvent()

Constructor.

Parameters
workspaceThe workspace for which the event was triggered.
Version
SCENE API Version 2.0.0.

Member Function Documentation

◆ getWorkspace()

ref_ptr<LSWorkspace> getWorkspace ( ) const

Gets the workspace instance for which the event is triggered.

Returns
The task instance.
Version
SCENE API Version 2.0.0.