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

Go to the SVN repository for this file.

1 #ifndef GUI_UTILS__REPORT_DIALOG__HPP
2 #define GUI_UTILS__REPORT_DIALOG__HPP
3 /* $Id: report_dialog.hpp 43155 2019-05-22 17:29:04Z asztalos $
4  * ===========================================================================
5  *
6  * PUBLIC DOMAIN NOTICE
7  * National Center for Biotechnology Information
8  *
9  * This software/database is a "United States Government Work" under the
10  * terms of the United States Copyright Act. It was written as part of
11  * the author's official duties as a United States Government employee and
12  * thus cannot be copyrighted. This software/database is freely available
13  * to the public for use. The National Library of Medicine and the U.S.
14  * Government have not placed any restriction on its use or reproduction.
15  *
16  * Although all reasonable efforts have been taken to ensure the accuracy
17  * and reliability of the software and data, the NLM and the U.S.
18  * Government do not and cannot warrant the performance or results that
19  * may be obtained by using this software or data. The NLM and the U.S.
20  * Government disclaim all warranties, express or implied, including
21  * warranties of performance, merchantability or fitness for any particular
22  * purpose.
23  *
24  * Please cite the author in any work or product based on this material.
25  *
26  * ===========================================================================
27  *
28  * Authors: Andrea Asztalos
29  */
30 
31 
32 #include <corelib/ncbistd.hpp>
33 #include <gui/gui_export.h>
34 #include <wx/dialog.h>
35 
37 
39 {
40 public:
41  /// Report opening events in dialogs used in the editing package
42  virtual bool Show(bool show = 1);
43 };
44 
45 
46 namespace NEditingStats
47 {
48  /// Report opening & accepting events in the editing package
49  void NCBI_GUIWIDGETS_DATA_EXPORT ReportUsage(const wxString& dialog_name);
50  /// Report usage of the submission wizard dialog
51  void NCBI_GUIWIDGETS_DATA_EXPORT ReportSubWizardUsage(const string& action_name);
52 }
53 
54 namespace NMacroStats
55 {
56  /// Report events in the macro_flow_editor and in the macro_editor
57  void NCBI_GUIWIDGETS_DATA_EXPORT ReportUsage(const wxString& dialog_name, const string& action_name);
58  /// Report when a macro is executed
60  /// Save macro created by the editor
61  void NCBI_GUIWIDGETS_DATA_EXPORT SaveScriptCreated(const string& macro);
62  /// Save macro obtained from the library
63  void NCBI_GUIWIDGETS_DATA_EXPORT SaveScriptFromLibrary(const string& macro);
64  /// Save macro to a file
65  void SaveScriptToFile(const string& macro, const string& filename);
66  /// Report attempt to update a local macro script
67  void NCBI_GUIWIDGETS_DATA_EXPORT ReportMacroToBeUpdated(const string& username, const string& filename, const string& action);
68 }
69 
71 
72 #endif
73  // GUI_UTILS__REPORT_DIALOG__HPP
Include a standard set of the NCBI C++ Toolkit most basic headers.
#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_GUIWIDGETS_DATA_EXPORT
Definition: gui_export.h:524
Defines to provide correct exporting from DLLs in Windows.
void ReportUsage(const wxString &dialog_name)
Report opening & accepting events in the editing package.
void ReportSubWizardUsage(const string &action_name)
Report usage of the submission wizard dialog.
void SaveScriptFromLibrary(const string &macro)
Save macro obtained from the library.
void ReportUsage(const wxString &dialog_name, const string &action_name)
Report events in the macro_flow_editor and in the macro_editor.
void SaveScriptCreated(const string &macro)
Save macro created by the editor.
void ReportMacroToBeUpdated(const string &username, const string &filename, const string &action)
Report attempt to update a local macro script.
void SaveScriptToFile(const string &macro, const string &filename)
Save macro to a file.
void ReportMacroExecution()
Report when a macro is executed.
Modified on Fri Jan 05 07:25:08 2024 by modify_doxy.py rev. 669887