Documentation fixes, patch 1179223 by Andreas Mohr
[wxWidgets.git] / samples / xrc / myframe.cpp
1 //-----------------------------------------------------------------------------
2 // Name: myframe.cpp
3 // Purpose: XML resources sample: A derived frame, called MyFrame
4 // Author: Robert O'Connor (rob@medicalmnemonics.com), Vaclav Slavik
5 // RCS-ID: $Id$
6 // Copyright: (c) Robert O'Connor and Vaclav Slavik
7 // Licence: wxWindows licence
8 //-----------------------------------------------------------------------------
9
10 //-----------------------------------------------------------------------------
11 // GCC implementation
12 //-----------------------------------------------------------------------------
13
14 #ifdef __GNUG__
15 #pragma implementation "myframe.h"
16 #endif
17
18 //-----------------------------------------------------------------------------
19 // Standard wxWidgets headers
20 //-----------------------------------------------------------------------------
21
22 // For compilers that support precompilation, includes "wx/wx.h".
23 #include "wx/wxprec.h"
24
25 #ifdef __BORLANDC__
26 #pragma hdrstop
27 #endif
28
29 // For all others, include the necessary headers (this file is usually all you
30 // need because it includes almost all "standard" wxWidgets headers)
31 #ifndef WX_PRECOMP
32 #include "wx/wx.h"
33 #endif
34
35 //-----------------------------------------------------------------------------
36 // Header of this .cpp file
37 //-----------------------------------------------------------------------------
38
39 #include "myframe.h"
40
41 //-----------------------------------------------------------------------------
42 // Remaining headers: Needed wx headers, then wx/contrib headers, then application headers
43 //-----------------------------------------------------------------------------
44
45 // Since setting an icon
46 #include "wx/image.h"
47
48 //-----------------------------------------------------------------------------
49
50 #include "wx/xrc/xmlres.h" // XRC XML resouces
51
52 //-----------------------------------------------------------------------------
53
54 // Our derived dialog for the derived dialog example.
55 #include "derivdlg.h"
56 // Our custom class, for the custom class example.
57 #include "custclas.h"
58 // For functions to manipulate our wxTreeCtrl and wxListCtrl
59 #include "wx/treectrl.h"
60 #include "wx/listctrl.h"
61
62 //-----------------------------------------------------------------------------
63 // Regular resources (the non-XRC kind).
64 //-----------------------------------------------------------------------------
65
66 // The application icon
67 // All non-MSW platforms use an xpm. MSW uses an .ico file
68 #if defined(__WXGTK__) || defined(__WXX11__) || defined(__WXMOTIF__) || defined(__WXMAC__) || defined(__WXMGL__)
69 #include "rc/appicon.xpm"
70 #endif
71
72 //-----------------------------------------------------------------------------
73 // Event table: connect the events to the handler functions to process them
74 //-----------------------------------------------------------------------------
75
76 // The event tables connect the wxWidgets events with the functions (event
77 // handlers) which process them. It can be also done at run-time, but for the
78 // simple menu events like this the static method is much simpler.
79 // The reason why the menuitems and tools are given the same name in the
80 // XRC file, is that both a tool (a toolbar item) and a menuitem are designed
81 // to fire the same kind of event (an EVT_MENU) and thus I give them the same
82 // ID name to help new users emphasize this point which is often overlooked
83 // when starting out with wxWidgets.
84 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
85 EVT_MENU(XRCID("exit_tool_or_menuitem"), MyFrame::OnExitToolOrMenuCommand)
86 EVT_MENU(XRCID("non_derived_dialog_tool_or_menuitem"), MyFrame::OnNonDerivedDialogToolOrMenuCommand)
87 EVT_MENU(XRCID("derived_tool_or_menuitem"), MyFrame::OnDerivedDialogToolOrMenuCommand)
88 EVT_MENU(XRCID("controls_tool_or_menuitem"), MyFrame::OnControlsToolOrMenuCommand)
89 EVT_MENU(XRCID("uncentered_tool_or_menuitem"), MyFrame::OnUncenteredToolOrMenuCommand)
90 EVT_MENU(XRCID("custom_class_tool_or_menuitem"), MyFrame::OnCustomClassToolOrMenuCommand)
91 EVT_MENU(XRCID("platform_property_tool_or_menuitem"), MyFrame::OnPlatformPropertyToolOrMenuCommand)
92 EVT_MENU(XRCID("art_provider_tool_or_menuitem"), MyFrame::OnArtProviderToolOrMenuCommand)
93 EVT_MENU(XRCID("variable_expansion_tool_or_menuitem"), MyFrame::OnVariableExpansionToolOrMenuCommand)
94 EVT_MENU(XRCID("about_tool_or_menuitem"), MyFrame::OnAboutToolOrMenuCommand)
95 END_EVENT_TABLE()
96
97 //-----------------------------------------------------------------------------
98 // Public methods
99 //-----------------------------------------------------------------------------
100
101 // Constructor
102 MyFrame::MyFrame(wxWindow* parent)
103 {
104 // Load up this frame from XRC. [Note, instead of making a class's
105 // constructor take a wxWindow* parent with a default value of NULL,
106 // we could have just had designed MyFrame class with an empty
107 // constructor and then written here:
108 // wxXmlResource::Get()->LoadFrame(this, (wxWindow* )NULL, "main_frame");
109 // since this frame will always be the top window, and thus parentless.
110 // However, the current approach has source code that can be recycled
111 // for other frames that aren't the top level window.]
112 wxXmlResource::Get()->LoadFrame(this, parent, wxT("main_frame"));
113
114 // Set the icon for the frame.
115 SetIcon(wxICON(appicon));
116
117 // Load the menubar from XRC and set this frame's menubar to it.
118 SetMenuBar(wxXmlResource::Get()->LoadMenuBar(wxT("main_menu")));
119 // Load the toolbar from XRC and set this frame's toolbar to it.
120 // NOTE: For toolbars you currently should do it exactly like this.
121 // With toolbars, you currently can't create one, and set it later. It
122 // needs to be all in one step.
123 SetToolBar(wxXmlResource::Get()->LoadToolBar(this, wxT("main_toolbar")));
124
125 #if wxUSE_STATUSBAR
126 // Give the frame an optional statusbar. The '1' just means one field.
127 // A gripsizer will automatically get put on into the corner, if that
128 // is the normal OS behaviour for frames on that platform. Helptext
129 // for menu items and toolbar tools will automatically get displayed
130 // here.
131 CreateStatusBar( 1 );
132 #endif // wxUSE_STATUSBAR
133 }
134
135 //-----------------------------------------------------------------------------
136 // Private methods
137 //-----------------------------------------------------------------------------
138
139 void MyFrame::OnExitToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
140 {
141 // true is to force the frame to close.
142 Close(true);
143 }
144
145
146 void MyFrame::OnNonDerivedDialogToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
147 {
148 wxDialog dlg;
149 // "non_derived_dialog" is the name of the wxDialog XRC node that should
150 // be loaded.
151 wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("non_derived_dialog"));
152 dlg.ShowModal();
153
154 }
155
156
157 void MyFrame::OnDerivedDialogToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
158 {
159 // Make an instance of our derived dialog, passing it "this" window
160 // (the main frame) as the parent of the dialog. This allows the dialog
161 // to be destructed automatically when the parent is destroyed.
162 PreferencesDialog preferencesDialog(this);
163 // Show the instance of the dialog, modally.
164 preferencesDialog.ShowModal();
165 }
166
167
168 void MyFrame::OnControlsToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
169 {
170 wxDialog dlg;
171 wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("controls_dialog"));
172
173 #if wxUSE_LISTCTRL
174 // There is no data in the listctrl. This will add some columns
175 // and some data. You don't need to use any pointers
176 // at all to manipulate the controls, just simply use the XRCCTL(...) macros.
177 // "controls_treectrl" is the name of this control in the XRC.
178 // (1) Insert a column, with the column header of "Name"
179 // (The '_' function around "Name" marks this string as one to translate).
180 XRCCTRL(dlg, "controls_listctrl", wxListCtrl)->InsertColumn( 0,
181 _("Name"),
182 wxLIST_FORMAT_LEFT,
183 ( 200 )
184 );
185 // (2) Insert some items into the listctrl
186 XRCCTRL(dlg, "controls_listctrl", wxListCtrl)->InsertItem(0,wxT("Todd Hope"));
187 XRCCTRL(dlg, "controls_listctrl", wxListCtrl)->InsertItem(1,wxT("Kim Wynd"));
188 XRCCTRL(dlg, "controls_listctrl", wxListCtrl)->InsertItem(2,wxT("Leon Li"));
189 #endif
190
191 #if wxUSE_TREECTRL
192 // There is no data in the tree ctrl. These lines will add some.
193 // (1) Instead of having to write out
194 // XRCCTRL(dlg, "controls_treectrl", wxTreeCtrl)->SomeFunction()
195 // each time (which is also OK), this example code will shown how
196 // to make a pointer to the XRC control, so we can use
197 // treectrl->SomeFunction() as a short cut. This is useful if you
198 // will be referring to this control often in the code.
199 wxTreeCtrl* treectrl = XRCCTRL(dlg, "controls_treectrl", wxTreeCtrl);
200 // (2) Add a root node
201 treectrl->AddRoot(_("Godfather"));
202 // (3)Append some items to the root node.
203 treectrl->AppendItem(treectrl->GetRootItem(), _("Evil henchman 1"));
204 treectrl->AppendItem(treectrl->GetRootItem(), _("Evil henchman 2"));
205 treectrl->AppendItem(treectrl->GetRootItem(), _("Evil accountant"));
206 #endif
207
208 // All done. Show the dialog.
209 dlg.ShowModal();
210 }
211
212
213 void MyFrame::OnUncenteredToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
214 {
215 wxDialog dlg;
216 wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("uncentered_dialog"));
217 dlg.ShowModal();
218 }
219
220
221 void MyFrame::OnCustomClassToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
222 {
223 wxDialog dlg;
224 wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("custom_class_dialog"));
225
226 // Make an instance of our new custom class.
227 MyResizableListCtrl* a_myResizableListCtrl = new MyResizableListCtrl(&dlg,
228 wxID_ANY,
229 wxDefaultPosition,
230 wxDefaultSize,
231 wxLC_REPORT,
232 wxDefaultValidator);
233
234 // "custom_control_placeholder" is the name of the "unknown" tag in the
235 // custctrl.xrc XRC file.
236 wxXmlResource::Get()->AttachUnknownControl(wxT("custom_control_placeholder"),
237 a_myResizableListCtrl);
238 dlg.ShowModal();
239 }
240
241
242 void MyFrame::OnPlatformPropertyToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
243 {
244 wxDialog dlg;
245 wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("platform_property_dialog"));
246 dlg.ShowModal();
247 }
248
249
250 void MyFrame::OnArtProviderToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
251 {
252 wxDialog dlg;
253 wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("art_provider_dialog"));
254 dlg.ShowModal();
255 }
256
257
258 void MyFrame::OnVariableExpansionToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
259 {
260 wxDialog dlg;
261 wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("variable_expansion_dialog"));
262 dlg.ShowModal();
263 }
264
265
266 void MyFrame::OnAboutToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
267 {
268 wxString msg;
269 msg.Printf( _T("This is the about dialog of XML resources demo.\n")
270 _T("Welcome to %s"), wxVERSION_STRING);
271
272 wxMessageBox(msg, _("About XML resources demo"), wxOK | wxICON_INFORMATION, this);
273 }