GUI Utility Classes and Modules
[GUI Framework]

Collaboration diagram for GUI Utility Classes and Modules:

Detailed Description

Utility and support routines for the GUI framework.

Files

file command.hpp

GUI command routing and handling framework.

file menu_item.hpp

Classes

struct binary_functor< Type >

TEMPLATE binary functor base struct. More...

struct plus_func< Type >

TEMPLATE STRUCT max. More...

struct max_func< Type >

TEMPLATE STRUCT max. More...

struct min_func< Type >

TEMPLATE STRUCT min. More...

class CDenMapRunIterator< CntType >

Run iterator. iterate through runs of equal values in the bins. More...

class CDensityMap< CntType >

class CDensityMap generates a low-resolution view of a set of features. More...

class CFilter

CFilter --. More...

class CFilterSet

class CGBUserType

CGBUserType. More...

class CGBUserTypeParent_CI

class IUserTypeExtension

class CGBUserTypeReg

CGBUserTypeReg - container of registered user types. More...

class CUserTypeExtensionPoint

class CLabel

class ILabelHandler

ILabelHandler interface. More...

class CLayoutObject

class CLayoutObject defines an interface that wraps a rectilinear abstract object. More...

struct SLayoutByPos

basic sort by position function More...

struct SLayoutBySize

basic sort by size function More...

class CLayout

class CLayout is a container of objects laid out in a series of rows or tracks. More...

class CLayoutEngine

class CLayoutEngine defines the abstract interface for a given alyout algorithm. More...

class C2DLayoutEngine

class C2DLayoutEngine defines the interface for a standard 2D layout engine. More...

struct SScopedObject

struct SScopedObjectLess

struct SConstScopedObject

struct SConstScopedObjectLess

class CGUIUserType

CGUIUserType. More...

class CAccelTable

CAccelTable - Accelerator Table. More...

class IAppJobProgress

IAppJobProgress. More...

class IAppJobError

IAppJobError. More...

class IAppJob

IAppJob. More...

class IAppJobEngineListener

IAppJobEngineListener - receives notifications about changes in job state. More...

class CAppJobException

CAppJobException - Exception thrown by Job Dispatcher and Job Engines. More...

class CAppJobDispatcher

CAppJobDispatcher. More...

class IAppJobListener

IAppJobListener Interface for components that need to be notified about changes in Jobs. More...

class IAppJobEngine

IAppJobEngine. More...

class IAppJobEngineParams

IAppJobEngineParams A base class for Engine Parmeters classes. More...

class CAppJobProgress

CAppJobProgress Default implementation for IAppJobProgress - the class encapsulates a text message and a numeric value indicating the progress of the task normalized in [0.0, 1.0] range (0.0 - just started, 1.0 - 100% done). More...

class CAppJobError

CAppJobError Default implementation for IAppJobError - encapsulates a text error message. More...

class CAppJobTextResult

CAppJobTextResult Default implementation for result object - encapsulates a text error message. More...

class CAppJob

CAppJob - default implementation of IAppJob that could be used as a base class. More...

class CAppInfo

class CAppInfo defines an interface for application registration information More...

class CAppRegistry

class CAppRegistry defines the registry of application information for automated application link-outs More...

class CAppPopup

class CAppPopup allows applications to be launched based on standard registered types More...

struct SAttrRangeCollectionElement< Attr, Position >

TAttrRangeCollection represents a sequence of continious attributed intervals. More...

class CAttrRangeCollection< Attr, Position >

class CBBox< N >

class CBrowserUtils

class ITransferable

class CTransferable< T >

class CClipboard

class ICmdUI

ICmdUI - interface for updating command GUI elements such as menu itms and tool bar buttons. More...

class ICurve

class ICurve defines a basic interface for all curves. More...

class IEventAttachment

object, that will be attached to event More...

class CEventAttachmentFor< T >

templatized IEventAttachment wrapper More...

class CEvent

CEvent - generic event implementation TODO TODO - Attachments. More...

struct SEvtMapEntry

Command map entry. More...

struct SEvtMap

Command Map. More...

struct hash< CEventHandler * >

class CEventHandler

CEventHandler. More...

class CAppJobNotification

CAppJobNotification Notification send by CAppJobEventTranslator. More...

class CAppJobEventTranslator

CAppJobEventTranslator Standard Listener that generates notification events. More...

class CExecute

class IExtension

IExtension IExtension interface represents an abstract pluggable component. More...

class IExtensionPoint

IExtensionPoint. More...

class IExtensionRegistry

IExtensionRegistry IExtensionRegistry is an interface representing a Registry where Extension Points and Extensions are registered. More...

class CExtensionPoint

CExtensionPoint - standard implementation of IExtensionPoint. More...

class CExtensionRegistry

CExtensionRegistry - standard implementation of IExtensionRegistry. More...

class CExtensionPointDeclaration

CExtensionPointDeclaration - static declaration helper. More...

class CExtensionDeclaration

CExtensionDeclaration - static declaration helper. More...

class CFetchURL

class CFltkUtils

class CFltkGuard

class CFltkGuard is a simple exception-safe guard wrapper for FLTK's GUI locking mechanism More...

class CFltkCursorGuard

class CFltkCursorGuard implements a guard paradigm for changing and restoring the current cursor. More...

class CFlCurrentGuard

CFlCurrentGuard locks and restores Fl_Group::current(). More...

class CFuncPtr

class CFuncPtrTmpl< T >

class CFuncPtr1< RetType, Arg1 >

class CFuncPtrTmpl1< T, RetType, Arg1 >

class CVoidFuncPtr1< Arg1 >

class CVoidFuncPtrTmpl1< T, Arg1 >

class CIdGenerator

CIdGenerator - generates consecutive integer identifiers. More...

class CUniqueLabelGenerator

CUniqueLabelGenerator Modifies the given label so that it becomes unique in the given set of labels by appending a numeric postfix ( "name" -> "name (1)" ). More...

class CMenuItem

CMenuItem - represents a menu items in IMenu-style menus. More...

struct SwxMenuItemRec

New macros for defining menus for use with CUICommandRegistry. More...

struct SMenuItemRec

SMenuItemRec. More...

class IReporter

class CRgbaColor

class CRgbaColor provides a simple abstraction for managing colors. More...

class CStringUtil

class CSystemPath

class CTableNames

class CThreadPoolEngine

CThreadPoolEngine. More...

class CAppJobRequest

CAppJobRequest CAppJobRequest serves as an adapter between IAppJob, CStdPoolOfThreads and CThreadPoolEngine. More...

class IUIObject

IUIObject - object that provides basic properties often required in a UI object. More...

class CUIObject

CUIObject - default mix-in implementation of IUIObject. More...

class CMacOSX

struct SFileDlgData

File dialog utilities. More...

Defines

#define EXT_POINT__USER_TYPE   "user_types::user_type_extension"

#define EVENT_MAP_TX_BEGIN

Event Dispatcher macros.

#define EVENT_FIRE_ALL()   Dispatch(evt, disp_how, pool_name);

#define EVENT_MAP_TX_END   }

#define DECLARE_EVENT_MAP()

#define BEGIN_EVENT_MAP(thisClass, baseClass)

Begins definition of Command Map for CEventHandler-derived class.

#define END_EVENT_MAP()

Ends definition of Command Map.

#define ON_EVENT(type, id, handler)   ON_MESSAGE(type, id, handler)

Adds a Message as Command Map entry.

#define ON_MESSAGE(type, id, handler)   { ncbi::CEvent::eEvent_Message, typeid(type).name(), id, id, (FEventHandler) handler },

#define ON_EVENT_EX(cls, type, id, handler)   { cls, typeid(type).name(), id, id, (FEventHandler) handler },

Adds a Command Map entry mapping given command id to given command handler.

#define ON_CMD(type, id, handler)   { ncbi::CEvent::eEvent_Command, typeid(type).name(), id, id, (FEventHandler) ((FCommandHandler) handler) },

Adds a Command as Command Map entry.

#define ON_CMD_RANGE(type, id, id_last, handler)   { ncbi::CEvent::eEvent_Command, typeid(type).name(), id, id_last, (FEventHandler) ((FCommandRangeHandler) handler) },

Adds a Command Range as Command Map entry.

#define ON_CMD_UPDATE(type, id, handler)   { CEvent::eEvent_CommandUpdate, typeid(type).name(), id, id, (FEventHandler) ((FCommandUpdateHandler)handler) },

Adds a Update Command as Command Map entry.

#define ON_CMD_UPDATE_RANGE(type, id, id_last, handler)   { CEvent::eEvent_CommandUpdate, typeid(type).name(), id, id_last, (FEventHandler) ((FCommandUpdateHandler)handler) },

Adds a Update Command Range as Command Map entry.

