NCBI C++ ToolKit
Public Member Functions | Protected Attributes | List of all members
IWMClient::CFingerprint Class Reference

Search Toolkit Book for IWMClient::CFingerprint

CFingerprint identifies an instance of IWMClient and is used for labeling layout positions. More...

#include <gui/widgets/wx/wm_client.hpp>

Public Member Functions

 CFingerprint ()
 IWMClient::CFingerprint. More...
 
 CFingerprint (const string &id, bool persistent)
 
 CFingerprint (const CFingerprint &orig)
 
bool operator== (const CFingerprint &orig) const
 
bool IsEmpty () const
 
string AsPersistentString () const
 returns a string for serialization (if persistent) or "" More...
 
void FromPersistentString (const string &s)
 
const string GetId () const
 

Protected Attributes

string m_Id
 
bool m_Persistent
 

Detailed Description

CFingerprint identifies an instance of IWMClient and is used for labeling layout positions.

If Fingerprint is persistent it will be saved with the layout and when the layout is loaded a client will be automatically instantiated based on the saved fingerprint using a client factory.

Definition at line 57 of file wm_client.hpp.

Constructor & Destructor Documentation

◆ CFingerprint() [1/3]

IWMClient::CFingerprint::CFingerprint ( )

IWMClient::CFingerprint.

Definition at line 60 of file window_manager.cpp.

◆ CFingerprint() [2/3]

IWMClient::CFingerprint::CFingerprint ( const string id,
bool  persistent 
)

Definition at line 66 of file window_manager.cpp.

◆ CFingerprint() [3/3]

IWMClient::CFingerprint::CFingerprint ( const CFingerprint orig)

Definition at line 73 of file window_manager.cpp.

Member Function Documentation

◆ AsPersistentString()

string IWMClient::CFingerprint::AsPersistentString ( ) const

returns a string for serialization (if persistent) or ""

Definition at line 92 of file window_manager.cpp.

References kEmptyStr.

Referenced by CDockLayoutTree::LogPost(), and CDockLayoutTree::CNode::ToUserObject().

◆ FromPersistentString()

void IWMClient::CFingerprint::FromPersistentString ( const string s)

Definition at line 126 of file window_manager.cpp.

Referenced by CDockLayoutTree::CNode::FromUserObject().

◆ GetId()

const string IWMClient::CFingerprint::GetId ( void  ) const

◆ IsEmpty()

bool IWMClient::CFingerprint::IsEmpty ( void  ) const

◆ operator==()

bool IWMClient::CFingerprint::operator== ( const CFingerprint orig) const

Definition at line 80 of file window_manager.cpp.

References orig.

Member Data Documentation

◆ m_Id

string IWMClient::CFingerprint::m_Id
protected

Definition at line 74 of file wm_client.hpp.

◆ m_Persistent

bool IWMClient::CFingerprint::m_Persistent
protected

Definition at line 75 of file wm_client.hpp.


The documentation for this class was generated from the following files:
Modified on Wed Jun 19 17:05:24 2024 by modify_doxy.py rev. 669887