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

Go to the SVN repository for this file.

1 #ifndef GUI_WIDGETS_WX___UI_TOOL_WITH_GUI__HPP
2 #define GUI_WIDGETS_WX___UI_TOOL_WITH_GUI__HPP
3 
4 /* $Id: ui_tool_with_gui.hpp 25706 2012-04-25 00:21:04Z voronov $
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
30  *
31  * File Description:
32  *
33  */
34 
35 #include <corelib/ncbistd.hpp>
36 
37 class wxWindow;
38 
40 
41 class CMenuItem;
42 
43 ////////////////////////////////////////////////////////////////////////////////
44 /// IUIToolWithGUI - represents a method that can be integrated in GUI.
46 {
47 public:
48  virtual ~IUIToolWithGUI() {}
49 
50  /// Returns a pointer to the submenu. If the pointer is not NULL, then this
51  /// submenu is integrated into the application's menu. If method is derived
52  /// from CCommandTarget it will recieve command events.
53  virtual const CMenuItem* GetMenu() = 0;
54 
55  /// returns true if the method supports properties dialog
56  virtual bool HasPropertiesPanel() const = 0;
57 
58  /// This a factory method that shall produce a CPropertiesPanel
59  /// representing properties of the method; the panel Apply() must take care
60  /// of appying changes to the method.
61  virtual wxWindow* CreatePropertiesPanel(wxWindow* parent) = 0;
62 };
63 
64 
66 
67 #endif // GUI_WIDGETS_WX___UI_TOOL_WITH_GUI__HPP
CMenuItem - represents a menu items in IMenu-style menus.
Definition: menu_item.hpp:53
IUIToolWithGUI - represents a method that can be integrated in GUI.
Definition: ui_tool.hpp:102
virtual bool HasPropertiesPanel() const =0
returns true if the method supports properties dialog
virtual ~IUIToolWithGUI()
virtual wxWindow * CreatePropertiesPanel(wxWindow *parent)=0
This a factory method that shall produce a CPropertiesPanel representing properties of the method; th...
virtual const CMenuItem * GetMenu()=0
Returns a pointer to the submenu.
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_WX_EXPORT
Definition: gui_export.h:543
Modified on Sun Jun 16 04:33:08 2024 by modify_doxy.py rev. 669887