NCBI C++ ToolKit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | Static Private Attributes | Friends | List of all members
ViewerBase Class Reference

Search Toolkit Book for ViewerBase

#include "viewer_base.hpp"
(Private to src/app/cn3d.)

+ Inheritance diagram for ViewerBase:
+ Collaboration diagram for ViewerBase:

Public Types

typedef std::list< BlockMultipleAlignment * > AlignmentList
 

Public Member Functions

void Refresh (void)
 
void DestroyGUI (void)
 
void GUIDestroyed (void)
 
void SetWindowTitle (void) const
 
bool EditorIsOn (void) const
 
void RemoveBlockBoundaryRows (void)
 
virtual void SaveDialog (bool prompt)
 
void NewFont (void)
 
void MakeResidueVisible (const Molecule *molecule, int seqIndex)
 
void MakeSequenceVisible (const MoleculeIdentifier *identifier)
 
void CalculateSelfHitScores (const BlockMultipleAlignment *multiple)
 
void InitData (const AlignmentList *alignments, SequenceDisplay *display)
 
void EnableStacks (void)
 
void Save (void)
 
void Undo (void)
 
void Redo (void)
 
void Revert (void)
 
void KeepCurrent (void)
 

Protected Member Functions

 ViewerBase (ViewerWindowBase **window, AlignmentManager *alnMgr)
 
virtual ~ViewerBase (void)
 
const AlignmentListGetCurrentAlignments (void) const
 
AlignmentListGetCurrentAlignments (void)
 
SequenceDisplayGetCurrentDisplay (void)
 

Protected Attributes

AlignmentManageralignmentManager
 
ViewerWindowBase **const viewerWindow
 

Private Types

typedef std::list< AlignmentListAlignmentStack
 
typedef std::list< SequenceDisplay * > DisplayStack
 

Private Member Functions

void CopyDataFromStack (void)
 
void ClearAllData (void)
 
void SetUndoRedoMenuStates (void)
 

Private Attributes

AlignmentList currentAlignments
 
AlignmentStack alignmentStack
 
SequenceDisplaycurrentDisplay
 
DisplayStack displayStack
 
int nRedosStored
 
bool stacksEnabled
 

Static Private Attributes

static const unsigned int MAX_UNDO_STACK_SIZE = 50
 

Friends

class ViewerWindowBase
 
class AlignmentManager
 
class SequenceDisplay
 

Detailed Description

Definition at line 55 of file viewer_base.hpp.

Member Typedef Documentation

◆ AlignmentList

Definition at line 89 of file viewer_base.hpp.

◆ AlignmentStack

typedef std::list< AlignmentList > ViewerBase::AlignmentStack
private

Definition at line 104 of file viewer_base.hpp.

◆ DisplayStack

typedef std::list< SequenceDisplay * > ViewerBase::DisplayStack
private

Definition at line 108 of file viewer_base.hpp.

Constructor & Destructor Documentation

◆ ViewerBase()

ViewerBase::ViewerBase ( ViewerWindowBase **  window,
AlignmentManager alnMgr 
)
protected

Definition at line 57 of file viewer_base.cpp.

References ERRORMSG.

◆ ~ViewerBase()

ViewerBase::~ViewerBase ( void  )
protectedvirtual

Definition at line 63 of file viewer_base.cpp.

References ClearAllData(), and DestroyGUI().

Member Function Documentation

◆ CalculateSelfHitScores()

void ViewerBase::CalculateSelfHitScores ( const BlockMultipleAlignment multiple)

◆ ClearAllData()

void ViewerBase::ClearAllData ( void  )
private

◆ CopyDataFromStack()

void ViewerBase::CopyDataFromStack ( void  )
private

◆ DestroyGUI()

void ViewerBase::DestroyGUI ( void  )

Definition at line 69 of file viewer_base.cpp.

References GUIDestroyed(), and viewerWindow.

Referenced by ~ViewerBase().

◆ EditorIsOn()

