]>
Commit | Line | Data |
---|---|---|
1 | ///////////////////////////////////////////////////////////////////////////// | |
2 | // Name: docmdi.h | |
3 | // Purpose: interface of wxDocMDIParentFrame and wxDocMDIChildFrame | |
4 | // Author: wxWidgets team | |
5 | // Licence: wxWindows licence | |
6 | ///////////////////////////////////////////////////////////////////////////// | |
7 | ||
8 | /** | |
9 | @class wxDocMDIParentFrame | |
10 | ||
11 | The wxDocMDIParentFrame class provides a default top-level frame for | |
12 | applications using the document/view framework. This class can only be used | |
13 | for MDI parent frames. | |
14 | ||
15 | It cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate | |
16 | classes. | |
17 | ||
18 | @library{wxcore} | |
19 | @category{docview} | |
20 | ||
21 | @see @ref overview_docview, @ref page_samples_docview, wxMDIParentFrame | |
22 | */ | |
23 | class wxDocMDIParentFrame : public wxMDIParentFrame | |
24 | { | |
25 | public: | |
26 | //@{ | |
27 | /** | |
28 | Constructor. | |
29 | */ | |
30 | wxDocMDIParentFrame(); | |
31 | wxDocMDIParentFrame(wxDocManager* manager, wxFrame* parent, | |
32 | wxWindowID id, | |
33 | const wxString& title, | |
34 | const wxPoint& pos = wxDefaultPosition, | |
35 | const wxSize& size = wxDefaultSize, | |
36 | long style = wxDEFAULT_FRAME_STYLE, | |
37 | const wxString& name = wxFrameNameStr); | |
38 | //@} | |
39 | ||
40 | /** | |
41 | Destructor. | |
42 | */ | |
43 | virtual ~wxDocMDIParentFrame(); | |
44 | ||
45 | /** | |
46 | Creates the window. | |
47 | */ | |
48 | bool Create(wxDocManager* manager, wxFrame* parent, | |
49 | wxWindowID id, const wxString& title, | |
50 | const wxPoint& pos = wxDefaultPosition, | |
51 | const wxSize& size = wxDefaultSize, | |
52 | long style = wxDEFAULT_FRAME_STYLE, | |
53 | const wxString& name = wxFrameNameStr); | |
54 | }; | |
55 | ||
56 | ||
57 | ||
58 | /** | |
59 | @class wxDocMDIChildFrame | |
60 | ||
61 | The wxDocMDIChildFrame class provides a default frame for displaying | |
62 | documents on separate windows. This class can only be used for MDI child | |
63 | frames. | |
64 | ||
65 | The class is part of the document/view framework supported by wxWidgets, | |
66 | and cooperates with the wxView, wxDocument, wxDocManager and wxDocTemplate | |
67 | classes. | |
68 | ||
69 | @library{wxcore} | |
70 | @category{docview} | |
71 | ||
72 | @see @ref overview_docview, @ref page_samples_docview, wxMDIChildFrame | |
73 | */ | |
74 | class wxDocMDIChildFrame : public wxMDIChildFrame | |
75 | { | |
76 | public: | |
77 | /** | |
78 | Constructor. | |
79 | */ | |
80 | wxDocMDIChildFrame(wxDocument* doc, wxView* view, | |
81 | wxMDIParentFrame* parent, wxWindowID id, | |
82 | const wxString& title, | |
83 | const wxPoint& pos = wxDefaultPosition, | |
84 | const wxSize& size = wxDefaultSize, | |
85 | long style = wxDEFAULT_FRAME_STYLE, | |
86 | const wxString& name = wxFrameNameStr); | |
87 | ||
88 | /** | |
89 | Destructor. | |
90 | */ | |
91 | virtual ~wxDocMDIChildFrame(); | |
92 | ||
93 | /** | |
94 | Returns the document associated with this frame. | |
95 | */ | |
96 | wxDocument* GetDocument() const; | |
97 | ||
98 | /** | |
99 | Returns the view associated with this frame. | |
100 | */ | |
101 | wxView* GetView() const; | |
102 | ||
103 | /** | |
104 | Sets the document for this frame. | |
105 | */ | |
106 | void SetDocument(wxDocument* doc); | |
107 | ||
108 | /** | |
109 | Sets the view for this frame. | |
110 | */ | |
111 | void SetView(wxView* view); | |
112 | }; | |
113 |