#define ON_EVENT_RANGE(type, id, id_last, handler)   ON_MESSAGE_RANGE(type, id, id_last, handler)

Adds a Command Map entry mapping given command range to given command handler.

#define ON_MESSAGE_RANGE(type, id, id_last, handler)   { CEvent::eEvent_Message, typeid(type).name(), id, id_last, (FEventHandler) handler },

Adds a Command Map entry mapping given message range to given command handler.

#define WX_DEFINE_MENU(name)

#define WX_MENU_ITEM(cmd)   { CMenuItem::eItem, "", cmd, CMenuItem::eDefault },

#define WX_MENU_CHECK_ITEM(cmd)   { CMenuItem::eItem, "", cmd, CMenuItem::eCheckItem },

#define WX_MENU_SEPARATOR()   { CMenuItem::eSeparator, "", eCmdNone, CMenuItem::eDefault },

#define WX_MENU_SEPARATOR_L(label)   { CMenuItem::eSeparator, label, eCmdNone, CMenuItem::eDefault },

#define WX_SUBMENU(label)   { CMenuItem::eSubmenu, label, eCmdNone, CMenuItem::eDefault },

#define WX_END_SUBMENU()   { CMenuItem::eSubmenu, "", eCmdInvalid, CMenuItem::eDefault },

#define WX_END_MENU()

#define DEFINE_MENU(name)

#define MENU_ITEM(cmd, label)   { CMenuItem::eItem, label, cmd, "", "", CMenuItem::eDefault},

#define MENU_ITEM_T(cmd, label, tooltip)   { CMenuItem::eItem, label, cmd, "", tooltip, CMenuItem::eDefault},

#define MENU_ITEM_IM(cmd, label, image)   { CMenuItem::eItem, label, cmd, image, "", CMenuItem::eDefault},

#define MENU_ITEM_IM_T(cmd, label, image, tooltip)   { CMenuItem::eItem, label, cmd, image, tooltip, CMenuItem::eDefault},

#define MENU_ITEM_RADIO(cmd, label)   { CMenuItem::eItem, label, cmd, "", "", CMenuItem::eRadioItem},

#define MENU_ITEM_CHECK(cmd, label)   { CMenuItem::eItem, label, cmd, "", "", CMenuItem::eCheckItem},

#define MENU_SEPARATOR()   { CMenuItem::eSeparator, "", eCmdNone, "", "", CMenuItem::eDefault},

#define MENU_SEPARATOR_L(label)   { CMenuItem::eSeparator, label, eCmdNone, "", "", CMenuItem::eDefault},

#define SUBMENU(label)   { CMenuItem::eSubmenu, label, eCmdNone, "", "", CMenuItem::eDefault},

#define SUBMENU_IM(label, image)   { CMenuItem::eSubmenu, label, eCmdNone, image, "", CMenuItem::eDefault},

#define END_SUBMENU()   { CMenuItem::eSubmenu, "", eCmdInvalid, "", "", CMenuItem::eDefault},

#define END_MENU()

Typedefs

typedef vector< CRef< CObject > > TObjects

typedef vector< CConstRef<
CObject > > TConstObjects

typedef vector< SScopedObject > TScopedObjects

typedef vector< SConstScopedObject > TConstScopedObjects

typedef enum EFileType TFileType

typedef void(CEventHandler::* FCMDUpdateHandler )(ICmdUI *)

callback for updating command UI elements

typedef int TCmdID

typedef void(CEventHandler::* FEventHandler )(CEvent *)

event handler

typedef void(CEventHandler::* FCommandHandler )(void)

command handler

typedef void(CEventHandler::* FCommandRangeHandler )(CEvent::TEventID)

command range handler

typedef void(CEventHandler::* FCommandUpdateHandler )(IEventAttachment *)

update command handler

Enumerations

enum EFileType { eUnknown = 0, ePdf }

enumerated file type information More...

enum EBaseCommands {
  eCmdMenuEnd = -2, eCmdInvalid = -1, eCmdNone = 0, eCmdZoomIn,
  eCmdZoomOut, eCmdZoomAll, eCmdZoomInMouse, eCmdZoomOutMouse,
  eCmdZoomSel, eCmdZoomSeq, eCmdZoomObjects, eCmdZoomSelObjects,
  eCmdZoomInX, eCmdZoomOutX, eCmdZoomAllX, eCmdZoomInY,
  eCmdZoomOutY, eCmdZoomAllY, eCmdSetEqualScale, eCmdSettings,
  eCmdResetSelection, eCmdEditSelection, eCmdDeleteSelection, eCmdDeleteSelectionAndOrphaned,
  eCmdBack, eCmdForward, eCmdSeqGoto, eBaseCmdLast
}

Definitions for generic commands. More...

Functions

bool operator< (const CLayoutObject &o1, const CLayoutObject &o2)

bool operator== (const SScopedObject &s1, const SScopedObject &s2)

bool operator== (const SConstScopedObject &s1, const SConstScopedObject &s2)

CNcbiOstream & operator<< (CNcbiOstream &strm, TFileType &ftype)

CNcbiOstream & operator<< (CNcbiOstream &strm, const CBBox< 3 > &bb)

template<class I>

void GetExtensionAsInterface (const string &ext_point_id, vector< CIRef< I > > &interfaces)

GetExtensionAsInterface() is a helper function that extracts all extensions implementing the specified interface from the given extension point.

template<class I>

void GetExtensionAsInterface (const string &ext_point_id, vector< I * > &interfaces)

GetExtensionAsInterface() is a helper function that extracts all extensions implementing the specified interface from the given extension point.

CMenuItem * CreateMenuItems (const SMenuItemRec *items)

creates CMenuItem hierarchy from an array of SMenuItemRecRec

bool operator== (const CRgbaColor &c1, const CRgbaColor &c2)

global comparison operator

bool operator< (const CRgbaColor &c1, const CRgbaColor &c2)

define a some-what arbitrary sort order based on brightness It does have the property of being equivalent to operator==, that is: ( ! a<b && ! b<a ) iff a == b

CRgbaColor operator+ (const CRgbaColor &c1, const CRgbaColor &c2)

add two colors

CRgbaColor operator * (const CRgbaColor &c1, float f)

multiply a color by a scalar

EDialogReturnValue NcbiMessageBox (const string &message, TDialogType type=eDialog_Ok, EDialogIcon icon=eIcon_Exclamation, const string &title="Error", EDialogTextMode text_mode=eRaw)

EDialogReturnValue NcbiInfoBox (const string &message, const string &title="Info")

specialized Message Box function for reporting general information messages

void NcbiWarningBox (const string &message, const string &title="Warning")

specialized Message Box function for reporting non-critical errors

void NcbiErrorBox (const string &message, const string &title="Error")

specialized Message Box function for reporting critical errors

int NcbiFileBrowser (SFileDlgData &data, wxWindow *parent=NULL)

show wxFileDialog and returns

TSeqPos CDenMapRunIterator::GetSeqPosition () const

TSeqPos CDenMapRunIterator::GetSeqRunEndPosition () const

TSeqPos CDenMapRunIterator::GetSeqRunLength () const

position_type CDenMapRunIterator::x_CalcRunLength () const

CntType CDenMapRunIterator::Advance ()

CDensityMap::CDensityMap (TSeqPos start, TSeqPos stop, float window=1, accum_functor *func=NULL, CntType def=(CntType) 0)

CDensityMap::CDensityMap (const objects::CBioseq_Handle &handle, float window=1, accum_functor *func=NULL, CntType def=(CntType) 0)

CDensityMap::CDensityMap (const CDensityMap< CntType > &map)

CDensityMap< CntType > & CDensityMap::operator= (const CDensityMap< CntType > &map)

void CDensityMap::ExtendTo (TSeqPos stop)

extend our density map to cover the sequence position stop.

void CDensityMap::AddRange (TSeqRange range, CntType score=1, bool expand=false)

CntType CDensityMap::AddLocation (const objects::CSeq_loc &loc)

CntType CDensityMap::AddFeature (const objects::CSeq_feat &feature)

CntType CDensityMap::AddFeatures (const objects::CBioseq_Handle &handle, objects::SAnnotSelector sel)

All features on this bioseq selected by sel in the range of this.

CntType CDensityMap::AddAlignments (const objects::CBioseq_Handle &handle, objects::SAnnotSelector sel)

All alignments on this bioseq selected by sel in the range of this.

CntType CDensityMap::AddAlignments (const objects::CBioseq_Handle &handle, const objects::CSeq_annot &seq_annot)

All alignments in a given annotation on this bioseq within the range of this.

static TSeqPos CDensityMap::GetDensityMap (const objects::CBioseq_Handle &handle, TSeqPos start, TSeqPos stop, TSeqPos window, objects::SAnnotSelector sel, vector< TSeqPos > &density)

