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 // Standard wxWidgets headers
  12 //-----------------------------------------------------------------------------
  13
  14 // For compilers that support precompilation, includes "wx/wx.h".
  15 #include "wx/wxprec.h"
  16
  17 #ifdef __BORLANDC__
  18     #pragma hdrstop
  19 #endif
  20
  21 // For all others, include the necessary headers (this file is usually all you
  22 // need because it includes almost all "standard" wxWidgets headers)
  23 #ifndef WX_PRECOMP
  24     #include "wx/wx.h"
  25 #endif
  26
  27 #include "wx/sysopt.h"
  28
  29 //-----------------------------------------------------------------------------
  30 // Header of this .cpp file
  31 //-----------------------------------------------------------------------------
  32
  33 #include "myframe.h"
  34
  35 //-----------------------------------------------------------------------------
  36 // Remaining headers: Needed wx headers, then wx/contrib headers, then application headers
  37 //-----------------------------------------------------------------------------
  38
  39 // Since setting an icon
  40 #include "wx/image.h"
  41
  42 //-----------------------------------------------------------------------------
  43
  44 #include "wx/xrc/xmlres.h"              // XRC XML resouces
  45
  46 //-----------------------------------------------------------------------------
  47
  48 // Our derived dialog for the derived dialog example.
  49 #include "derivdlg.h"
  50 // Our custom class, for the custom class example.
  51 #include "custclas.h"
  52 // For functions to manipulate our wxTreeCtrl and wxListCtrl
  53 #include "wx/treectrl.h"
  54 #include "wx/listctrl.h"
  55
  56 //-----------------------------------------------------------------------------
  57 // Regular resources (the non-XRC kind).
  58 //-----------------------------------------------------------------------------
  59
  60 // The application icon
  61 // All non-MSW platforms use an xpm. MSW uses an .ico file
  62 #if defined(__WXGTK__) || defined(__WXX11__) || defined(__WXMOTIF__) || defined(__WXMAC__) || defined(__WXMGL__)
  63     #include "rc/appicon.xpm"
  64 #endif
  65
  66 //-----------------------------------------------------------------------------
  67 // Event table: connect the events to the handler functions to process them
  68 //-----------------------------------------------------------------------------
  69
  70 // The event tables connect the wxWidgets events with the functions (event
  71 // handlers) which process them. It can be also done at run-time, but for the
  72 // simple menu events like this the static method is much simpler.
  73 // The reason why the menuitems and tools are given the same name in the
  74 // XRC file, is that both a tool (a toolbar item) and a menuitem are designed
  75 // to fire the same kind of event (an EVT_MENU) and thus I give them the same
  76 // ID name to help new users emphasize this point which is often overlooked
  77 // when starting out with wxWidgets.
  78 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
  79     EVT_MENU(XRCID("unload_resource_menuitem"), MyFrame::OnUnloadResourceMenuCommand)
  80     EVT_MENU(XRCID("reload_resource_menuitem"), MyFrame::OnReloadResourceMenuCommand)
  81     EVT_MENU(wxID_EXIT,  MyFrame::OnExitToolOrMenuCommand)
  82     EVT_MENU(XRCID("non_derived_dialog_tool_or_menuitem"), MyFrame::OnNonDerivedDialogToolOrMenuCommand)
  83     EVT_MENU(XRCID("derived_tool_or_menuitem"), MyFrame::OnDerivedDialogToolOrMenuCommand)
  84     EVT_MENU(XRCID("controls_tool_or_menuitem"), MyFrame::OnControlsToolOrMenuCommand)
  85     EVT_MENU(XRCID("uncentered_tool_or_menuitem"), MyFrame::OnUncenteredToolOrMenuCommand)
  86     EVT_MENU(XRCID("custom_class_tool_or_menuitem"), MyFrame::OnCustomClassToolOrMenuCommand)
  87     EVT_MENU(XRCID("platform_property_tool_or_menuitem"), MyFrame::OnPlatformPropertyToolOrMenuCommand)
  88     EVT_MENU(XRCID("art_provider_tool_or_menuitem"), MyFrame::OnArtProviderToolOrMenuCommand)
  89     EVT_MENU(XRCID("variable_expansion_tool_or_menuitem"), MyFrame::OnVariableExpansionToolOrMenuCommand)
  90     EVT_MENU(wxID_ABOUT, MyFrame::OnAboutToolOrMenuCommand)
  91 END_EVENT_TABLE()
  92
  93 //-----------------------------------------------------------------------------
  94 // Public methods
  95 //-----------------------------------------------------------------------------
  96
  97 // Constructor
  98 MyFrame::MyFrame(wxWindow* parent)
  99 {
 100     // Load up this frame from XRC. [Note, instead of making a class's
 101     // constructor take a wxWindow* parent with a default value of NULL,
 102     // we could have just had designed MyFrame class with an empty
 103     // constructor and then written here:
 104     // wxXmlResource::Get()->LoadFrame(this, (wxWindow* )NULL, "main_frame");
 105     // since this frame will always be the top window, and thus parentless.
 106     // However, the current approach has source code that can be recycled
 107     // for other frames that aren't the top level window.]
 108     wxXmlResource::Get()->LoadFrame(this, parent, wxT("main_frame"));
 109
 110     // Set the icon for the frame.
 111     SetIcon(wxICON(appicon));
 112
 113     // Load the menubar from XRC and set this frame's menubar to it.
 114     SetMenuBar(wxXmlResource::Get()->LoadMenuBar(wxT("main_menu")));
 115     // Load the toolbar from XRC and set this frame's toolbar to it.
 116     // NOTE: For toolbars you currently should do it exactly like this.
 117     // With toolbars, you currently can't create one, and set it later. It
 118     // needs to be all in one step.
 119     wxSystemOptions::SetOption ( wxT("msw.remap"), 0 );
 120     SetToolBar(wxXmlResource::Get()->LoadToolBar(this, wxT("main_toolbar")));
 121
 122 #if wxUSE_STATUSBAR
 123     // Give the frame an optional statusbar. The '1' just means one field.
 124     // A gripsizer will automatically get put on into the corner, if that
 125     // is the normal OS behaviour for frames on that platform. Helptext
 126     // for menu items and toolbar tools will automatically get displayed
 127     // here.
 128     CreateStatusBar( 1 );
 129 #endif // wxUSE_STATUSBAR
 130 }
 131
 132 //-----------------------------------------------------------------------------
 133 // Private methods
 134 //-----------------------------------------------------------------------------
 135
 136 void MyFrame::OnUnloadResourceMenuCommand(wxCommandEvent& WXUNUSED(event))
 137 {
 138     if ( wxXmlResource::Get()->Unload(wxT("rc/basicdlg.xrc")) )
 139         wxLogMessage(_T("Basic dialog resource has now been unloaded, you ")
 140                      _T("won't be able to use it before loading it again"));
 141     else
 142         wxLogWarning(_T("Failed to unload basic dialog resource"));
 143 }
 144
 145 void MyFrame::OnReloadResourceMenuCommand(wxCommandEvent& WXUNUSED(event))
 146 {
 147     if ( wxXmlResource::Get()->Load(wxT("rc/basicdlg.xrc")) )
 148         wxLogStatus(_T("Basic dialog resource has been loaded."));
 149     else
 150         wxLogError(_T("Failed to load basic dialog resource"));
 151 }
 152
 153 void MyFrame::OnExitToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 154 {
 155     // true is to force the frame to close.
 156     Close(true);
 157 }
 158
 159
 160 void MyFrame::OnNonDerivedDialogToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 161 {
 162     wxDialog dlg;
 163     // "non_derived_dialog" is the name of the wxDialog XRC node that should
 164     // be loaded.
 165     if ( wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("non_derived_dialog")) )
 166         dlg.ShowModal();
 167 }
 168
 169
 170 void MyFrame::OnDerivedDialogToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 171 {
 172     // Make an instance of our derived dialog, passing it "this" window
 173     // (the main frame) as the parent of the dialog. This allows the dialog
 174     // to be destructed automatically when the parent is destroyed.
 175     PreferencesDialog preferencesDialog(this);
 176     // Show the instance of the dialog, modally.
 177     preferencesDialog.ShowModal();
 178 }
 179
 180 void MyFrame::OnAnimationCtrlPlay(wxCommandEvent& event)
 181 {
 182 #if wxUSE_ANIMATIONCTRL
 183     // get the pointers we need
 184     wxButton *btn = wxDynamicCast(event.GetEventObject(), wxButton);
 185     if (!btn || !btn->GetParent()) return;
 186
 187     wxWindow *win = btn->GetParent();
 188     wxAnimationCtrl *ctrl = XRCCTRL(*win, "controls_animation_ctrl", wxAnimationCtrl);
 189     if (ctrl->IsPlaying())
 190     {
 191         ctrl->Stop();
 192         btn->SetLabel(wxT("Play"));
 193     }
 194     else
 195     {
 196         if (ctrl->Play())
 197             btn->SetLabel(wxT("Stop"));
 198         else
 199             wxLogError(wxT("Cannot play the animation..."));
 200     }
 201 #endif
 202 }
 203
 204 void MyFrame::OnControlsToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 205 {
 206     wxDialog dlg;
 207     wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("controls_dialog"));
 208
 209 #if wxUSE_LISTCTRL
 210     // The resource file specifies the columns of the control as they are
 211     // typically static while the items themselves are added from here as
 212     // usually they are not static (but if they are, they can be defined in the
 213     // resources too, see the two other list controls definitions in
 214     // controls.xrc)
 215
 216     // Insert some items into the listctrl: notice that we can access it using
 217     // XRCCTRL
 218     wxListCtrl * const list = XRCCTRL(dlg, "controls_listctrl", wxListCtrl);
 219
 220     list->InsertItem(0, "Athos");   list->SetItem(0, 1, "90");
 221     list->InsertItem(1, "Porthos"); list->SetItem(1, 1, "120");
 222     list->InsertItem(2, "Aramis");  list->SetItem(2, 1, "80");
 223 #endif // wxUSE_LISTCTRL
 224
 225 #if wxUSE_TREECTRL
 226     // There is no data in the tree ctrl. These lines will add some.
 227     // (1) Instead of having to write out
 228     // XRCCTRL(dlg, "controls_treectrl", wxTreeCtrl)->SomeFunction()
 229     // each time (which is also OK), this example code will shown how
 230     // to make a pointer to the XRC control, so we can use
 231     // treectrl->SomeFunction() as a short cut. This is useful if you
 232     // will be referring to this control often in the code.
 233     wxTreeCtrl* treectrl = XRCCTRL(dlg, "controls_treectrl", wxTreeCtrl);
 234     // (2) Add a root node
 235     treectrl->AddRoot(_("Godfather"));
 236     // (3)Append some items to the root node.
 237     treectrl->AppendItem(treectrl->GetRootItem(), _("Evil henchman 1"));
 238     treectrl->AppendItem(treectrl->GetRootItem(), _("Evil henchman 2"));
 239     treectrl->AppendItem(treectrl->GetRootItem(), _("Evil accountant"));
 240 #endif
 241
 242 #if wxUSE_ANIMATIONCTRL
 243     // dynamically connect our event handler for the "clicked" event of the "play" button
 244     // in the animation ctrl page of our dialog
 245     dlg.Connect(XRCID("controls_animation_button_play"), wxEVT_COMMAND_BUTTON_CLICKED,
 246                 wxCommandEventHandler(MyFrame::OnAnimationCtrlPlay));
 247 #endif
 248
 249     // All done. Show the dialog.
 250     dlg.ShowModal();
 251 }
 252
 253
 254 void MyFrame::OnUncenteredToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 255 {
 256     wxDialog dlg;
 257     wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("uncentered_dialog"));
 258     dlg.ShowModal();
 259 }
 260
 261
 262 void MyFrame::OnCustomClassToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 263 {
 264     wxDialog dlg;
 265     wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("custom_class_dialog"));
 266
 267     // Make an instance of our new custom class.
 268     MyResizableListCtrl* a_myResizableListCtrl = new MyResizableListCtrl(&dlg,
 269                                                 wxID_ANY,
 270                                                 wxDefaultPosition,
 271                                                 wxDefaultSize,
 272                                                 wxLC_REPORT,
 273                                                 wxDefaultValidator);
 274
 275     // "custom_control_placeholder" is the name of the "unknown" tag in the
 276     // custctrl.xrc XRC file.
 277     wxXmlResource::Get()->AttachUnknownControl(wxT("custom_control_placeholder"),
 278                                                 a_myResizableListCtrl);
 279     dlg.ShowModal();
 280 }
 281
 282
 283 void MyFrame::OnPlatformPropertyToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 284 {
 285     wxDialog dlg;
 286     wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("platform_property_dialog"));
 287     dlg.ShowModal();
 288 }
 289
 290
 291 void MyFrame::OnArtProviderToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 292 {
 293     wxDialog dlg;
 294     wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("art_provider_dialog"));
 295     dlg.ShowModal();
 296 }
 297
 298
 299 void MyFrame::OnVariableExpansionToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 300 {
 301     wxDialog dlg;
 302     wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("variable_expansion_dialog"));
 303     dlg.ShowModal();
 304 }
 305
 306
 307 void MyFrame::OnAboutToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 308 {
 309     wxString msg;
 310     msg.Printf( _T("This is the about dialog of XML resources demo.\n")
 311                 _T("Welcome to %s"), wxVERSION_STRING);
 312
 313     wxMessageBox(msg, _("About XML resources demo"), wxOK | wxICON_INFORMATION, this);
 314 }