KiCad PCB EDA Suite
ws_proxy_undo_item.h
Go to the documentation of this file.
1 /*
2  * This program source code file is part of KICAD, a free EDA CAD application.
3  *
4  * Copyright (C) 2019 CERN
5  * Copyright (C) 2019 Kicad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef WS_PROXY_UNDO_ITEM_H
26 #define WS_PROXY_UNDO_ITEM_H
27 
28 #include <base_struct.h>
29 #include <title_block.h>
30 #include <page_info.h>
31 
32 
34 {
35 public:
36  WS_PROXY_UNDO_ITEM( const EDA_DRAW_FRAME* aFrame );
37 
38  /*
39  * Restores the saved worksheet layout to the global worksheet record, and the saved
40  * page info and title blocks to the given frame. The WS_DRAW_ITEMs are rehydrated
41  * and installed in aView if it is not null (ie: if we're in the PageLayout Editor).
42  */
43  void Restore( EDA_DRAW_FRAME* aFrame, KIGFX::VIEW* aView = nullptr );
44 
45 #if defined(DEBUG)
46  void Show( int x, std::ostream& st ) const override { }
48 #endif
49 
50  wxString GetClass() const override
51  {
52  return wxT( "WS_PROXY_UNDO_ITEM" );
53  }
54 
55 protected:
61 };
62 
63 #endif /* WS_PROXY_UNDO_ITEM_H */
void Restore(EDA_DRAW_FRAME *aFrame, KIGFX::VIEW *aView=nullptr)
The base class for create windows for drawing purpose.
Class TITLE_BLOCK holds the information shown in the lower right corner of a plot,...
Definition: title_block.h:40
WS_PROXY_UNDO_ITEM(const EDA_DRAW_FRAME *aFrame)
Class PAGE_INFO describes the page size and margins of a paper page on which to eventually print or p...
Definition: page_info.h:54
wxString GetClass() const override
Function GetClass returns the class name.
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:163
Class VIEW.
Definition: view.h:61