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

Go to the SVN repository for this file.

1 #ifndef GUI_CORE___SELECT_PROJECT_OPTIONS__HPP
2 #define GUI_CORE___SELECT_PROJECT_OPTIONS__HPP
3 
4 /* $Id: select_project_options.hpp 47479 2023-05-02 13:24:02Z ucko $
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: Andrey Yazhuk, Liangshou Wu
30  *
31  * File Description:
32  *
33  */
34 
35 #include <corelib/ncbistd.hpp>
36 
37 #include <gui/gui_export.h>
38 
43 
45 
46 class CProjectService;
48 class CGBDocument;
49 
50 ///////////////////////////////////////////////////////////////////////////////
51 /// CProjectSelectOptions - describes how new Project Items shall be added
52 /// to a workspace. If folder name is not empty a new Project Folder will be
53 /// created for the items.
55 {
56 public:
57  enum EAction {
58  eInvalidAction = -1,
62  eAddToExistingProject
63  };
64  using TProjectId = objects::CGBProjectHandle::TId;
65 
66 public:
68 
69  void Set_DecideLater();
70  void Set_CreateNewProject( const string& folder = kEmptyStr );
71  void Set_CreateSeparateProjects();
72  void Set_AddToExistingProject(
73  TProjectId& project_id, const string& folder = kEmptyStr
74  );
75 
76  void SetNewProjectName(const string& newProjectName) { m_NewProjectName = newProjectName; }
77 
78  EAction GetAction();
79  TProjectId GetTargetProjectId();
80  string GetFolderName();
81 
83  typedef vector<TItemRef> TItems;
84 
86  typedef vector<TLoaderRef> TLoaders;
87 
89 
90  bool AddItemsToWorkspace(CProjectService* service, const TData& data);
91 
92  static void InitProjectnameGenerator(objects::CGBWorkspace& ws, CUniqueLabelGenerator& projectNames);
93  static CGBDocument* CreateProject(CProjectService* service, const string& prjName, const string& prjDesc);
94 
95 protected:
96  bool x_ShowSelectProjectDialog(CProjectService* service, TItems& items);
97 
98  void x_AddToExistingProject(CProjectService* service, TItems& items, const TLoaders& loaders);
99  void x_CreateOneProject(CProjectService* service, TItems& items, const TLoaders& loaders);
100  void x_CreateSeparateProjects(CProjectService* service, const TData& data);
101 
104  string m_FolderName;
106 };
107 
109 
110 #endif // GUI_CORE___SELECT_PROJECT_OPTIONS__HPP
User-defined methods of the data storage class.
User-defined methods of the data storage class.
User-defined methods of the data storage class.
CGBDocument.
Definition: document.hpp:113
CProjectService - a service providing API for operations with Workspaces and Projects.
CProjectSelectOptions - describes how new Project Items shall be added to a workspace.
map< TLoaderRef, TItems > TData
void SetNewProjectName(const string &newProjectName)
CRef< objects::CLoaderDescriptor > TLoaderRef
objects::CGBProjectHandle::TId TProjectId
CRef< objects::CProjectItem > TItemRef
vector< TLoaderRef > TLoaders
CUniqueLabelGenerator Modifies the given label so that it becomes unique in the given set of labels b...
Include a standard set of the NCBI C++ Toolkit most basic headers.
char data[12]
Definition: iconv.c:80
#define END_NCBI_SCOPE
End previously defined NCBI scope.
Definition: ncbistl.hpp:103
#define BEGIN_NCBI_SCOPE
Define ncbi namespace.
Definition: ncbistl.hpp:100
#define kEmptyStr
Definition: ncbistr.hpp:123
#define NCBI_GUICORE_EXPORT
Definition: gui_export.h:508
Defines to provide correct exporting from DLLs in Windows.
Modified on Sun Apr 14 05:25:12 2024 by modify_doxy.py rev. 669887