OLD static method.

TSeqPos C2DLayoutEngine::GetMinDist (void) const

access the minimum distance, in bases, that we permit between objects on a given row

void C2DLayoutEngine::SetMinDist (TSeqPos dist)

void C2DLayoutEngine::SetSideSpace (TSeqPos space)

template<typename T>

bool CClipboard::Contains (const T &val)

template<typename T>

int CClipboard::Add (const T &val)

template<typename InIt>

void CClipboard::Add (InIt first, InIt last)

template<typename T>

void CClipboard::Set (const T &val)

template<typename InIt>

void CClipboard::Set (InIt first, InIt last)

template<typename T>

int CClipboard::x_AddValueEx (const T &val)

template<typename T>

int CClipboard::x_AddValue (const T &val)

template<>

int CClipboard::x_AddValue (const string &val)

template<typename T>

const T & CClipboard::GetAt (int idx) const

template<typename T>

const T * CClipboard::GetPtrAt (int idx) const

template<typename T>

const T & CClipboard::Get () const

template<typename T>

const T * CClipboard::GetPtr () const

template<typename T>

const T * CClipboard::x_GetValueAt (int idx) const

template<typename T>

void CClipboard::x_AddFlavor (int idx, const T &val)

template<typename T>

void CClipboard::AddFlavor (const T &val)

template<typename T>

void CClipboard::AddFlavorAt (int idx, const T &val)

const TEventID CEvent::GetID (void) const

Inline Implementation.

const TEventClass CEvent::GetEventClass (void) const

const TEventSender * CEvent::GetSender (void) const

TEventTypeInfo CEvent::GetTypeInfo (void)

Define Documentation

#define BEGIN_EVENT_MAP ( thisClass,
baseClass )

Value:
const SEvtMap* thisClass::GetEventMap() const \ { return &thisClass::sm_EvtMap; } \ const SEvtMap thisClass::sm_EvtMap = \ { &baseClass::sm_EvtMap, &thisClass::sm_EvtMapEntries[0] }; \ const SEvtMapEntry thisClass::sm_EvtMapEntries[] = \ { \
Begins definition of Command Map for CEventHandler-derived class.

Definition at line 112 of file event_handler.hpp.

#define DECLARE_EVENT_MAP ( )

Value:
private: \ static const SEvtMapEntry sm_EvtMapEntries[]; \ protected: \ static const SEvtMap sm_EvtMap; \ virtual const SEvtMap* GetEventMap() const

Definition at line 104 of file event_handler.hpp.

#define DEFINE_MENU ( name )

Value:
const SMenuItemRec name[] = \ { SUBMENU("Root")

Definition at line 309 of file menu_item.hpp.

#define END_EVENT_MAP ( )

Value:
{ CEvent::eEvent_Message, typeid(void).name(), \ CEvent::eEvent_InvalidID, CEvent::eEvent_InvalidID, 0} \ };
Ends definition of Command Map.

Definition at line 121 of file event_handler.hpp.

#define END_MENU ( )

Value:
{ CMenuItem::eSubmenu, "", eCmdMenuEnd, "", "", CMenuItem::eDefault}, \ };

Definition at line 346 of file menu_item.hpp.

#define END_SUBMENU ( ) { CMenuItem::eSubmenu, "", eCmdInvalid, "", "", CMenuItem::eDefault},

Definition at line 343 of file menu_item.hpp.

#define EVENT_FIRE_ALL ( ) Dispatch(evt, disp_how, pool_name);

Definition at line 76 of file event_handler.hpp.

#define EVENT_MAP_TX_BEGIN

Value:
virtual void FireEvent(CEvent* evt, \ EDispatch disp_how = eDispatch_Default, \ int pool_name = ePool_Default) \ {
Event Dispatcher macros.

Definition at line 70 of file event_handler.hpp.

#define EVENT_MAP_TX_END }

Definition at line 79 of file event_handler.hpp.

#define EXT_POINT__USER_TYPE "user_types::user_type_extension"

Definition at line 179 of file gb_user_type.hpp.
Referenced by init_gui_objutils().

#define MENU_ITEM ( cmd,
label ) { CMenuItem::eItem, label, cmd, "", "", CMenuItem::eDefault},

Definition at line 313 of file menu_item.hpp.

#define MENU_ITEM_CHECK ( cmd,
label ) { CMenuItem::eItem, label, cmd, "", "", CMenuItem::eCheckItem},

Definition at line 328 of file menu_item.hpp.

#define MENU_ITEM_IM ( cmd,
label,
image ) { CMenuItem::eItem, label, cmd, image, "", CMenuItem::eDefault},

Definition at line 319 of file menu_item.hpp.

#define MENU_ITEM_IM_T ( cmd,
label,
image,
tooltip ) { CMenuItem::eItem, label, cmd, image, tooltip, CMenuItem::eDefault},

Definition at line 322 of file menu_item.hpp.

#define MENU_ITEM_RADIO ( cmd,
label ) { CMenuItem::eItem, label, cmd, "", "", CMenuItem::eRadioItem},

Definition at line 325 of file menu_item.hpp.

#define MENU_ITEM_T ( cmd,
label,
tooltip ) { CMenuItem::eItem, label, cmd, "", tooltip, CMenuItem::eDefault},

Definition at line 316 of file menu_item.hpp.

#define MENU_SEPARATOR ( ) { CMenuItem::eSeparator, "", eCmdNone, "", "", CMenuItem::eDefault},

Definition at line 331 of file menu_item.hpp.

#define MENU_SEPARATOR_L ( label ) { CMenuItem::eSeparator, label, eCmdNone, "", "", CMenuItem::eDefault},

Definition at line 334 of file menu_item.hpp.

#define ON_CMD ( type,
id,
handler ) { ncbi::CEvent::eEvent_Command, typeid(type).name(), id, id, (FEventHandler) ((FCommandHandler) handler) },

Adds a Command as Command Map entry.

Definition at line 138 of file event_handler.hpp.

#define ON_CMD_RANGE ( type,
id,
id_last,
handler ) { ncbi::CEvent::eEvent_Command, typeid(type).name(), id, id_last, (FEventHandler) ((FCommandRangeHandler) handler) },

Adds a Command Range as Command Map entry.

Definition at line 142 of file event_handler.hpp.

#define ON_CMD_UPDATE ( type,
id,
handler ) { CEvent::eEvent_CommandUpdate, typeid(type).name(), id, id, (FEventHandler) ((FCommandUpdateHandler)handler) },

Adds a Update Command as Command Map entry.

Definition at line 146 of file event_handler.hpp.

#define ON_CMD_UPDATE_RANGE ( type,
id,
id_last,
handler ) { CEvent::eEvent_CommandUpdate, typeid(type).name(), id, id_last, (FEventHandler) ((FCommandUpdateHandler)handler) },

Adds a Update Command Range as Command Map entry.

Definition at line 150 of file event_handler.hpp.

#define ON_EVENT ( type,
id,
handler ) ON_MESSAGE(type, id, handler)

Adds a Message as Command Map entry.

Definition at line 127 of file event_handler.hpp.

#define ON_EVENT_EX ( cls,
type,
id,
handler ) { cls, typeid(type).name(), id, id, (FEventHandler) handler },

Adds a Command Map entry mapping given command id to given command handler.

Definition at line 134 of file event_handler.hpp.

#define ON_EVENT_RANGE ( type,
id,
id_last,
handler ) ON_MESSAGE_RANGE(type, id, id_last, handler)

Adds a Command Map entry mapping given command range to given command handler.

Definition at line 154 of file event_handler.hpp.

#define ON_MESSAGE ( type,
id,
handler ) { ncbi::CEvent::eEvent_Message, typeid(type).name(), id, id, (FEventHandler) handler },

Definition at line 130 of file event_handler.hpp.

#define ON_MESSAGE_RANGE ( type,
id,
id_last,
handler ) { CEvent::eEvent_Message, typeid(type).name(), id, id_last, (FEventHandler) handler },

Adds a Command Map entry mapping given message range to given command handler.

Definition at line 158 of file event_handler.hpp.

#define SUBMENU ( label ) { CMenuItem::eSubmenu, label, eCmdNone, "", "", CMenuItem::eDefault},

Definition at line 337 of file menu_item.hpp.

#define SUBMENU_IM ( label,
image ) { CMenuItem::eSubmenu, label, eCmdNone, image, "", CMenuItem::eDefault},

Definition at line 340 of file menu_item.hpp.

#define WX_DEFINE_MENU ( name )

Value:
const SwxMenuItemRec name[] = \ { WX_SUBMENU("Root")

Definition at line 250 of file menu_item.hpp.

#define WX_END_MENU ( )

Value:
{ CMenuItem::eSubmenu, "", eCmdMenuEnd, CMenuItem::eDefault }, \ };

