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

Go to the SVN repository for this file.

1 #ifndef GUI_CORE___UI_EXPORT_TOOL__HPP
2 #define GUI_CORE___UI_EXPORT_TOOL__HPP
3 
4 /* $Id: ui_export_tool.hpp 38593 2017-06-01 17:31:50Z evgeniev $
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  * File Description:
32  *
33  */
34 
35 #include <corelib/ncbistd.hpp>
36 
37 #include <gui/gui_export.h>
38 
39 #include <gui/objutils/objects.hpp>
40 
42 
44 
45 
46 ///////////////////////////////////////////////////////////////////////////////
47 /// IUIExporter is a IUIToolManager that represents an export tool.
48 ///
49 /// TODO - consider placing this interface in a separate file
51 {
52 public:
53  /// sets objects to be exported.
54  virtual void SetLocations(const TRelatedObjectsMap& /*input_map*/) = 0;
55  virtual void SetObjects(const TConstScopedObjects& input) = 0;
56  virtual void SetFileName(const string& /*filename*/) {}
57 };
58 
59 ///////////////////////////////////////////////////////////////////////////////
60 /// IViewFactory
61 ///
63 {
64 public:
65  virtual ~IExporterFactory() {}
66 
67  /// create and instance of the IUIExporter
68  virtual IUIExportTool* CreateInstance() const = 0;
69 
70  /// Check if exporter can handle the objects
71  virtual bool TestInputObjects(TConstScopedObjects& objects) const = 0;
72 };
73 
74 
75 ///////////////////////////////////////////////////////////////////////////////
76 /// This Extension Point allows to add exporter factories.
77 #define EXT_POINT__UI_EXPORTER_FACTORY "export_service::exporter_factory"
78 
80 
81 
82 #endif // GUI_CORE___UI_EXPORT_TOOL__HPP
IViewFactory.
virtual ~IExporterFactory()
virtual bool TestInputObjects(TConstScopedObjects &objects) const =0
Check if exporter can handle the objects.
virtual IUIExportTool * CreateInstance() const =0
create and instance of the IUIExporter
IUIExporter is a IUIToolManager that represents an export tool.
virtual void SetLocations(const TRelatedObjectsMap &)=0
sets objects to be exported.
virtual void SetFileName(const string &)
virtual void SetObjects(const TConstScopedObjects &input)=0
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
#define NCBI_GUICORE_EXPORT
Definition: gui_export.h:508
Defines to provide correct exporting from DLLs in Windows.
static int input()
Modified on Fri Sep 20 14:57:35 2024 by modify_doxy.py rev. 669887