NCBI C++ ToolKit
Public Member Functions | List of all members
ISelectionClient Class Referenceabstract

Search Toolkit Book for ISelectionClient

ISelectionClient - represents an object that support a notion of selection. More...

#include <gui/core/selection_service.hpp>

+ Inheritance diagram for ISelectionClient:

Public Member Functions

virtual ~ISelectionClient ()
 
virtual void GetSelection (TConstScopedObjects &objects) const =0
 shall return data objects representing selected things, return one data object for every selected thing. More...
 
virtual void SetSelectionService (ISelectionService *service)=0
 
virtual string GetSelClientLabel ()=0
 returns a string identifying the client in UI More...
 
virtual void GetSelection (CSelectionEvent &evt) const =0
 get selection for broadcasting More...
 
virtual void SetSelection (CSelectionEvent &evt)=0
 set broadcasted selection More...
 
virtual void GetMainObject (TConstScopedObjects &objects) const =0
 Adds the main data objects represented by the client to "objects". More...
 
virtual void GetActiveObjects (TConstScopedObjects &objects) const
 
virtual void GetActiveObjects (vector< TConstScopedObjects > &sel)
 Prioritized active objects. More...
 
virtual void BroadcastSelection ()
 

Detailed Description

ISelectionClient - represents an object that support a notion of selection.

ISelectionClient provides functions for setiing and getting selections

Definition at line 88 of file selection_service.hpp.

Constructor & Destructor Documentation

◆ ~ISelectionClient()

virtual ISelectionClient::~ISelectionClient ( )
inlinevirtual

Definition at line 91 of file selection_service.hpp.

Member Function Documentation

◆ BroadcastSelection()

virtual void ISelectionClient::BroadcastSelection ( )
inlinevirtual

Reimplemented in CSelectionClient, CProjectView, and CDataMiningView.

Definition at line 129 of file selection_service.hpp.

◆ GetActiveObjects() [1/2]

virtual void ISelectionClient::GetActiveObjects ( TConstScopedObjects objects) const
inlinevirtual

Reimplemented in CTextView, and CSimpleProjectView.

Definition at line 114 of file selection_service.hpp.

References GetMainObject(), and GetSelection().

Referenced by CSelectionService::GetActiveObjects(), and GetViewObjects().

◆ GetActiveObjects() [2/2]

virtual void ISelectionClient::GetActiveObjects ( vector< TConstScopedObjects > &  sel)
inlinevirtual

Prioritized active objects.

Reimplemented in CTextView, and CSimpleProjectView.

Definition at line 121 of file selection_service.hpp.

References GetMainObject(), and GetSelection().

◆ GetMainObject()

virtual void ISelectionClient::GetMainObject ( TConstScopedObjects objects) const
pure virtual

◆ GetSelClientLabel()

virtual string ISelectionClient::GetSelClientLabel ( )
pure virtual

returns a string identifying the client in UI

Implemented in CSelectionView, CSelectionClient, CProjectViewBase, CProjectTreeView, and CDataMiningView.

Referenced by CSelectionPanel::x_ResetTargetChoice().

◆ GetSelection() [1/2]

virtual void ISelectionClient::GetSelection ( CSelectionEvent evt) const
pure virtual

◆ GetSelection() [2/2]

virtual void ISelectionClient::GetSelection ( TConstScopedObjects objects) const
pure virtual

shall return data objects representing selected things, return one data object for every selected thing.

Implementation shall not clear the container as it can be used for accumulating objects.

Implemented in CTableViewWithTextViewNav, CVcfTableView, CTextView, CSequinDesktopView, CViewGraphic, CFeatTableView, CSeqTextView, CPhyTreeView, CMultiAlignView, CMPCrossAlignView, CDotMatrixView, CCrossAlignView, CAnnotCompareView, CAlignSpanView, CTableView, CSimpleProjectView, CSelectionView, CSelectionClient, CProjectTreeView, CDataMiningView, and CProjectView.

Referenced by GetActiveObjects(), CSelectionService::GetCurrentSelection(), and sAddScopedObjectCommands().

◆ SetSelection()

virtual void ISelectionClient::SetSelection ( CSelectionEvent evt)
pure virtual

◆ SetSelectionService()

virtual void ISelectionClient::SetSelectionService ( ISelectionService service)
pure virtual

The documentation for this class was generated from the following file:
Modified on Mon Mar 04 05:13:07 2024 by modify_doxy.py rev. 669887