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(XRCID("exit_tool_or_menuitem"),  MyFrame::OnExitToolOrMenuCommand)
  82     EVT_MENU(XRCID("exit_tool_or_menuitem"),  MyFrame::OnExitToolOrMenuCommand)
  83     EVT_MENU(XRCID("non_derived_dialog_tool_or_menuitem"), MyFrame::OnNonDerivedDialogToolOrMenuCommand)
  84     EVT_MENU(XRCID("derived_tool_or_menuitem"), MyFrame::OnDerivedDialogToolOrMenuCommand)
  85     EVT_MENU(XRCID("controls_tool_or_menuitem"), MyFrame::OnControlsToolOrMenuCommand)
  86     EVT_MENU(XRCID("uncentered_tool_or_menuitem"), MyFrame::OnUncenteredToolOrMenuCommand)
  87     EVT_MENU(XRCID("custom_class_tool_or_menuitem"), MyFrame::OnCustomClassToolOrMenuCommand)
  88     EVT_MENU(XRCID("platform_property_tool_or_menuitem"), MyFrame::OnPlatformPropertyToolOrMenuCommand)
  89     EVT_MENU(XRCID("art_provider_tool_or_menuitem"), MyFrame::OnArtProviderToolOrMenuCommand)
  90     EVT_MENU(XRCID("variable_expansion_tool_or_menuitem"), MyFrame::OnVariableExpansionToolOrMenuCommand)
  91     EVT_MENU(XRCID("about_tool_or_menuitem"), MyFrame::OnAboutToolOrMenuCommand)
  92 END_EVENT_TABLE()
  93
  94 //-----------------------------------------------------------------------------
  95 // Public methods
  96 //-----------------------------------------------------------------------------
  97
  98 // Constructor
  99 MyFrame::MyFrame(wxWindow* parent)
 100 {
 101     // Load up this frame from XRC. [Note, instead of making a class's
 102     // constructor take a wxWindow* parent with a default value of NULL,
 103     // we could have just had designed MyFrame class with an empty
 104     // constructor and then written here:
 105     // wxXmlResource::Get()->LoadFrame(this, (wxWindow* )NULL, "main_frame");
 106     // since this frame will always be the top window, and thus parentless.
 107     // However, the current approach has source code that can be recycled
 108     // for other frames that aren't the top level window.]
 109     wxXmlResource::Get()->LoadFrame(this, parent, wxT("main_frame"));
 110
 111     // Set the icon for the frame.
 112     SetIcon(wxICON(appicon));
 113
 114     // Load the menubar from XRC and set this frame's menubar to it.
 115     SetMenuBar(wxXmlResource::Get()->LoadMenuBar(wxT("main_menu")));
 116     // Load the toolbar from XRC and set this frame's toolbar to it.
 117     // NOTE: For toolbars you currently should do it exactly like this.
 118     // With toolbars, you currently can't create one, and set it later. It
 119     // needs to be all in one step.
 120     wxSystemOptions::SetOption ( wxT("msw.remap"), 0 );
 121     SetToolBar(wxXmlResource::Get()->LoadToolBar(this, wxT("main_toolbar")));
 122
 123 #if wxUSE_STATUSBAR
 124     // Give the frame an optional statusbar. The '1' just means one field.
 125     // A gripsizer will automatically get put on into the corner, if that
 126     // is the normal OS behaviour for frames on that platform. Helptext
 127     // for menu items and toolbar tools will automatically get displayed
 128     // here.
 129     CreateStatusBar( 1 );
 130 #endif // wxUSE_STATUSBAR
 131 }
 132
 133 //-----------------------------------------------------------------------------
 134 // Private methods
 135 //-----------------------------------------------------------------------------
 136
 137 void MyFrame::OnUnloadResourceMenuCommand(wxCommandEvent& WXUNUSED(event))
 138 {
 139     if ( wxXmlResource::Get()->Unload(wxT("rc/basicdlg.xrc")) )
 140         wxLogMessage(_T("Basic dialog resource has now been unloaded, you ")
 141                      _T("won't be able to use it before loading it again"));
 142     else
 143         wxLogWarning(_T("Failed to unload basic dialog resource"));
 144 }
 145
 146 void MyFrame::OnReloadResourceMenuCommand(wxCommandEvent& WXUNUSED(event))
 147 {
 148     if ( wxXmlResource::Get()->Load(wxT("rc/basicdlg.xrc")) )
 149         wxLogStatus(_T("Basic dialog resource has been loaded."));
 150     else
 151         wxLogError(_T("Failed to load basic dialog resource"));
 152 }
 153
 154 void MyFrame::OnExitToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 155 {
 156     // true is to force the frame to close.
 157     Close(true);
 158 }
 159
 160
 161 void MyFrame::OnNonDerivedDialogToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 162 {
 163     wxDialog dlg;
 164     // "non_derived_dialog" is the name of the wxDialog XRC node that should
 165     // be loaded.
 166     if ( wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("non_derived_dialog")) )
 167         dlg.ShowModal();
 168 }
 169
 170
 171 void MyFrame::OnDerivedDialogToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 172 {
 173     // Make an instance of our derived dialog, passing it "this" window
 174     // (the main frame) as the parent of the dialog. This allows the dialog
 175     // to be destructed automatically when the parent is destroyed.
 176     PreferencesDialog preferencesDialog(this);
 177     // Show the instance of the dialog, modally.
 178     preferencesDialog.ShowModal();
 179 }
 180
 181 void MyFrame::OnAnimationCtrlPlay(wxCommandEvent& event)
 182 {
 183 #if wxUSE_ANIMATIONCTRL
 184     // get the pointers we need
 185     wxButton *btn = wxDynamicCast(event.GetEventObject(), wxButton);
 186     if (!btn || !btn->GetParent()) return;
 187
 188     wxWindow *win = btn->GetParent();
 189     wxAnimationCtrl *ctrl = XRCCTRL(*win, "controls_animation_ctrl", wxAnimationCtrl);
 190     if (ctrl->IsPlaying())
 191     {
 192         ctrl->Stop();
 193         btn->SetLabel(wxT("Play"));
 194     }
 195     else
 196     {
 197         if (ctrl->Play())
 198             btn->SetLabel(wxT("Stop"));
 199         else
 200             wxLogError(wxT("Cannot play the animation..."));
 201     }
 202 #endif
 203 }
 204
 205 void MyFrame::OnControlsToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 206 {
 207     wxDialog dlg;
 208     wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("controls_dialog"));
 209
 210 #if wxUSE_LISTCTRL
 211     // There is no data in the listctrl. This will add some columns
 212     // and some data. You don't need to use any pointers
 213     // at all to manipulate the controls, just simply use the XRCCTL(...) macros.
 214     // "controls_treectrl" is the name of this control in the XRC.
 215     // (1) Insert a column, with the column header of "Name"
 216     // (The '_' function around "Name" marks this string as one to translate).
 217     XRCCTRL(dlg, "controls_listctrl", wxListCtrl)->InsertColumn( 0,
 218                                                                  _("Name"),
 219                                                                  wxLIST_FORMAT_LEFT,
 220                                                                  ( 200 )
 221                                                                 );
 222     // (2) Insert some items into the listctrl
 223     XRCCTRL(dlg, "controls_listctrl", wxListCtrl)->InsertItem(0,wxT("Todd Hope"));
 224     XRCCTRL(dlg, "controls_listctrl", wxListCtrl)->InsertItem(1,wxT("Kim Wynd"));
 225     XRCCTRL(dlg, "controls_listctrl", wxListCtrl)->InsertItem(2,wxT("Leon Li"));
 226 #endif
 227
 228 #if wxUSE_TREECTRL
 229     // There is no data in the tree ctrl. These lines will add some.
 230     // (1) Instead of having to write out
 231     // XRCCTRL(dlg, "controls_treectrl", wxTreeCtrl)->SomeFunction()
 232     // each time (which is also OK), this example code will shown how
 233     // to make a pointer to the XRC control, so we can use
 234     // treectrl->SomeFunction() as a short cut. This is useful if you
 235     // will be referring to this control often in the code.
 236     wxTreeCtrl* treectrl = XRCCTRL(dlg, "controls_treectrl", wxTreeCtrl);
 237     // (2) Add a root node
 238     treectrl->AddRoot(_("Godfather"));
 239     // (3)Append some items to the root node.
 240     treectrl->AppendItem(treectrl->GetRootItem(), _("Evil henchman 1"));
 241     treectrl->AppendItem(treectrl->GetRootItem(), _("Evil henchman 2"));
 242     treectrl->AppendItem(treectrl->GetRootItem(), _("Evil accountant"));
 243 #endif
 244
 245 #if wxUSE_ANIMATIONCTRL
 246     // dynamically connect our event handler for the "clicked" event of the "play" button
 247     // in the animation ctrl page of our dialog
 248     dlg.Connect(XRCID("controls_animation_button_play"), wxEVT_COMMAND_BUTTON_CLICKED,
 249                 wxCommandEventHandler(MyFrame::OnAnimationCtrlPlay));
 250 #endif
 251
 252     // All done. Show the dialog.
 253     dlg.ShowModal();
 254 }
 255
 256
 257 void MyFrame::OnUncenteredToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 258 {
 259     wxDialog dlg;
 260     wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("uncentered_dialog"));
 261     dlg.ShowModal();
 262 }
 263
 264
 265 void MyFrame::OnCustomClassToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 266 {
 267     wxDialog dlg;
 268     wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("custom_class_dialog"));
 269
 270     // Make an instance of our new custom class.
 271     MyResizableListCtrl* a_myResizableListCtrl = new MyResizableListCtrl(&dlg,
 272                                                 wxID_ANY,
 273                                                 wxDefaultPosition,
 274                                                 wxDefaultSize,
 275                                                 wxLC_REPORT,
 276                                                 wxDefaultValidator);
 277
 278     // "custom_control_placeholder" is the name of the "unknown" tag in the
 279     // custctrl.xrc XRC file.
 280     wxXmlResource::Get()->AttachUnknownControl(wxT("custom_control_placeholder"),
 281                                                 a_myResizableListCtrl);
 282     dlg.ShowModal();
 283 }
 284
 285
 286 void MyFrame::OnPlatformPropertyToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 287 {
 288     wxDialog dlg;
 289     wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("platform_property_dialog"));
 290     dlg.ShowModal();
 291 }
 292
 293
 294 void MyFrame::OnArtProviderToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 295 {
 296     wxDialog dlg;
 297     wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("art_provider_dialog"));
 298     dlg.ShowModal();
 299 }
 300
 301
 302 void MyFrame::OnVariableExpansionToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 303 {
 304     wxDialog dlg;
 305     wxXmlResource::Get()->LoadDialog(&dlg, this, wxT("variable_expansion_dialog"));
 306     dlg.ShowModal();
 307 }
 308
 309
 310 void MyFrame::OnAboutToolOrMenuCommand(wxCommandEvent& WXUNUSED(event))
 311 {
 312     wxString msg;
 313     msg.Printf( _T("This is the about dialog of XML resources demo.\n")
 314                 _T("Welcome to %s"), wxVERSION_STRING);
 315
 316     wxMessageBox(msg, _("About XML resources demo"), wxOK | wxICON_INFORMATION, this);
 317 }