bool ViewerBase::EditorIsOn ( void  ) const

◆ EnableStacks()

void ViewerBase::EnableStacks ( void  )

◆ GetCurrentAlignments() [1/2]

AlignmentList& ViewerBase::GetCurrentAlignments ( void  )
inlineprotected

Definition at line 138 of file viewer_base.hpp.

References currentAlignments.

◆ GetCurrentAlignments() [2/2]

const AlignmentList& ViewerBase::GetCurrentAlignments ( void  ) const
inlineprotected

◆ GetCurrentDisplay()

SequenceDisplay* ViewerBase::GetCurrentDisplay ( void  )
inlineprotected

◆ GUIDestroyed()

void ViewerBase::GUIDestroyed ( void  )
inline

◆ InitData()

void ViewerBase::InitData ( const AlignmentList alignments,
SequenceDisplay display 
)

◆ KeepCurrent()

void ViewerBase::KeepCurrent ( void  )

◆ MakeResidueVisible()

void ViewerBase::MakeResidueVisible ( const Molecule molecule,
int  seqIndex 
)

◆ MakeSequenceVisible()

void ViewerBase::MakeSequenceVisible ( const MoleculeIdentifier identifier)

Definition at line 284 of file viewer_base.cpp.

References viewerWindow.

◆ NewFont()

void ViewerBase::NewFont ( void  )

Definition at line 269 of file viewer_base.cpp.

References viewerWindow.

◆ Redo()

void ViewerBase::Redo ( void  )

◆ Refresh()

void ViewerBase::Refresh ( void  )

Definition at line 294 of file viewer_base.cpp.

References viewerWindow.

Referenced by AlignmentManager::ShowHideCallbackFunction().

◆ RemoveBlockBoundaryRows()

void ViewerBase::RemoveBlockBoundaryRows ( void  )

◆ Revert()

void ViewerBase::Revert ( void  )

◆ Save()

void ViewerBase::Save ( void  )

◆ SaveDialog()

void ViewerBase::SaveDialog ( bool  prompt)
virtual

Reimplemented in UpdateViewer.

Definition at line 289 of file viewer_base.cpp.

References viewerWindow.

◆ SetUndoRedoMenuStates()

void ViewerBase::SetUndoRedoMenuStates ( void  )
private

◆ SetWindowTitle()

void ViewerBase::SetWindowTitle ( void  ) const

Definition at line 77 of file viewer_base.cpp.

References viewerWindow.

◆ Undo()

void ViewerBase::Undo ( void  )

Friends And Related Function Documentation

◆ AlignmentManager

friend class AlignmentManager
friend

Definition at line 58 of file viewer_base.hpp.

◆ SequenceDisplay

friend class SequenceDisplay
friend

Definition at line 59 of file viewer_base.hpp.

◆ ViewerWindowBase

friend class ViewerWindowBase
friend

Definition at line 57 of file viewer_base.hpp.

Member Data Documentation

◆ alignmentManager

AlignmentManager* ViewerBase::alignmentManager
protected

◆ alignmentStack

AlignmentStack ViewerBase::alignmentStack
private

◆ currentAlignments

AlignmentList ViewerBase::currentAlignments
private

◆ currentDisplay

SequenceDisplay* ViewerBase::currentDisplay
private

◆ displayStack

DisplayStack ViewerBase::displayStack
private

Definition at line 109 of file viewer_base.hpp.

Referenced by ClearAllData(), CopyDataFromStack(), KeepCurrent(), Revert(), and Save().

◆ MAX_UNDO_STACK_SIZE

const unsigned int ViewerBase::MAX_UNDO_STACK_SIZE = 50
staticprivate

Definition at line 112 of file viewer_base.hpp.

Referenced by Save().

◆ nRedosStored

int ViewerBase::nRedosStored
private

◆ stacksEnabled

bool ViewerBase::stacksEnabled
private

◆ viewerWindow

ViewerWindowBase* * const ViewerBase::viewerWindow
protected

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