Definition at line 276 of file menu_item.hpp.

#define WX_END_SUBMENU ( ) { CMenuItem::eSubmenu, "", eCmdInvalid, CMenuItem::eDefault },

Definition at line 273 of file menu_item.hpp.

#define WX_MENU_CHECK_ITEM ( cmd ) { CMenuItem::eItem, "", cmd, CMenuItem::eCheckItem },

Definition at line 258 of file menu_item.hpp.

#define WX_MENU_ITEM ( cmd ) { CMenuItem::eItem, "", cmd, CMenuItem::eDefault },

Definition at line 254 of file menu_item.hpp.

#define WX_MENU_SEPARATOR ( ) { CMenuItem::eSeparator, "", eCmdNone, CMenuItem::eDefault },

Definition at line 264 of file menu_item.hpp.

#define WX_MENU_SEPARATOR_L ( label ) { CMenuItem::eSeparator, label, eCmdNone, CMenuItem::eDefault },

Definition at line 267 of file menu_item.hpp.

#define WX_SUBMENU ( label ) { CMenuItem::eSubmenu, label, eCmdNone, CMenuItem::eDefault },

Definition at line 270 of file menu_item.hpp.

Typedef Documentation

typedef void(CEventHandler::* FCMDUpdateHandler)(ICmdUI *)

callback for updating command UI elements

Definition at line 74 of file command.hpp.

typedef void(CEventHandler::* FCommandHandler)(void)

command handler

Definition at line 57 of file event_handler.hpp.

typedef void(CEventHandler::* FCommandRangeHandler)(CEvent::TEventID)

command range handler

Definition at line 60 of file event_handler.hpp.

typedef void(CEventHandler::* FCommandUpdateHandler)(IEventAttachment *)

update command handler

Definition at line 63 of file event_handler.hpp.

typedef void(CEventHandler::* FEventHandler)(CEvent *)

event handler

Definition at line 54 of file event_handler.hpp.

typedef int TCmdID

Definition at line 49 of file event_handler.hpp.

typedef vector< CConstRef<CObject> > TConstObjects

Definition at line 101 of file objects.hpp.

typedef vector<SConstScopedObject> TConstScopedObjects

Definition at line 103 of file objects.hpp.

typedef enum EFileType TFileType

Definition at line 75 of file app_popup.hpp.

typedef vector< CRef<CObject> > TObjects

Definition at line 100 of file objects.hpp.

typedef vector<SScopedObject> TScopedObjects

Definition at line 102 of file objects.hpp.

Enumeration Type Documentation

enum EBaseCommands

Definitions for generic commands.
Subsytems of GUI should define they own command enumerations, preferable with non-overlapping ranges.
Enumerator:

eCmdMenuEnd

eCmdInvalid marks menu end in array initializers

eCmdNone not a valid command

eCmdZoomIn zoom events

eCmdZoomOut

eCmdZoomAll

eCmdZoomInMouse

eCmdZoomOutMouse

eCmdZoomSel

eCmdZoomSeq Zoom to Selection.

eCmdZoomObjects Zoom to Sequence.

eCmdZoomSelObjects

eCmdZoomInX

eCmdZoomOutX

eCmdZoomAllX

eCmdZoomInY

eCmdZoomOutY

eCmdZoomAllY

eCmdSetEqualScale

eCmdSettings

eCmdResetSelection

eCmdEditSelection

eCmdDeleteSelection

eCmdDeleteSelectionAndOrphaned

eCmdBack Navigation commands.

eCmdForward

eCmdSeqGoto goto sequence position

eBaseCmdLast

Definition at line 82 of file command.hpp.

enum EFileType

enumerated file type information

Enumerator:

eUnknown

ePdf

Definition at line 70 of file app_popup.hpp.

Function Documentation

template<typename InIt>

void CClipboard::Add ( InIt first,

InIt last

) [inline, inherited]

Definition at line 175 of file clipboard.hpp.
References CClipboard::x_AddValue().

template<typename T>

int CClipboard::Add ( const T & val ) [inline, inherited]

Definition at line 167 of file clipboard.hpp.
References CClipboard::x_AddValue().
Referenced by CSeqTextPane::x_OnCopy(), and IClipboardHandler::x_OnPaste().

template<typename CntType>

CntType CDensityMap< CntType >::AddAlignments ( const objects::CBioseq_Handle & handle,

const objects::CSeq_annot & seq_annot

) [inherited]

All alignments in a given annotation on this bioseq within the range of this.
total range _TRACE(" (" << aln_map->GetSeqStart(row) << "," << aln_map->GetSeqStop(row) << ")"); IDs {{ _TRACE(" Segs: " << aln_map->GetNumSegs()); string all_ids = ": "; for (CAlnMap::TDim di = 0; di < aln_map->GetNumRows(); ++di) { all_ids += aln_map->GetSeqId(di).AsFastaString() + ", "; } _TRACE(all_ids); }} Segments. _TRACE(" "); for (CAlnMap::TNumseg s = 0; s < aln_map->GetNumSegs(); ++s) { if (aln_map->GetSegType(row, s) && CAlnMap:: ) _TRACE(" (" << aln_map->GetStart(row, s) << "," << aln_map->GetStop(row, s) << ")"); } Chunks _TRACE(" Chunks: " ); CRef<CAlnMap::CAlnChunkVec> chunks = aln_map->GetSeqChunks(row, CAlnMap::TSignedRange(start, stop), CAlnMap::fAlnSegsOnly); for (CAlnMap::TNumchunk c = 0; c < chunks->size(); ++c) { CConstRef<CAlnMap::CAlnChunk> chunk = (*chunks)[c]; _TRACE("(" << chunk->GetRange().GetFrom() << "," << chunk->GetRange().GetTo() << ") "); }
Definition at line 558 of file density_map.hpp.
References align, CDensityMap< CntType >::GetStart(), and CDensityMap< CntType >::GetStop().

template<typename CntType>

CntType CDensityMap< CntType >::AddAlignments ( const objects::CBioseq_Handle & handle,

objects::SAnnotSelector sel

) [inherited]

All alignments on this bioseq selected by sel in the range of this.

Definition at line 493 of file density_map.hpp.
References _TRACE, align, CDensityMap< CntType >::GetStart(), and CDensityMap< CntType >::GetStop().

template<typename CntType>

CntType CDensityMap< CntType >::AddFeature ( const objects::CSeq_feat & feature ) [inherited]

Definition at line 456 of file density_map.hpp.
References CDensityMap< CntType >::AddLocation().

template<typename CntType>

CntType CDensityMap< CntType >::AddFeatures ( const objects::CBioseq_Handle & handle,

objects::SAnnotSelector sel

) [inherited]

All features on this bioseq selected by sel in the range of this.
eliminate some expensive functions
Definition at line 463 of file density_map.hpp.
References CDensityMap< CntType >::GetMax(), CDensityMap< CntType >::GetStart(), and CDensityMap< CntType >::GetStop().
Referenced by CDensityMapDS::Update().

template<typename T>

void CClipboard::AddFlavor ( const T & val ) [inline, inherited]

Definition at line 323 of file clipboard.hpp.
References CClipboard::x_AddFlavor().

template<typename T>

void CClipboard::AddFlavorAt ( int idx,

const T & val

) [inline, inherited]

Definition at line 330 of file clipboard.hpp.
References CClipboard::x_AddFlavor().

template<typename CntType>

CntType CDensityMap< CntType >::AddLocation ( const objects::CSeq_loc & loc ) [inherited]

Definition at line 446 of file density_map.hpp.
References CDensityMap< CntType >::AddRange().
Referenced by CDensityMap< CntType >::AddFeature().

template<typename CntType>

void CDensityMap< CntType >::AddRange ( TSeqRange range,

CntType score = 1,

bool expand = false

) [inherited]

Definition at line 416 of file density_map.hpp.
References COpenRange< Position >::GetFrom(), and COpenRange< Position >::GetTo().
Referenced by CDensityMap< CntType >::AddLocation(), and CSGSeqGraphJob::x_AddGraphToMap().

template<typename CntType>

CntType CDenMapRunIterator< CntType >::Advance ( ) [inherited]

Definition at line 204 of file density_map.hpp.
References CDenMapRunIterator< CntType >::GetValue(), CDenMapRunIterator< CntType >::m_Pos, CDenMapRunIterator< CntType >::m_RunLength, and CDenMapRunIterator< CntType >::x_CalcRunLength().
Referenced by CAlignSmearGlyph::x_Draw().

template<typename CntType>

CDensityMap< CntType >::CDensityMap ( const CDensityMap< CntType > & map ) [inherited]

