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

Go to the SVN repository for this file.

1 #ifndef GUI_WIDGETS_EDIT___EDIT_OBJECT__HPP
2 #define GUI_WIDGETS_EDIT___EDIT_OBJECT__HPP
3 
4 /* $Id: edit_object.hpp 38357 2017-04-27 20:57:00Z filippov $
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/ncbiobj.hpp>
41 
42 class wxWindow;
43 
45 
46 class IEditCommand;
47 
48 /// GUI editing interface
49 ///
50 /// Implementations of this interface needs to register with CInterfaceRegistry
51 /// (Example: edit_object_seq_feat.cpp implements CEditObjectSeq_feat for CSeq_feat)
52 /// Declarations if objects used in Interface Registry are in file interface_registry.hpp
53 ///
54 /// When we want to use the interface and we have C++Toolkit object and CScope we
55 /// request interface via CreateObjectInterface<IEditObject>( TConstScopedObject obj, NULL).
56 /// (Example: CProjectView::OnEditSelection(), file project_view_impl.cpp).
57 /// If the interface is registered for this C++Toolkit class we get it and use it.
58 ///
59 /// @sa IEditCommand, IUndoManager, CInterfaceRegistry
60 ///
61 ///
63 {
64 public:
65  virtual ~IEditObject() {}
66 
67  /// creates a child (not top level) windows that can contain whatever
68  /// controls/subwindows etc. needed to edit an object.
69  /// This window is placed in a placeholder of Edit Object Dialog (top level window).
70  /// In the future we can present this window somewhere else (GBench view for example).
71  ///
72  virtual wxWindow* CreateWindow(wxWindow* parent) = 0;
73 
74  /// After placing the window in the Edit Object Dialog ShowModal() method of the dialog
75  /// is called. If OK button is called the second method of IEditObject dialog is called
76  /// which returns object derived from IEditCommand.
77  /// This object implements actual modifications of original object in the
78  /// Project/Document via Execute() method.
79  virtual IEditCommand* GetEditCommand() = 0;
80  virtual bool CanClose() {return true;}
81 };
82 
84 
85 #endif // GUI_WIDGETS_EDIT___EDIT_OBJECT__HPP
Interface (functor) for object editing.
GUI editing interface.
Definition: edit_object.hpp:63
virtual IEditCommand * GetEditCommand()=0
After placing the window in the Edit Object Dialog ShowModal() method of the dialog is called.
virtual wxWindow * CreateWindow(wxWindow *parent)=0
creates a child (not top level) windows that can contain whatever controls/subwindows etc.
virtual ~IEditObject()
Definition: edit_object.hpp:65
virtual bool CanClose()
Definition: edit_object.hpp: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
Portable reference counted smart and weak pointers using CWeakRef, CRef, CObject and CObjectEx.
Modified on Sat Mar 02 10:56:37 2024 by modify_doxy.py rev. 669887