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

Go to the SVN repository for this file.

1 #ifndef PKG_SEQUENCE___CLEANUP_PARAMS__HPP
2 #define PKG_SEQUENCE___CLEANUP_PARAMS__HPP
3 
4 /* $Id: cleanup_params.hpp 37331 2016-12-23 19:52:17Z katargir $
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: Roman Katargin
30  */
31 
32 #include <corelib/ncbiobj.hpp>
33 
34 #include <gui/objutils/objects.hpp>
36 
37 #include <wx/string.h>
38 
40 
41 
42 /** @addtogroup GUI_PKG_SEQUENCE
43  *
44  * @{
45  */
46 
47 /*!
48  * CCleanupParams class declaration
49  */
50 
52 {
53  friend class CCleanupPanel;
54 public:
55  /// Default constructor for CCleanupParams
57 
58  /// Copy constructor for CCleanupParams
60 
61  /// Destructor for CCleanupParams
63 
64  /// Assignment operator for CCleanupParams
65  void operator=(const CCleanupParams& data);
66 
67  /// Equality operator for CCleanupParams
68  bool operator==(const CCleanupParams& data) const;
69 
70  /// Copy function for CCleanupParams
71  void Copy(const CCleanupParams& data);
72 
73  /// Initialises member variables
74  void Init();
75 
76  /// IRegSettings
77  virtual void SetRegistryPath(const string& path);
78  virtual void SaveSettings() const;
79  virtual void LoadSettings();
80 
81  const TConstScopedObjects& GetObjects() const { return m_Objects; }
83 
84  ////@begin CCleanupParams member function declarations
85  int GetCleanupMode() const { return m_CleanupMode ; }
87 
88 ////@end CCleanupParams member function declarations
89 
90 ////@begin CCleanupParams member variables
91 private:
93 ////@end CCleanupParams member variables
94 
95  string m_RegPath;
97 };
98 
99 /* @} */
100 
102 
103 #endif // PKG_SEQUENCE___CLEANUP_PARAMS__HPP
IRegSettings An interface for objects that save / restore settings using CGuiRegistry.
char data[12]
Definition: iconv.c:80
CCleanupParams()
Default constructor for CCleanupParams.
virtual void SaveSettings() const
void SetCleanupMode(int value)
virtual void SetRegistryPath(const string &path)
IRegSettings.
TConstScopedObjects & SetObjects()
bool operator==(const CCleanupParams &data) const
Equality operator for CCleanupParams.
void Copy(const CCleanupParams &data)
Copy function for CCleanupParams.
int GetCleanupMode() const
const TConstScopedObjects & GetObjects() const
virtual void LoadSettings()
void Init()
Initialises member variables.
TConstScopedObjects m_Objects
void operator=(const CCleanupParams &data)
Assignment operator for CCleanupParams.
~CCleanupParams()
Destructor for CCleanupParams.
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
const GenericPointer< typename T::ValueType > T2 value
Definition: pointer.h:1227
Portable reference counted smart and weak pointers using CWeakRef, CRef, CObject and CObjectEx.
Modified on Tue Jul 02 10:35:03 2024 by modify_doxy.py rev. 669887