NX Open C++ Reference Guide
Public Types | Public Member Functions | List of all members
NXOpen::SelectionSubscriber Class Reference

Defines a SelectionSubscriber for managing selection events
To create a new instance of this class, use NXOpen::Selection::CreateSelectionSubscriber

Created in NX11.0.0. More...

Inheritance diagram for NXOpen::SelectionSubscriber:
NXOpen::TransientObject

Public Types

typedef NXOpen::Callback3
< void, bool, std::vector
< NXOpen::TaggedObject * >
, std::vector
< NXOpen::TaggedObject * > > 
OnSelectionChangeCallback
 Prototype for a callback which is called at the end of a series of changes to the set of selected objects. More...
 

Public Member Functions

void Activate ()
 Activate the subscriber so that it will receive selection change notifications. More...
 
void Deactivate ()
 Deactivate the subscriber so that it will not receive selection change notifications. More...
 
bool IsActive ()
 Is the subscriber active? More...
 
void RegisterOnSelectionChangeCallback (const NXOpen::SelectionSubscriber::OnSelectionChangeCallback &callbackToRegister)
 Register a callback which is called at the end of a series of changes to the set of selected objects. More...
 
virtual ~SelectionSubscriber ()
 Releases resources allocated by the selection subscriber. More...
 
- Public Member Functions inherited from NXOpen::TransientObject
void * GetHandle ()
 Handle of the internal object represented by this object. More...
 

Detailed Description

Defines a SelectionSubscriber for managing selection events
To create a new instance of this class, use NXOpen::Selection::CreateSelectionSubscriber

Created in NX11.0.0.


Member Typedef Documentation

Prototype for a callback which is called at the end of a series of changes to the set of selected objects.

The series of changes are all of the changes which occur as part of the response to a single user action.
Created in NX11.0.0.

License requirements : None

Constructor & Destructor Documentation

virtual NXOpen::SelectionSubscriber::~SelectionSubscriber ( )
virtual

Releases resources allocated by the selection subscriber.

Call this method when you are done with your selection operations.
Created in NX11.0.0.

License requirements : None

Member Function Documentation

void NXOpen::SelectionSubscriber::Activate ( )

Activate the subscriber so that it will receive selection change notifications.


Created in NX11.0.0.

License requirements : None

void NXOpen::SelectionSubscriber::Deactivate ( )

Deactivate the subscriber so that it will not receive selection change notifications.


Created in NX11.0.0.

License requirements : None

bool NXOpen::SelectionSubscriber::IsActive ( )

Is the subscriber active?

Returns

Created in NX11.0.0.

License requirements : None
void NXOpen::SelectionSubscriber::RegisterOnSelectionChangeCallback ( const NXOpen::SelectionSubscriber::OnSelectionChangeCallback callbackToRegister)

Register a callback which is called at the end of a series of changes to the set of selected objects.

The series of changes are all of the changes which occur as part of the response to a single user action.
Created in NX11.0.0.

License requirements : None

Parameters
callbackToRegisterCallback

The documentation for this class was generated from the following file:
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.