Definition at line 375 of file density_map.hpp.

template<typename CntType>

CDensityMap< CntType >::CDensityMap ( const objects::CBioseq_Handle & handle,

float window = 1,

accum_functor * func = NULL,

CntType def = (CntType) 0

) [inherited]

Definition at line 359 of file density_map.hpp.

template<typename CntType>

CDensityMap< CntType >::CDensityMap ( TSeqPos start,

TSeqPos stop,

float window = 1,

accum_functor * func = NULL,

CntType def = (CntType) 0

) [inherited]

Definition at line 342 of file density_map.hpp.

template<typename T>

bool CClipboard::Contains ( const T & val ) [inherited]

Definition at line 154 of file clipboard.hpp.
References CClipboard::m_Contents.

CMenuItem* CreateMenuItems ( const SMenuItemRec * items )

creates CMenuItem hierarchy from an array of SMenuItemRecRec

Definition at line 615 of file menu_item.cpp.
References _ASSERT, CMenuItem::AddSubItem(), SMenuItemRec::IsSubMenu(), SMenuItemRec::m_ImageAlias, and SMenuItemRec::m_Label.
Referenced by CWGLDemoApp::x_Create().

template<typename CntType>

void CDensityMap< CntType >::ExtendTo ( TSeqPos stop ) [inherited]

extend our density map to cover the sequence position stop.
can only be used to extend to the right, that is only Stop is affected, not Start.
Definition at line 406 of file density_map.hpp.
References CDensityMap< CntType >::GetStop(), CDensityMap< CntType >::m_Bins, CDensityMap< CntType >::m_DefVal, CDensityMap< CntType >::m_Range, COpenRange< Position >::SetTo(), and CDensityMap< CntType >::x_CalcNbins().

template<typename T>

const T & CClipboard::Get ( ) const [inline, inherited]

Definition at line 275 of file clipboard.hpp.

template<typename T>

const T & CClipboard::GetAt ( int idx ) const [inline, inherited]

Definition at line 246 of file clipboard.hpp.
References eUnknown, CClipboard::m_Contents, and NCBI_THROW.

template<typename CntType>

TSeqPos CDensityMap< CntType >::GetDensityMap ( const objects::CBioseq_Handle & handle,

TSeqPos start,

TSeqPos stop,

TSeqPos window,

objects::SAnnotSelector sel,

vector< TSeqPos > & density

) [static, inherited]

OLD static method.
Use AddFeatures method instead. retrieve a density map. The return value is the maximum value in the density graph.
Definition at line 679 of file density_map.hpp.

const CEvent::TEventClass CEvent::GetEventClass ( void ) const [inline, inherited]

Definition at line 174 of file event.hpp.
References CEvent::m_Class.
Referenced by CEventHandler::OnEvent().

template<class I>

void GetExtensionAsInterface ( const string & ext_point_id,

vector< I * > & interfaces

)

GetExtensionAsInterface() is a helper function that extracts all extensions implementing the specified interface from the given extension point.

Definition at line 199 of file extension_impl.hpp.
References _ASSERT, _VERIFY, ERR_POST, and CExtensionRegistry::GetInstance().

template<class I>

void GetExtensionAsInterface ( const string & ext_point_id,

vector< CIRef< I > > & interfaces

)

GetExtensionAsInterface() is a helper function that extracts all extensions implementing the specified interface from the given extension point.

Definition at line 174 of file extension_impl.hpp.
References _ASSERT, _VERIFY, ERR_POST, and CExtensionRegistry::GetInstance().
Referenced by CFileLoadManager::CFileLoadManager(), CAppOptionsDlg::CreateControls(), CSGDataSourceContext::CSGDataSourceContext(), CDataMiningService::InitService(), CProjectTreePanel::OnContextMenu(), CFileAutoLoader::ValidateFilenames(), CUIDataSourceService::x_InitDataSourceTypes(), CFeaturePanel::x_InitTrackManager(), CViewManagerService::x_RegisterExtensionFactories(), and CNamedPipeProcessTask::x_Run().

const CEvent::TEventID CEvent::GetID ( void ) const [inline, inherited]

Inline Implementation.

Definition at line 167 of file event.hpp.
References CEvent::m_ID.
Referenced by CViewEvent::GetType(), CMultiAlignView::OnAlnWidgetSelChanged(), CProjectView::OnDecoratePopupMenu(), CEventHandler::OnEvent(), CTestDispatcher::OnEventReceipt(), CTestReceiver::OnEventReceipt(), CProjectView::OnShowPopupMenu(), CCompositeAppTask::OnTaskEvent(), CProjectTreeView::OnWidgetSelChanged(), CProjectView::x_OnWidgetRangeChanged(), and CProjectView::x_OnWidgetSelChanged().

TSeqPos C2DLayoutEngine::GetMinDist ( void ) const [inline, inherited]

access the minimum distance, in bases, that we permit between objects on a given row

Definition at line 310 of file layout.hpp.
References C2DLayoutEngine::m_MinDist.

template<typename T>

const T * CClipboard::GetPtr ( ) const [inline, inherited]

Definition at line 282 of file clipboard.hpp.

template<typename T>

const T * CClipboard::GetPtrAt ( int idx ) const [inline, inherited]

Definition at line 267 of file clipboard.hpp.

const CEvent::TEventSender * CEvent::GetSender ( void ) const [inline, inherited]

Definition at line 181 of file event.hpp.
References CEvent::m_Sender.

template<typename CntType>

TSeqPos CDenMapRunIterator< CntType >::GetSeqPosition ( ) const [inherited]

Definition at line 167 of file density_map.hpp.
References f(), CDenMapRunIterator< CntType >::GetPosition(), CDenMapRunIterator< CntType >::m_Start, and CDenMapRunIterator< CntType >::m_Window.
Referenced by CAlignSmearGlyph::x_Draw().

template<typename CntType>

TSeqPos CDenMapRunIterator< CntType >::GetSeqRunEndPosition ( ) const [inherited]

Definition at line 173 of file density_map.hpp.
References f(), CDenMapRunIterator< CntType >::GetPosition(), CDenMapRunIterator< CntType >::GetRunLength(), CDenMapRunIterator< CntType >::m_Start, and CDenMapRunIterator< CntType >::m_Window.

template<typename CntType>

TSeqPos CDenMapRunIterator< CntType >::GetSeqRunLength ( ) const [inherited]

Definition at line 180 of file density_map.hpp.
References f(), CDenMapRunIterator< CntType >::GetRunLength(), and CDenMapRunIterator< CntType >::m_Window.
Referenced by CAlignSmearGlyph::x_Draw().

CEvent::TEventTypeInfo CEvent::GetTypeInfo ( void ) [inline, inherited]

Definition at line 188 of file event.hpp.
Referenced by CEventHandler::OnEvent().

void NcbiErrorBox ( const string & message,

const string & title = "Error"

)

specialized Message Box function for reporting critical errors

Definition at line 134 of file message_box.cpp.
References eDialog_Ok, eIcon_Stop, and NcbiMessageBox().
Referenced by CFileLoadManager::DoTransition(), CAlgoToolManagerBase::DoTransition(), CProjectTreePanel::OnBeginDrag(), CProjectTreePanel::OnEndLabelEdit(), CwxSeqMarkerSetDlg::OnOkClick(), CProjectEditDlg::OnOkClick(), CFolderEditDlg::OnOkClick(), CWorkspaceFormatLoadManager::ValidateFilenames(), CProjectFormatLoadManager::ValidateFilenames(), CAppExplorerService::x_PasteItem(), CAppJobTask::x_ReportError(), and CMergeAlignmentsToolManager::x_ValidateParams().

int NcbiFileBrowser ( SFileDlgData & data,

wxWindow * parent = NULL

)

show wxFileDialog and returns

Definition at line 174 of file message_box.cpp.
References filenames, FromArrayString(), SFileDlgData::m_Dir, SFileDlgData::m_Filenames, SFileDlgData::m_Pos, SFileDlgData::m_Size, SFileDlgData::m_Style, SFileDlgData::m_Title, SFileDlgData::m_Wildcard, ToStdString(), and ToWxString().
Referenced by CSnpFilterUI::OnButtonExportClick(), CSnpFilterUI::OnButtonImportClick(), CSaveImageDlg::x_OnBrowse(), CPrintDlg::x_OnBrowse(), and CProjectLoadingTask::x_RunCurrentSubTask().

EDialogReturnValue NcbiInfoBox ( const string & message,

const string & title = "Info"

)

specialized Message Box function for reporting general information messages

Definition at line 122 of file message_box.cpp.
References eDialog_Ok, eIcon_Info, and NcbiMessageBox().
Referenced by CExportDlgTask::x_Run(), COpenViewlDlgTask::x_Run(), and CRunToolDlgTask::x_Run().

