samples/oleauto/oleauto.cpp

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        oleauto.cpp
   3 // Purpose:     OLE Automation wxWidgets sample
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     08/12/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 // ============================================================================
  13 // declarations
  14 // ============================================================================
  15
  16 // ----------------------------------------------------------------------------
  17 // headers
  18 // ----------------------------------------------------------------------------
  19
  20 // For compilers that support precompilation, includes "wx/wx.h".
  21 #include "wx/wxprec.h"
  22
  23 #ifdef __BORLANDC__
  24     #pragma hdrstop
  25 #endif
  26
  27 // for all others, include the necessary headers (this file is usually all you
  28 // need because it includes almost all "standard" wxWidgets headers
  29 #ifndef WX_PRECOMP
  30     #include "wx/wx.h"
  31 #endif
  32
  33 #include "wx/msw/ole/automtn.h"
  34
  35 #ifndef __WXMSW__
  36 #error "Sorry, this sample works under Windows only."
  37 #endif
  38
  39 // ----------------------------------------------------------------------------
  40 // ressources
  41 // ----------------------------------------------------------------------------
  42 // the application icon
  43 #if !defined(__WXMSW__) && !defined(__WXPM__)
  44     #include "../sample.xpm"
  45 #endif
  46
  47 // ----------------------------------------------------------------------------
  48 // private classes
  49 // ----------------------------------------------------------------------------
  50
  51 // Define a new application type, each program should derive a class from wxApp
  52 class MyApp : public wxApp
  53 {
  54 public:
  55     // override base class virtuals
  56     // ----------------------------
  57
  58     // this one is called on application startup and is a good place for the app
  59     // initialization (doing it here and not in the ctor allows to have an error
  60     // return: if OnInit() returns false, the application terminates)
  61     virtual bool OnInit();
  62 };
  63
  64 // Define a new frame type: this is going to be our main frame
  65 class MyFrame : public wxFrame
  66 {
  67 public:
  68     // ctor(s)
  69     MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size);
  70
  71     // event handlers (these functions should _not_ be virtual)
  72     void OnQuit(wxCommandEvent& event);
  73     void OnAbout(wxCommandEvent& event);
  74     void OnTest(wxCommandEvent& event);
  75
  76 private:
  77     // any class wishing to process wxWidgets events must use this macro
  78     DECLARE_EVENT_TABLE()
  79 };
  80
  81 // ----------------------------------------------------------------------------
  82 // constants
  83 // ----------------------------------------------------------------------------
  84
  85 // IDs for the controls and the menu commands
  86 enum
  87 {
  88     // menu items
  89     OleAuto_Quit = 1,
  90     OleAuto_About,
  91     OleAuto_Test,
  92
  93     // controls start here (the numbers are, of course, arbitrary)
  94     OleAuto_Text = 1000
  95 };
  96
  97 // ----------------------------------------------------------------------------
  98 // event tables and other macros for wxWidgets
  99 // ----------------------------------------------------------------------------
 100
 101 // the event tables connect the wxWidgets events with the functions (event
 102 // handlers) which process them. It can be also done at run-time, but for the
 103 // simple menu events like this the static method is much simpler.
 104 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
 105     EVT_MENU(OleAuto_Quit,  MyFrame::OnQuit)
 106     EVT_MENU(OleAuto_About, MyFrame::OnAbout)
 107     EVT_MENU(OleAuto_Test, MyFrame::OnTest)
 108 END_EVENT_TABLE()
 109
 110 // Create a new application object: this macro will allow wxWidgets to create
 111 // the application object during program execution (it's better than using a
 112 // static object for many reasons) and also declares the accessor function
 113 // wxGetApp() which will return the reference of the right type (i.e. MyApp and
 114 // not wxApp)
 115 IMPLEMENT_APP(MyApp)
 116
 117 // ============================================================================
 118 // implementation
 119 // ============================================================================
 120
 121 // ----------------------------------------------------------------------------
 122 // the application class
 123 // ----------------------------------------------------------------------------
 124
 125 // `Main program' equivalent: the program execution "starts" here
 126 bool MyApp::OnInit()
 127 {
 128     if ( !wxApp::OnInit() )
 129         return false;
 130
 131     // Create the main application window
 132     MyFrame *frame = new MyFrame(wxT("OleAuto wxWidgets App"),
 133                                  wxPoint(50, 50), wxSize(450, 340));
 134
 135     // Show it and tell the application that it's our main window
 136     // @@@ what does it do exactly, in fact? is it necessary here?
 137     frame->Show(true);
 138     SetTopWindow(frame);
 139
 140     // success: wxApp::OnRun() will be called which will enter the main message
 141     // loop and the application will run. If we returned false here, the
 142     // application would exit immediately.
 143     return true;
 144 }
 145
 146 // ----------------------------------------------------------------------------
 147 // main frame
 148 // ----------------------------------------------------------------------------
 149
 150 // frame constructor
 151 MyFrame::MyFrame(const wxString& title, const wxPoint& pos, const wxSize& size)
 152        : wxFrame((wxFrame *)NULL, wxID_ANY, title, pos, size)
 153 {
 154     // set the frame icon
 155     SetIcon(wxICON(sample));
 156
 157     // create a menu bar
 158     wxMenu *menuFile = new wxMenu;
 159
 160     menuFile->Append(OleAuto_Test, wxT("&Test Excel Automation..."));
 161     menuFile->Append(OleAuto_About, wxT("&About..."));
 162     menuFile->AppendSeparator();
 163     menuFile->Append(OleAuto_Quit, wxT("E&xit"));
 164
 165     // now append the freshly created menu to the menu bar...
 166     wxMenuBar *menuBar = new wxMenuBar;
 167     menuBar->Append(menuFile, wxT("&File"));
 168
 169     // ... and attach this menu bar to the frame
 170     SetMenuBar(menuBar);
 171
 172 #if wxUSE_STATUSBAR
 173     // create a status bar just for fun (by default with 1 pane only)
 174     CreateStatusBar(2);
 175     SetStatusText(wxT("Welcome to wxWidgets!"));
 176 #endif // wxUSE_STATUSBAR
 177 }
 178
 179
 180 // event handlers
 181
 182 void MyFrame::OnQuit(wxCommandEvent& WXUNUSED(event))
 183 {
 184     // true is to force the frame to close
 185     Close(true);
 186 }
 187
 188 void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event))
 189 {
 190     wxMessageBox(wxT("This is an OLE Automation sample"),
 191                  wxT("About OleAuto"), wxOK | wxICON_INFORMATION, this);
 192 }
 193
 194 /* Tests OLE automation by making the active Excel cell bold,
 195  * and changing the text.
 196  */
 197 void MyFrame::OnTest(wxCommandEvent& WXUNUSED(event))
 198 {
 199     wxMessageBox(wxT("Please ensure Excel is running, then press OK.\nThe active cell should then say 'wxWidgets automation test!' in bold."));
 200
 201     wxAutomationObject excelObject, rangeObject;
 202     if (!excelObject.GetInstance(wxT("Excel.Application")))
 203     {
 204         // Start Excel if it is not running
 205         if (!excelObject.CreateInstance(wxT("Excel.Application")))
 206         {
 207             wxMessageBox(wxT("Could not create Excel object."));
 208             return;
 209         }
 210     }
 211
 212     // Ensure that Excel is visible
 213     if (!excelObject.PutProperty(wxT("Visible"), true))
 214     {
 215         wxMessageBox(wxT("Could not make Excel object visible"));
 216     }
 217     const wxVariant workbooksCountVariant = excelObject.GetProperty(wxT("Workbooks.Count"));
 218     if (workbooksCountVariant.IsNull())
 219     {
 220         wxMessageBox(wxT("Could not get workbooks count"));
 221         return;
 222     }
 223     const long workbooksCount = workbooksCountVariant;
 224     if (workbooksCount == 0)
 225     {
 226         const wxVariant workbook = excelObject.CallMethod(wxT("Workbooks.Add"));
 227         if (workbook.IsNull())
 228         {
 229             wxMessageBox(wxT("Could not create new Workbook"));
 230             return;
 231         }
 232     }
 233
 234     if (!excelObject.PutProperty(wxT("ActiveCell.Value"), wxT("wxWidgets automation test!")))
 235     {
 236         wxMessageBox(wxT("Could not set active cell value."));
 237         return;
 238     }
 239     if (!excelObject.PutProperty(wxT("ActiveCell.Font.Bold"), wxVariant(true)) )
 240     {
 241         wxMessageBox(wxT("Could not put Bold property to active cell."));
 242         return;
 243     }
 244 }