|
BlueBerry
A modular, cross-platform, C++ application framework
|
|
BlueBerry
A modular, cross-platform, C++ application framework
|
#include <berryISelectionService.h>
Inheritance diagram for berry::ISelectionService:Classes | |
| struct | SelectionEvents |
Public Member Functions | |
| virtual | ~ISelectionService () |
| virtual void | AddSelectionListener (ISelectionListener::Pointer listener)=0 |
| virtual void | AddSelectionListener (const std::string &partId, ISelectionListener::Pointer listener)=0 |
| virtual void | AddPostSelectionListener (ISelectionListener::Pointer listener)=0 |
| virtual void | AddPostSelectionListener (const std::string &partId, ISelectionListener::Pointer listener)=0 |
| virtual ISelection::ConstPointer | GetSelection () const =0 |
| virtual ISelection::ConstPointer | GetSelection (const std::string &partId)=0 |
| virtual void | RemoveSelectionListener (ISelectionListener::Pointer listener)=0 |
| virtual void | RemoveSelectionListener (const std::string &partId, ISelectionListener::Pointer listener)=0 |
| virtual void | RemovePostSelectionListener (ISelectionListener::Pointer listener)=0 |
| virtual void | RemovePostSelectionListener (const std::string &partId, ISelectionListener::Pointer listener)=0 |
A selection service tracks the selection within an object.
A listener that wants to be notified when the selection becomes null must implement the INullSelectionListener interface.
This interface is not intended to be implemented by clients.
Definition at line 45 of file berryISelectionService.h.
| berry::ISelectionService::~ISelectionService | ( | ) | [virtual] |
Definition at line 22 of file berryISelectionService.cpp.
| virtual void berry::ISelectionService::AddPostSelectionListener | ( | ISelectionListener::Pointer | listener | ) | [pure virtual] |
Adds the given post selection listener.It is equivalent to selection changed if the selection was triggered by the mouse but it has a delay if the selection is triggered by the keyboard arrows. Has no effect if an identical listener is already registered.
Note: Works only for StructuredViewer(s).
| listener | a selection listener |
Implemented in berry::WorkbenchPage, and berry::AbstractSelectionService.
| virtual void berry::ISelectionService::AddPostSelectionListener | ( | const std::string & | partId, |
| ISelectionListener::Pointer | listener | ||
| ) | [pure virtual] |
Adds a part-specific selection listener which is notified when selection changes in the part with the given id. This is independent of part activation - the part need not be active for notification to be sent.
When the part is created, the listener is passed the part's initial selection. When the part is disposed, the listener is passed a null selection, but only if the listener implements INullSelectionListener.
Note: This will not correctly track editor parts as each editor does not have a unique partId.
| partId | the id of the part to track |
| listener | a selection listener |
Implemented in berry::WorkbenchPage, and berry::AbstractSelectionService.
| virtual void berry::ISelectionService::AddSelectionListener | ( | ISelectionListener::Pointer | listener | ) | [pure virtual] |
Adds the given selection listener. Has no effect if an identical listener is already registered.
| listener | a selection listener |
Implemented in berry::WorkbenchPage, and berry::AbstractSelectionService.
| virtual void berry::ISelectionService::AddSelectionListener | ( | const std::string & | partId, |
| ISelectionListener::Pointer | listener | ||
| ) | [pure virtual] |
Adds a part-specific selection listener which is notified when selection changes in the part with the given id. This is independent of part activation - the part need not be active for notification to be sent.
When the part is created, the listener is passed the part's initial selection. When the part is disposed, the listener is passed a null selection, but only if the listener implements INullSelectionListener.
Note: This will not correctly track editor parts as each editor does not have a unique partId.
| partId | the id of the part to track |
| listener | a selection listener |
Implemented in berry::WorkbenchPage, and berry::AbstractSelectionService.
| virtual ISelection::ConstPointer berry::ISelectionService::GetSelection | ( | ) | const [pure virtual] |
Returns the current selection in the active part. If the selection in the active part is undefined (the active part has no selection provider) the result will be null.
null if undefined Implemented in berry::WorkbenchPage, and berry::AbstractSelectionService.
| virtual ISelection::ConstPointer berry::ISelectionService::GetSelection | ( | const std::string & | partId | ) | [pure virtual] |
Returns the current selection in the part with the given id. If the part is not open, or if the selection in the active part is undefined (the active part has no selection provider) the result will be null.
| partId | the id of the part |
null if undefined Implemented in berry::WorkbenchPage, and berry::AbstractSelectionService.
| virtual void berry::ISelectionService::RemovePostSelectionListener | ( | ISelectionListener::Pointer | listener | ) | [pure virtual] |
Removes the given post selection listener. Has no effect if an identical listener is not registered.
| listener | a selection listener |
Implemented in berry::WorkbenchPage, and berry::AbstractSelectionService.
| virtual void berry::ISelectionService::RemovePostSelectionListener | ( | const std::string & | partId, |
| ISelectionListener::Pointer | listener | ||
| ) | [pure virtual] |
Removes the given part-specific post selection listener. Has no effect if an identical listener is not registered for the given part id.
| partId | the id of the part to track |
| listener | a selection listener |
Implemented in berry::WorkbenchPage, and berry::AbstractSelectionService.
| virtual void berry::ISelectionService::RemoveSelectionListener | ( | ISelectionListener::Pointer | listener | ) | [pure virtual] |
Removes the given selection listener. Has no effect if an identical listener is not registered.
| listener | a selection listener |
Implemented in berry::WorkbenchPage, and berry::AbstractSelectionService.
| virtual void berry::ISelectionService::RemoveSelectionListener | ( | const std::string & | partId, |
| ISelectionListener::Pointer | listener | ||
| ) | [pure virtual] |
Removes the given part-specific selection listener. Has no effect if an identical listener is not registered for the given part id.
| partId | the id of the part to track |
| listener | a selection listener |
Implemented in berry::WorkbenchPage, and berry::AbstractSelectionService.
1.8.0