EDialogReturnValue NcbiMessageBox ( const string & message,

TDialogType type = eDialog_Ok,

EDialogIcon icon = eIcon_Exclamation,

const string & title = "Error",

EDialogTextMode text_mode = eRaw

)

Definition at line 47 of file message_box.cpp.
References eCancel, eDialog_Ok, eDialog_OkCancel, eDialog_StyleMask, eDialog_YesNo, eDialog_YesNoCancel, eIcon_Exclamation, eIcon_Info, eIcon_Question, eIcon_Stop, eNo, eOK, eWrap, eYes, NStr::Join(), ToWxString(), and NStr::Wrap().
Referenced by CProjectService::AddProjectView(), NcbiErrorBox(), NcbiInfoBox(), NcbiWarningBox(), CSnpFilterUI::OnButtonRenameClick(), CAlnMultiWidget::OnDSChanged(), CAlnMultiWidget::OnMakeSelectedRowMaster(), CTrackCreatorUI::OnOkClick(), CTaxTreeTestDlg::OnRelatedClick(), CSnpFilterUI::x_CheckChanges(), CProjectTask::x_DoEnsureProjectSaved(), CProjectLoadingTask::x_RunCurrentSubTask(), and CAlnMultiWidget::x_SetScoringMethod().

void NcbiWarningBox ( const string & message,

const string & title = "Warning"

)

specialized Message Box function for reporting non-critical errors

Definition at line 128 of file message_box.cpp.
References eDialog_Ok, eIcon_Exclamation, and NcbiMessageBox().

CRgbaColor operator * ( const CRgbaColor & c1,

float f

)

multiply a color by a scalar

Definition at line 92 of file rgba_color.cpp.

CRgbaColor operator+ ( const CRgbaColor & c1,

const CRgbaColor & c2

)

add two colors

Definition at line 72 of file rgba_color.cpp.

bool operator< ( const CRgbaColor & c1,

const CRgbaColor & c2

)

define a some-what arbitrary sort order based on brightness It does have the property of being equivalent to operator==, that is: ( ! a<b && ! b<a ) iff a == b

Definition at line 111 of file rgba_color.cpp.
References CRgbaColor::Brightness(), and CRgbaColor::GetBlue().

bool operator< ( const CLayoutObject & o1,

const CLayoutObject & o2

) [inline]

Definition at line 176 of file layout.hpp.
References CLayoutObject::LessByPos().

CNcbiOstream& operator<< ( CNcbiOstream & strm,

const CBBox< 3 > & bb

) [inline]

Definition at line 132 of file bbox.hpp.

CNcbiOstream& operator<< ( CNcbiOstream & strm,

TFileType & ftype

)

template<typename CntType>

CDensityMap< CntType > & CDensityMap< CntType >::operator= ( const CDensityMap< CntType > & map ) [inherited]

Definition at line 388 of file density_map.hpp.
References CDensityMap< CntType >::m_AccumFunc, CDensityMap< CntType >::m_Bins, CDensityMap< CntType >::m_DefVal, CDensityMap< CntType >::m_Max, CDensityMap< CntType >::m_Min, CDensityMap< CntType >::m_Range, CDensityMap< CntType >::m_Window, and auto_ptr< X >::reset().

bool operator== ( const CRgbaColor & c1,

const CRgbaColor & c2

)

global comparison operator

Definition at line 102 of file rgba_color.cpp.

bool operator== ( const SConstScopedObject & s1,

const SConstScopedObject & s2

) [inline]

Definition at line 85 of file objects.hpp.
References SConstScopedObject::object, and SConstScopedObject::scope.

bool operator== ( const SScopedObject & s1,

const SScopedObject & s2

) [inline]

Definition at line 59 of file objects.hpp.
References SScopedObject::object, and SScopedObject::scope.

template<typename InIt>

void CClipboard::Set ( InIt first,

InIt last

) [inline, inherited]

Definition at line 194 of file clipboard.hpp.
References CClipboard::m_Contents, and CClipboard::x_AddValue().

template<typename T>

void CClipboard::Set ( const T & val ) [inline, inherited]

Definition at line 185 of file clipboard.hpp.
References CClipboard::m_Contents, and CClipboard::x_AddValue().
Referenced by CObjClipboard::Add().

void C2DLayoutEngine::SetMinDist ( TSeqPos dist ) [inline, inherited]

Definition at line 317 of file layout.hpp.
References C2DLayoutEngine::m_MinDist.

void C2DLayoutEngine::SetSideSpace ( TSeqPos space ) [inline, inherited]

Definition at line 323 of file layout.hpp.
References C2DLayoutEngine::m_SideSpace.

template<typename T>

void CClipboard::x_AddFlavor ( int idx,

const T & val

) [inline, protected, inherited]

Definition at line 305 of file clipboard.hpp.
References CClipboard::m_Contents, and NON_CONST_ITERATE.
Referenced by CClipboard::AddFlavor(), and CClipboard::AddFlavorAt().

template<>

int CClipboard::x_AddValue ( const string & val ) [inline, protected, inherited]

template<typename T>

int CClipboard::x_AddValue ( const T & val ) [inline, protected, inherited]

Definition at line 216 of file clipboard.hpp.
References CClipboard::x_AddValueEx().
Referenced by CClipboard::Add(), and CClipboard::Set().

template<typename T>

int CClipboard::x_AddValueEx ( const T & val ) [inline, protected, inherited]

Definition at line 205 of file clipboard.hpp.
References CClipboard::m_Contents.
Referenced by CClipboard::x_AddValue().

template<typename CntType>

CDenMapRunIterator< CntType >::position_type CDenMapRunIterator< CntType >::x_CalcRunLength ( ) const [private, inherited]

Definition at line 188 of file density_map.hpp.
References CDenMapRunIterator< CntType >::m_Bins, and CDenMapRunIterator< CntType >::m_Pos.
Referenced by CDenMapRunIterator< CntType >::Advance().

template<typename T>

const T * CClipboard::x_GetValueAt ( int idx ) const [inline, protected, inherited]

Definition at line 292 of file clipboard.hpp.
References ITERATE, and CClipboard::m_Contents.

Generated on Mon Dec 7 16:03:36 2009 for NCBI C++ ToolKit by

1.4.6

Modified on Mon Dec 07 16:24:36 2009 by modify_doxy.py rev. 173732


Files
file	command.hpp
	GUI command routing and handling framework.
file	menu_item.hpp
Classes
struct	binary_functor< Type >
	TEMPLATE binary functor base struct. More...
struct	plus_func< Type >
	TEMPLATE STRUCT max. More...
struct	max_func< Type >
	TEMPLATE STRUCT max. More...
struct	min_func< Type >
	TEMPLATE STRUCT min. More...
class	CDenMapRunIterator< CntType >
	Run iterator. iterate through runs of equal values in the bins. More...
class	CDensityMap< CntType >
	class CDensityMap generates a low-resolution view of a set of features. More...
class	CFilter
	CFilter --. More...
class	CFilterSet
class	CGBUserType
	CGBUserType. More...
class	CGBUserTypeParent_CI
class	IUserTypeExtension
class	CGBUserTypeReg
	CGBUserTypeReg - container of registered user types. More...
class	CUserTypeExtensionPoint
class	CLabel
class	ILabelHandler
	ILabelHandler interface. More...
class	CLayoutObject
	class CLayoutObject defines an interface that wraps a rectilinear abstract object. More...
struct	SLayoutByPos
	basic sort by position function More...
struct	SLayoutBySize
	basic sort by size function More...
class	CLayout
	class CLayout is a container of objects laid out in a series of rows or tracks. More...
class	CLayoutEngine
	class CLayoutEngine defines the abstract interface for a given alyout algorithm. More...
class	C2DLayoutEngine
	class C2DLayoutEngine defines the interface for a standard 2D layout engine. More...
struct	SScopedObject
struct	SScopedObjectLess
struct	SConstScopedObject
struct	SConstScopedObjectLess
class	CGUIUserType
	CGUIUserType. More...
class	CAccelTable
	CAccelTable - Accelerator Table. More...
class	IAppJobProgress
	IAppJobProgress. More...
class	IAppJobError
	IAppJobError. More...
class	IAppJob
	IAppJob. More...
class	IAppJobEngineListener
	IAppJobEngineListener - receives notifications about changes in job state. More...
class	CAppJobException
	CAppJobException - Exception thrown by Job Dispatcher and Job Engines. More...
class	CAppJobDispatcher
	CAppJobDispatcher. More...
class	IAppJobListener
	IAppJobListener Interface for components that need to be notified about changes in Jobs. More...
class	IAppJobEngine
	IAppJobEngine. More...
