NCBI C++ ToolKit
windowmasker_tool.hpp
Go to the documentation of this file.

Go to the SVN repository for this file.

1 #ifndef PKG_SEQUENCE___WINDOWMASKER_TOOL__HPP
2 #define PKG_SEQUENCE___WINDOWMASKER_TOOL__HPP
3 
4 /* $Id: windowmasker_tool.hpp 46706 2021-09-09 19:54:51Z asztalos $
5 * ===========================================================================
6 *
7 * PUBLIC DOMAIN NOTICE
8 * National Center for Biotechnology Information
9 *
10 * This software/database is a "United States Government Work" under the
11 * terms of the United States Copyright Act. It was written as part of
12 * the author's official duties as a United States Government employee and
13 * thus cannot be copyrighted. This software/database is freely available
14 * to the public for use. The National Library of Medicine and the U.S.
15 * Government have not placed any restriction on its use or reproduction.
16 *
17 * Although all reasonable efforts have been taken to ensure the accuracy
18 * and reliability of the software and data, the NLM and the U.S.
19 * Government do not and cannot warrant the performance or results that
20 * may be obtained by using this software or data. The NLM and the U.S.
21 * Government disclaim all warranties, express or implied, including
22 * warranties of performance, merchantability or fitness for any particular
23 * purpose.
24 *
25 * Please cite the author in any work or product based on this material.
26 *
27 * ===========================================================================
28 *
29 * Authors: Vladimir Tereshkov
30 *
31 * File Description:
32 * Implementation of Window Masker tool for GenomeWorkbench.
33 */
34 
35 #include <corelib/ncbistd.hpp>
36 
39 
41 
42 class CWindowMaskerPanel;
43 
44 ///////////////////////////////////////////////////////////////////////////////
45 /// CWindowMaskerTool
47 {
48 public:
50 
51  /// @name overriding IUIToolManager functions implemented in CAlgoToolManagerBase
52  /// @{
53  virtual void InitUI();
54  virtual void CleanUI();
55  virtual bool UsesSingleOMScope() { return false; }
56  /// @}
57 
58  /// @name IExtension interface implementation
59  /// @{
60  virtual string GetExtensionIdentifier() const;
61  virtual string GetExtensionLabel() const;
62  /// @}
63 
64 protected:
65  /// @name overriding CAlgoToolManagerBase virtual functions
66  /// @{
67 
70  virtual bool x_CreateParamsPanelIfNeeded();
71  virtual bool x_ValidateParams();
73  /// @}
74 
75  virtual void x_SelectCompatibleInputObjects();
76 
77 protected:
81 };
82 
84 
85 #endif // PKG_SEQUENCE___WINDOWMASKER_TOOL__HPP
86 
CAlgoToolManagerBase This is base class for simple algorithmic tool managers.
CAlgoToolManagerParamsPanel.
CDataLoadingAppJob - a base class for Jobs loading data into projects.
CWindowMaskerTool.
virtual bool UsesSingleOMScope()
virtual CDataLoadingAppJob * x_CreateLoadingJob()
factory method for creating the job that executes the tool algorithm override in derived classes
virtual bool x_CreateParamsPanelIfNeeded()
returns / creates Parameters panel, override in derived classes see cpp file for example
virtual void InitUI()
override this function in a derived class and initialize extra members
virtual bool x_ValidateParams()
validates user input in Parameters panel, report errors if any
CWindowMaskerParams m_Params
CWindowMaskerTool()
CWindowMaskerTool.
virtual void CleanUI()
override this function in a derived class and clean extra members
virtual string GetExtensionLabel() const
returns a displayable label for this extension ( please capitalize the key words - "My Extension" )
virtual IRegSettings * x_GetParamsAsRegSetting()
return a pointer to Parameters object as IRegSettings interface
virtual CAlgoToolManagerParamsPanel * x_GetParamsPanel()
returns a pointer to the parameters panel, override in derived classes
virtual string GetExtensionIdentifier() const
returns the unique human-readable identifier for the extension the id should use lowercase letters se...
TConstScopedObjects m_Objects
CWindowMaskerPanel * m_Panel
virtual void x_SelectCompatibleInputObjects()
IRegSettings An interface for objects that save / restore settings using CGuiRegistry.
Include a standard set of the NCBI C++ Toolkit most basic headers.
vector< SConstScopedObject > TConstScopedObjects
Definition: objects.hpp:65
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
Modified on Wed Apr 17 13:08:42 2024 by modify_doxy.py rev. 669887