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

Search Toolkit Book for IUIToolWithGUI

IUIToolWithGUI - represents a method that can be integrated in GUI. More...

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

+ Inheritance diagram for IUIToolWithGUI:

Public Member Functions

virtual ~IUIToolWithGUI ()
 
virtual const CMenuItemGetMenu ()=0
 Returns a pointer to the submenu. More...
 
virtual bool HasPropertiesPanel () const =0
 returns true if the method supports properties dialog More...
 
virtual wxWindow * CreatePropertiesPanel (wxWindow *parent)=0
 This a factory method that shall produce a CPropertiesPanel representing properties of the method; the panel Apply() must take care of appying changes to the method. More...
 
virtual ~IUIToolWithGUI ()
 
virtual const CMenuItemGetMenu ()=0
 Returns a pointer to the submenu. More...
 
virtual bool HasPropertiesPanel () const =0
 returns true if the method supports properties dialog More...
 
virtual wxWindow * CreatePropertiesPanel (wxWindow *parent)=0
 This a factory method that shall produce a CPropertiesPanel representing properties of the method; the panel Apply() must take care of appying changes to the method. More...
 

Detailed Description

IUIToolWithGUI - represents a method that can be integrated in GUI.

Definition at line 101 of file ui_tool.hpp.

Constructor & Destructor Documentation

◆ ~IUIToolWithGUI() [1/2]

virtual IUIToolWithGUI::~IUIToolWithGUI ( )
inlinevirtual

Definition at line 104 of file ui_tool.hpp.

◆ ~IUIToolWithGUI() [2/2]

virtual IUIToolWithGUI::~IUIToolWithGUI ( )
inlinevirtual

Definition at line 48 of file ui_tool_with_gui.hpp.

Member Function Documentation

◆ CreatePropertiesPanel() [1/2]

virtual wxWindow* IUIToolWithGUI::CreatePropertiesPanel ( wxWindow *  parent)
pure virtual

This a factory method that shall produce a CPropertiesPanel representing properties of the method; the panel Apply() must take care of appying changes to the method.

Implemented in CMatrixScoringMethod, CColumnScoringMethod, CColorTableMethod, CSNPScoringMethod, CSimpleScoringMethod, CConservationScoringMethod, and CQualityScoringMethod.

Referenced by CPropertiesPanelDlg::CreateControls().

◆ CreatePropertiesPanel() [2/2]

virtual wxWindow* IUIToolWithGUI::CreatePropertiesPanel ( wxWindow *  parent)
pure virtual

This a factory method that shall produce a CPropertiesPanel representing properties of the method; the panel Apply() must take care of appying changes to the method.

Implemented in CMatrixScoringMethod, CColumnScoringMethod, CColorTableMethod, CSNPScoringMethod, CSimpleScoringMethod, CConservationScoringMethod, and CQualityScoringMethod.

◆ GetMenu() [1/2]

virtual const CMenuItem* IUIToolWithGUI::GetMenu ( )
pure virtual

Returns a pointer to the submenu.

If the pointer is not NULL, then this submenu is integrated into the application's menu. If method is derived from CCommandTarget it will recieve command events.

Implemented in CMatrixScoringMethod, CColumnScoringMethod, CColorTableMethod, CSNPScoringMethod, CSimpleScoringMethod, and CQualityScoringMethod.

Referenced by CAlnMultiWidget::x_CreateScoringMethodsMenu().

◆ GetMenu() [2/2]

virtual const CMenuItem* IUIToolWithGUI::GetMenu ( )
pure virtual

Returns a pointer to the submenu.

If the pointer is not NULL, then this submenu is integrated into the application's menu. If method is derived from CCommandTarget it will recieve command events.

Implemented in CMatrixScoringMethod, CColumnScoringMethod, CColorTableMethod, CSNPScoringMethod, CSimpleScoringMethod, and CQualityScoringMethod.

◆ HasPropertiesPanel() [1/2]

virtual bool IUIToolWithGUI::HasPropertiesPanel ( ) const
pure virtual

◆ HasPropertiesPanel() [2/2]

virtual bool IUIToolWithGUI::HasPropertiesPanel ( ) const
pure virtual

returns true if the method supports properties dialog

Implemented in CMatrixScoringMethod, CColumnScoringMethod, CColorTableMethod, CSNPScoringMethod, CSimpleScoringMethod, and CQualityScoringMethod.


The documentation for this class was generated from the following files:
Modified on Wed May 22 11:29:41 2024 by modify_doxy.py rev. 669887