class	IAppJobEngineParams
	IAppJobEngineParams A base class for Engine Parmeters classes. More...
class	CAppJobProgress
	CAppJobProgress Default implementation for IAppJobProgress - the class encapsulates a text message and a numeric value indicating the progress of the task normalized in [0.0, 1.0] range (0.0 - just started, 1.0 - 100% done). More...
class	CAppJobError
	CAppJobError Default implementation for IAppJobError - encapsulates a text error message. More...
class	CAppJobTextResult
	CAppJobTextResult Default implementation for result object - encapsulates a text error message. More...
class	CAppJob
	CAppJob - default implementation of IAppJob that could be used as a base class. More...
class	CAppInfo
	class CAppInfo defines an interface for application registration information More...
class	CAppRegistry
	class CAppRegistry defines the registry of application information for automated application link-outs More...
class	CAppPopup
	class CAppPopup allows applications to be launched based on standard registered types More...
struct	SAttrRangeCollectionElement< Attr, Position >
	TAttrRangeCollection represents a sequence of continious attributed intervals. More...
class	CAttrRangeCollection< Attr, Position >
class	CBBox< N >
class	CBrowserUtils
class	ITransferable
class	CTransferable< T >
class	CClipboard
class	ICmdUI
	ICmdUI - interface for updating command GUI elements such as menu itms and tool bar buttons. More...
class	ICurve
	class ICurve defines a basic interface for all curves. More...
class	IEventAttachment
	object, that will be attached to event More...
class	CEventAttachmentFor< T >
	templatized IEventAttachment wrapper More...
class	CEvent
	CEvent - generic event implementation TODO TODO - Attachments. More...
struct	SEvtMapEntry
	Command map entry. More...
struct	SEvtMap
	Command Map. More...
struct	hash< CEventHandler * >
class	CEventHandler
	CEventHandler. More...
class	CAppJobNotification
	CAppJobNotification Notification send by CAppJobEventTranslator. More...
class	CAppJobEventTranslator
	CAppJobEventTranslator Standard Listener that generates notification events. More...
class	CExecute
class	IExtension
	IExtension IExtension interface represents an abstract pluggable component. More...
class	IExtensionPoint
	IExtensionPoint. More...
class	IExtensionRegistry
	IExtensionRegistry IExtensionRegistry is an interface representing a Registry where Extension Points and Extensions are registered. More...
class	CExtensionPoint
	CExtensionPoint - standard implementation of IExtensionPoint. More...
class	CExtensionRegistry
	CExtensionRegistry - standard implementation of IExtensionRegistry. More...
class	CExtensionPointDeclaration
	CExtensionPointDeclaration - static declaration helper. More...
class	CExtensionDeclaration
	CExtensionDeclaration - static declaration helper. More...
class	CFetchURL
class	CFltkUtils
class	CFltkGuard
	class CFltkGuard is a simple exception-safe guard wrapper for FLTK's GUI locking mechanism More...
class	CFltkCursorGuard
	class CFltkCursorGuard implements a guard paradigm for changing and restoring the current cursor. More...
class	CFlCurrentGuard
	CFlCurrentGuard locks and restores Fl_Group::current(). More...
class	CFuncPtr
class	CFuncPtrTmpl< T >
class	CFuncPtr1< RetType, Arg1 >
class	CFuncPtrTmpl1< T, RetType, Arg1 >
class	CVoidFuncPtr1< Arg1 >
class	CVoidFuncPtrTmpl1< T, Arg1 >
class	CIdGenerator
	CIdGenerator - generates consecutive integer identifiers. More...
class	CUniqueLabelGenerator
	CUniqueLabelGenerator Modifies the given label so that it becomes unique in the given set of labels by appending a numeric postfix ( "name" -> "name (1)" ). More...
class	CMenuItem
	CMenuItem - represents a menu items in IMenu-style menus. More...
struct	SwxMenuItemRec
	New macros for defining menus for use with CUICommandRegistry. More...
struct	SMenuItemRec
	SMenuItemRec. More...
class	IReporter
class	CRgbaColor
	class CRgbaColor provides a simple abstraction for managing colors. More...
class	CStringUtil
class	CSystemPath
class	CTableNames
class	CThreadPoolEngine
	CThreadPoolEngine. More...
class	CAppJobRequest
	CAppJobRequest CAppJobRequest serves as an adapter between IAppJob, CStdPoolOfThreads and CThreadPoolEngine. More...
class	IUIObject
	IUIObject - object that provides basic properties often required in a UI object. More...
class	CUIObject
	CUIObject - default mix-in implementation of IUIObject. More...
class	CMacOSX
struct	SFileDlgData
	File dialog utilities. More...
Defines
#define	EXT_POINT__USER_TYPE "user_types::user_type_extension"
#define	EVENT_MAP_TX_BEGIN
	Event Dispatcher macros.
#define	EVENT_FIRE_ALL() Dispatch(evt, disp_how, pool_name);
#define	EVENT_MAP_TX_END }
#define	DECLARE_EVENT_MAP()
#define	BEGIN_EVENT_MAP(thisClass, baseClass)
	Begins definition of Command Map for CEventHandler-derived class.
#define	END_EVENT_MAP()
	Ends definition of Command Map.
#define	ON_EVENT(type, id, handler) ON_MESSAGE(type, id, handler)
	Adds a Message as Command Map entry.
#define	ON_MESSAGE(type, id, handler) { ncbi::CEvent::eEvent_Message, typeid(type).name(), id, id, (FEventHandler) handler },
#define	ON_EVENT_EX(cls, type, id, handler) { cls, typeid(type).name(), id, id, (FEventHandler) handler },
	Adds a Command Map entry mapping given command id to given command handler.
#define	ON_CMD(type, id, handler) { ncbi::CEvent::eEvent_Command, typeid(type).name(), id, id, (FEventHandler) ((FCommandHandler) handler) },
	Adds a Command as Command Map entry.
#define	ON_CMD_RANGE(type, id, id_last, handler) { ncbi::CEvent::eEvent_Command, typeid(type).name(), id, id_last, (FEventHandler) ((FCommandRangeHandler) handler) },
	Adds a Command Range as Command Map entry.
#define	ON_CMD_UPDATE(type, id, handler) { CEvent::eEvent_CommandUpdate, typeid(type).name(), id, id, (FEventHandler) ((FCommandUpdateHandler)handler) },
	Adds a Update Command as Command Map entry.
#define	ON_CMD_UPDATE_RANGE(type, id, id_last, handler) { CEvent::eEvent_CommandUpdate, typeid(type).name(), id, id_last, (FEventHandler) ((FCommandUpdateHandler)handler) },
	Adds a Update Command Range as Command Map entry.
#define	ON_EVENT_RANGE(type, id, id_last, handler) ON_MESSAGE_RANGE(type, id, id_last, handler)
	Adds a Command Map entry mapping given command range to given command handler.
#define	ON_MESSAGE_RANGE(type, id, id_last, handler) { CEvent::eEvent_Message, typeid(type).name(), id, id_last, (FEventHandler) handler },
	Adds a Command Map entry mapping given message range to given command handler.
#define	WX_DEFINE_MENU(name)
#define	WX_MENU_ITEM(cmd) { CMenuItem::eItem, "", cmd, CMenuItem::eDefault },
#define	WX_MENU_CHECK_ITEM(cmd) { CMenuItem::eItem, "", cmd, CMenuItem::eCheckItem },
#define	WX_MENU_SEPARATOR() { CMenuItem::eSeparator, "", eCmdNone, CMenuItem::eDefault },
#define	WX_MENU_SEPARATOR_L(label) { CMenuItem::eSeparator, label, eCmdNone, CMenuItem::eDefault },
#define	WX_SUBMENU(label) { CMenuItem::eSubmenu, label, eCmdNone, CMenuItem::eDefault },
#define	WX_END_SUBMENU() { CMenuItem::eSubmenu, "", eCmdInvalid, CMenuItem::eDefault },
#define	WX_END_MENU()
#define	DEFINE_MENU(name)
#define	MENU_ITEM(cmd, label) { CMenuItem::eItem, label, cmd, "", "", CMenuItem::eDefault},
#define	MENU_ITEM_T(cmd, label, tooltip) { CMenuItem::eItem, label, cmd, "", tooltip, CMenuItem::eDefault},
#define	MENU_ITEM_IM(cmd, label, image) { CMenuItem::eItem, label, cmd, image, "", CMenuItem::eDefault},
#define	MENU_ITEM_IM_T(cmd, label, image, tooltip) { CMenuItem::eItem, label, cmd, image, tooltip, CMenuItem::eDefault},
#define	MENU_ITEM_RADIO(cmd, label) { CMenuItem::eItem, label, cmd, "", "", CMenuItem::eRadioItem},
#define	MENU_ITEM_CHECK(cmd, label) { CMenuItem::eItem, label, cmd, "", "", CMenuItem::eCheckItem},
#define	MENU_SEPARATOR() { CMenuItem::eSeparator, "", eCmdNone, "", "", CMenuItem::eDefault},
#define	MENU_SEPARATOR_L(label) { CMenuItem::eSeparator, label, eCmdNone, "", "", CMenuItem::eDefault},
#define	SUBMENU(label) { CMenuItem::eSubmenu, label, eCmdNone, "", "", CMenuItem::eDefault},
#define	SUBMENU_IM(label, image) { CMenuItem::eSubmenu, label, eCmdNone, image, "", CMenuItem::eDefault},
#define	END_SUBMENU() { CMenuItem::eSubmenu, "", eCmdInvalid, "", "", CMenuItem::eDefault},
#define	END_MENU()
Typedefs
typedef vector< CRef< CObject > >	TObjects
typedef vector< CConstRef< CObject > >	TConstObjects
typedef vector< SScopedObject >	TScopedObjects
typedef vector< SConstScopedObject >	TConstScopedObjects
typedef enum EFileType	TFileType
typedef void(CEventHandler::*	FCMDUpdateHandler )(ICmdUI *)
	callback for updating command UI elements
typedef int	TCmdID
typedef void(CEventHandler::*	FEventHandler )(CEvent *)
	event handler
typedef void(CEventHandler::*	FCommandHandler )(void)
	command handler
typedef void(CEventHandler::*	FCommandRangeHandler )(CEvent::TEventID)
	command range handler
typedef void(CEventHandler::*	FCommandUpdateHandler )(IEventAttachment *)
	update command handler
Enumerations
enum	EFileType { eUnknown = 0, ePdf }
	enumerated file type information More...
enum	EBaseCommands { eCmdMenuEnd = -2, eCmdInvalid = -1, eCmdNone = 0, eCmdZoomIn, eCmdZoomOut, eCmdZoomAll, eCmdZoomInMouse, eCmdZoomOutMouse, eCmdZoomSel, eCmdZoomSeq, eCmdZoomObjects, eCmdZoomSelObjects, eCmdZoomInX, eCmdZoomOutX, eCmdZoomAllX, eCmdZoomInY, eCmdZoomOutY, eCmdZoomAllY, eCmdSetEqualScale, eCmdSettings, eCmdResetSelection, eCmdEditSelection, eCmdDeleteSelection, eCmdDeleteSelectionAndOrphaned, eCmdBack, eCmdForward, eCmdSeqGoto, eBaseCmdLast }
	Definitions for generic commands. More...
Functions
bool	operator< (const CLayoutObject &o1, const CLayoutObject &o2)
bool	operator== (const SScopedObject &s1, const SScopedObject &s2)
bool	operator== (const SConstScopedObject &s1, const SConstScopedObject &s2)
CNcbiOstream &	operator<< (CNcbiOstream &strm, TFileType &ftype)
CNcbiOstream &	operator<< (CNcbiOstream &strm, const CBBox< 3 > &bb)
template<class I>
void	GetExtensionAsInterface (const string &ext_point_id, vector< CIRef< I > > &interfaces)
	GetExtensionAsInterface() is a helper function that extracts all extensions implementing the specified interface from the given extension point.
template<class I>
void	GetExtensionAsInterface (const string &ext_point_id, vector< I * > &interfaces)
	GetExtensionAsInterface() is a helper function that extracts all extensions implementing the specified interface from the given extension point.
CMenuItem *	CreateMenuItems (const SMenuItemRec *items)
	creates CMenuItem hierarchy from an array of SMenuItemRecRec
bool	operator== (const CRgbaColor &c1, const CRgbaColor &c2)
	global comparison operator
bool	operator< (const CRgbaColor &c1, const CRgbaColor &c2)
	define a some-what arbitrary sort order based on brightness It does have the property of being equivalent to operator==, that is: ( ! a<b && ! b<a ) iff a == b
CRgbaColor	operator+ (const CRgbaColor &c1, const CRgbaColor &c2)
	add two colors
CRgbaColor	operator * (const CRgbaColor &c1, float f)
	multiply a color by a scalar
EDialogReturnValue	NcbiMessageBox (const string &message, TDialogType type=eDialog_Ok, EDialogIcon icon=eIcon_Exclamation, const string &title="Error", EDialogTextMode text_mode=eRaw)
EDialogReturnValue	NcbiInfoBox (const string &message, const string &title="Info")
	specialized Message Box function for reporting general information messages
void	NcbiWarningBox (const string &message, const string &title="Warning")
	specialized Message Box function for reporting non-critical errors
void	NcbiErrorBox (const string &message, const string &title="Error")
	specialized Message Box function for reporting critical errors
int	NcbiFileBrowser (SFileDlgData &data, wxWindow *parent=NULL)
	show wxFileDialog and returns
TSeqPos	CDenMapRunIterator::GetSeqPosition () const
TSeqPos	CDenMapRunIterator::GetSeqRunEndPosition () const
TSeqPos	CDenMapRunIterator::GetSeqRunLength () const
position_type	CDenMapRunIterator::x_CalcRunLength () const
CntType	CDenMapRunIterator::Advance ()
	CDensityMap::CDensityMap (TSeqPos start, TSeqPos stop, float window=1, accum_functor *func=NULL, CntType def=(CntType) 0)
	CDensityMap::CDensityMap (const objects::CBioseq_Handle &handle, float window=1, accum_functor *func=NULL, CntType def=(CntType) 0)
	CDensityMap::CDensityMap (const CDensityMap< CntType > &map)
CDensityMap< CntType > &	CDensityMap::operator= (const CDensityMap< CntType > &map)
void	CDensityMap::ExtendTo (TSeqPos stop)
	extend our density map to cover the sequence position stop.
void	CDensityMap::AddRange (TSeqRange range, CntType score=1, bool expand=false)
CntType	CDensityMap::AddLocation (const objects::CSeq_loc &loc)
CntType	CDensityMap::AddFeature (const objects::CSeq_feat &feature)
CntType	CDensityMap::AddFeatures (const objects::CBioseq_Handle &handle, objects::SAnnotSelector sel)
	All features on this bioseq selected by sel in the range of this.
CntType	CDensityMap::AddAlignments (const objects::CBioseq_Handle &handle, objects::SAnnotSelector sel)
	All alignments on this bioseq selected by sel in the range of this.
CntType	CDensityMap::AddAlignments (const objects::CBioseq_Handle &handle, const objects::CSeq_annot &seq_annot)
	All alignments in a given annotation on this bioseq within the range of this.
static TSeqPos	CDensityMap::GetDensityMap (const objects::CBioseq_Handle &handle, TSeqPos start, TSeqPos stop, TSeqPos window, objects::SAnnotSelector sel, vector< TSeqPos > &density)
	OLD static method.
TSeqPos	C2DLayoutEngine::GetMinDist (void) const
	access the minimum distance, in bases, that we permit between objects on a given row
void	C2DLayoutEngine::SetMinDist (TSeqPos dist)
void	C2DLayoutEngine::SetSideSpace (TSeqPos space)
template<typename T>
bool	CClipboard::Contains (const T &val)
template<typename T>
int	CClipboard::Add (const T &val)
template<typename InIt>
void	CClipboard::Add (InIt first, InIt last)
template<typename T>
void	CClipboard::Set (const T &val)
template<typename InIt>
void	CClipboard::Set (InIt first, InIt last)
template<typename T>
int	CClipboard::x_AddValueEx (const T &val)
template<typename T>
int	CClipboard::x_AddValue (const T &val)
template<>
int	CClipboard::x_AddValue (const string &val)
template<typename T>
const T &	CClipboard::GetAt (int idx) const
template<typename T>
const T *	CClipboard::GetPtrAt (int idx) const
template<typename T>
const T &	CClipboard::Get () const
template<typename T>
const T *	CClipboard::GetPtr () const
template<typename T>
const T *	CClipboard::x_GetValueAt (int idx) const
template<typename T>
void	CClipboard::x_AddFlavor (int idx, const T &val)
template<typename T>
void	CClipboard::AddFlavor (const T &val)
template<typename T>
void	CClipboard::AddFlavorAt (int idx, const T &val)
const TEventID	CEvent::GetID (void) const
	Inline Implementation.
const TEventClass	CEvent::GetEventClass (void) const
const TEventSender *	CEvent::GetSender (void) const
TEventTypeInfo	CEvent::GetTypeInfo (void)

GUI Utility Classes and Modules [GUI Framework]

Detailed Description

Files

Classes

Defines

Typedefs

Enumerations

Functions

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation

GUI Utility Classes and Modules
[GUI Framework]