LibreOffice Module sc (master)  1
vbaapplication.hxx
Go to the documentation of this file.
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3  * This file is part of the LibreOffice project.
4  *
5  * This Source Code Form is subject to the terms of the Mozilla Public
6  * License, v. 2.0. If a copy of the MPL was not distributed with this
7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8  *
9  * This file incorporates work covered by the following license notice:
10  *
11  * Licensed to the Apache Software Foundation (ASF) under one or more
12  * contributor license agreements. See the NOTICE file distributed
13  * with this work for additional information regarding copyright
14  * ownership. The ASF licenses this file to you under the Apache
15  * License, Version 2.0 (the "License"); you may not use this file
16  * except in compliance with the License. You may obtain a copy of
17  * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18  */
19 #ifndef INCLUDED_SC_SOURCE_UI_VBA_VBAAPPLICATION_HXX
20 #define INCLUDED_SC_SOURCE_UI_VBA_VBAAPPLICATION_HXX
21 
22 #include <vector>
23 
24 #include <ooo/vba/XSinkCaller.hpp>
25 #include <ooo/vba/excel/XApplication.hpp>
26 
28 #include <cppuhelper/implbase.hxx>
29 
30 namespace com::sun::star::uno { class XComponentContext; }
31 namespace ooo::vba { class XSink; }
32 namespace ooo::vba::excel { class XFileDialog; }
33 
34 typedef cppu::ImplInheritanceHelper< VbaApplicationBase, ov::excel::XApplication, ov::XSinkCaller > ScVbaApplication_BASE;
35 
36 struct ScVbaAppSettings;
37 
39 {
40 private:
41  // note: member variables moved to struct "ScVbaAppSettings", see cxx file, to be shared by all application instances
43 
44  // must be stored in order to get result paths from the same instance
45  css::uno::Reference< ov::excel::XFileDialog > m_xFileDialog;
46  sal_Int32 m_nDialogType;
47 
49  OUString getOfficePath( const OUString& sPath );
50 
51  std::vector<css::uno::Reference< ooo::vba::XSink >> mvSinks;
52 
53 protected:
54  virtual css::uno::Reference< css::frame::XModel > getCurrentDocument() override;
55 
56 public:
57  explicit ScVbaApplication( const css::uno::Reference< css::uno::XComponentContext >& m_xContext );
58  virtual ~ScVbaApplication() override;
59 
61  static bool getDocumentEventsEnabled();
62 
63  sal_uInt32 AddSink( const css::uno::Reference< ooo::vba::XSink >& xSink );
64  void RemoveSink( sal_uInt32 nNumber );
65 
66  // XExactName
67  virtual OUString SAL_CALL getExactName( const OUString& aApproximateName ) override;
68 
69  // XInvocation
70  virtual css::uno::Reference< css::beans::XIntrospectionAccess > SAL_CALL getIntrospection() override;
71  virtual css::uno::Any SAL_CALL invoke(const OUString& FunctionName, const css::uno::Sequence< css::uno::Any >& Params, css::uno::Sequence< sal_Int16 >& OutParamIndex, css::uno::Sequence< css::uno::Any >& OutParam) override;
72  virtual void SAL_CALL setValue(const OUString& PropertyName, const css::uno::Any& Value) override;
73  virtual css::uno::Any SAL_CALL getValue(const OUString& PropertyName) override;
74  virtual sal_Bool SAL_CALL hasMethod(const OUString& Name) override;
75  virtual sal_Bool SAL_CALL hasProperty(const OUString& Name) override;
76 
77  // XApplication
78  virtual void SAL_CALL setDefaultFilePath( const OUString& DefaultFilePath ) override;
79  virtual OUString SAL_CALL getDefaultFilePath() override;
80  virtual OUString SAL_CALL getPathSeparator() override;
81  virtual OUString SAL_CALL getLibraryPath() override;
82  virtual OUString SAL_CALL getTemplatesPath() override;
83  virtual OUString SAL_CALL getOperatingSystem() override;
84 
85  virtual OUString SAL_CALL getName() override;
86  virtual sal_Bool SAL_CALL getDisplayAlerts() override;
87  virtual void SAL_CALL setDisplayAlerts( sal_Bool displayAlerts ) override;
88  virtual ::sal_Int32 SAL_CALL getCalculation() override;
89  virtual void SAL_CALL setCalculation( ::sal_Int32 _calculation ) override;
90  virtual css::uno::Any SAL_CALL getSelection() override;
91  virtual css::uno::Reference< ov::excel::XWorkbook > SAL_CALL getActiveWorkbook() override;
92  virtual css::uno::Reference< ov::excel::XRange > SAL_CALL getActiveCell() override;
93  virtual css::uno::Reference< ov::excel::XWindow > SAL_CALL getActiveWindow() override;
94  virtual css::uno::Reference< ov::excel::XWorksheet > SAL_CALL getActiveSheet() override;
95  virtual sal_Bool SAL_CALL getDisplayFormulaBar() override;
96  virtual void SAL_CALL setDisplayFormulaBar(sal_Bool _displayformulabar) override;
97 
98  virtual css::uno::Reference< ov::XAssistant > SAL_CALL getAssistant() override;
99  virtual css::uno::Reference< ov::excel::XWorkbook > SAL_CALL getThisWorkbook() override;
100  virtual css::uno::Any SAL_CALL International( sal_Int32 Index ) override;
101  virtual css::uno::Any SAL_CALL FileDialog( const css::uno::Any& DialogType ) override;
102  virtual css::uno::Any SAL_CALL Workbooks( const css::uno::Any& aIndex ) override;
103  virtual css::uno::Any SAL_CALL Worksheets( const css::uno::Any& aIndex ) override;
104  virtual css::uno::Any SAL_CALL WorksheetFunction( ) override;
105  virtual css::uno::Any SAL_CALL Evaluate( const OUString& Name ) override;
106  virtual css::uno::Any SAL_CALL Dialogs( const css::uno::Any& DialogIndex ) override;
107  virtual css::uno::Any SAL_CALL getCutCopyMode() override;
108  virtual void SAL_CALL setCutCopyMode( const css::uno::Any& _cutcopymode ) override;
109  virtual css::uno::Any SAL_CALL getStatusBar() override;
110  virtual void SAL_CALL setStatusBar( const css::uno::Any& _statusbar ) override;
111  virtual ::sal_Int32 SAL_CALL getCursor() override;
112  virtual void SAL_CALL setCursor( ::sal_Int32 _cursor ) override;
113  virtual void SAL_CALL OnKey( const OUString& Key, const css::uno::Any& Procedure ) override;
114  virtual void SAL_CALL setScreenUpdating( sal_Bool bUpdate ) override;
115  virtual sal_Bool SAL_CALL getEnableEvents() override;
116  virtual void SAL_CALL setEnableEvents( sal_Bool bEnable ) override;
117  virtual sal_Bool SAL_CALL getEnableCancelKey() override;
118  virtual void SAL_CALL setEnableCancelKey( sal_Bool bEnable ) override;
119 
120  virtual sal_Bool SAL_CALL getDisplayFullScreen() override;
121  virtual void SAL_CALL setDisplayFullScreen( sal_Bool bSet ) override;
122  virtual sal_Bool SAL_CALL getDisplayScrollBars() override;
123  virtual void SAL_CALL setDisplayScrollBars( sal_Bool bSet ) override;
124  virtual sal_Bool SAL_CALL getDisplayExcel4Menus() override;
125  virtual void SAL_CALL setDisplayExcel4Menus( sal_Bool bSet ) override;
126 
127  virtual sal_Bool SAL_CALL getDisplayNoteIndicator() override;
128  virtual void SAL_CALL setDisplayNoteIndicator( sal_Bool bSet ) override;
129  virtual sal_Bool SAL_CALL getShowWindowsInTaskbar() override;
130  virtual void SAL_CALL setShowWindowsInTaskbar( sal_Bool bSet ) override;
131  virtual sal_Bool SAL_CALL getIteration() override;
132  virtual void SAL_CALL setIteration( sal_Bool bSet ) override;
133 
134  virtual css::uno::Any SAL_CALL Windows( const css::uno::Any& aIndex ) override;
135  virtual void SAL_CALL wait( double time ) override;
136  virtual css::uno::Any SAL_CALL Range( const css::uno::Any& Cell1, const css::uno::Any& Cell2 ) override;
137  virtual css::uno::Any SAL_CALL Names( const css::uno::Any& aIndex ) override;
138  virtual void SAL_CALL GoTo( const css::uno::Any& Reference, const css::uno::Any& Scroll ) override;
139  virtual void SAL_CALL Calculate() override;
140  virtual css::uno::Reference< ov::excel::XRange > SAL_CALL Intersect( const css::uno::Reference< ov::excel::XRange >& Arg1, const css::uno::Reference< ov::excel::XRange >& Arg2, const css::uno::Any& Arg3, const css::uno::Any& Arg4, const css::uno::Any& Arg5, const css::uno::Any& Arg6, const css::uno::Any& Arg7, const css::uno::Any& Arg8, const css::uno::Any& Arg9, const css::uno::Any& Arg10, const css::uno::Any& Arg11, const css::uno::Any& Arg12, const css::uno::Any& Arg13, const css::uno::Any& Arg14, const css::uno::Any& Arg15, const css::uno::Any& Arg16, const css::uno::Any& Arg17, const css::uno::Any& Arg18, const css::uno::Any& Arg19, const css::uno::Any& Arg20, const css::uno::Any& Arg21, const css::uno::Any& Arg22, const css::uno::Any& Arg23, const css::uno::Any& Arg24, const css::uno::Any& Arg25, const css::uno::Any& Arg26, const css::uno::Any& Arg27, const css::uno::Any& Arg28, const css::uno::Any& Arg29, const css::uno::Any& Arg30 ) override;
141  virtual css::uno::Reference< ov::excel::XRange > SAL_CALL Union( const css::uno::Reference< ov::excel::XRange >& Arg1, const css::uno::Reference< ov::excel::XRange >& Arg2, const css::uno::Any& Arg3, const css::uno::Any& Arg4, const css::uno::Any& Arg5, const css::uno::Any& Arg6, const css::uno::Any& Arg7, const css::uno::Any& Arg8, const css::uno::Any& Arg9, const css::uno::Any& Arg10, const css::uno::Any& Arg11, const css::uno::Any& Arg12, const css::uno::Any& Arg13, const css::uno::Any& Arg14, const css::uno::Any& Arg15, const css::uno::Any& Arg16, const css::uno::Any& Arg17, const css::uno::Any& Arg18, const css::uno::Any& Arg19, const css::uno::Any& Arg20, const css::uno::Any& Arg21, const css::uno::Any& Arg22, const css::uno::Any& Arg23, const css::uno::Any& Arg24, const css::uno::Any& Arg25, const css::uno::Any& Arg26, const css::uno::Any& Arg27, const css::uno::Any& Arg28, const css::uno::Any& Arg29, const css::uno::Any& Arg30 ) override;
142  virtual double SAL_CALL InchesToPoints( double InchesToPoints ) override;
143  virtual void SAL_CALL Volatile( const css::uno::Any& Volatile ) override;
144  virtual css::uno::Any SAL_CALL MenuBars( const css::uno::Any& aIndex ) override;
145  virtual css::uno::Any SAL_CALL Rows( const css::uno::Any& aIndex ) override;
146  virtual css::uno::Any SAL_CALL Caller( const css::uno::Any& aIndex ) override;
147  virtual void SAL_CALL Undo() override;
148 
149  // XHelperInterface
150  virtual OUString getServiceImplName() override;
151  virtual css::uno::Sequence<OUString> getServiceNames() override;
152 
153  // XInterfaceWithIID
154  virtual OUString SAL_CALL getIID() override;
155 
156  // XConnectable
157  virtual OUString SAL_CALL GetIIDForClassItselfNotCoclass() override;
158  virtual ov::TypeAndIID SAL_CALL GetConnectionPoint() override;
159  virtual css::uno::Reference<ov::XConnectionPoint> SAL_CALL FindConnectionPoint() override;
160 
161  // XSinkCaller
162  virtual void SAL_CALL CallSinks( const OUString& Method, css::uno::Sequence< css::uno::Any >& Arguments ) override;
163 };
164 #endif // INCLUDED_SC_SOURCE_UI_VBA_VBAAPPLICATION_HXX
165 
166 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
virtual css::uno::Any SAL_CALL FileDialog(const css::uno::Any &DialogType) override
virtual css::uno::Any SAL_CALL MenuBars(const css::uno::Any &aIndex) override
virtual ::sal_Int32 SAL_CALL getCalculation() override
virtual sal_Bool SAL_CALL hasMethod(const OUString &Name) override
virtual css::uno::Any SAL_CALL getSelection() override
virtual sal_Bool SAL_CALL getEnableCancelKey() override
virtual css::uno::Any SAL_CALL Evaluate(const OUString &Name) override
virtual css::uno::Reference< ov::excel::XWorkbook > SAL_CALL getActiveWorkbook() override
virtual sal_Bool SAL_CALL getDisplayFormulaBar() override
virtual css::uno::Reference< ov::excel::XWindow > SAL_CALL getActiveWindow() override
virtual css::uno::Any SAL_CALL getStatusBar() override
virtual css::uno::Any SAL_CALL invoke(const OUString &FunctionName, const css::uno::Sequence< css::uno::Any > &Params, css::uno::Sequence< sal_Int16 > &OutParamIndex, css::uno::Sequence< css::uno::Any > &OutParam) override
virtual void SAL_CALL setEnableCancelKey(sal_Bool bEnable) override
virtual css::uno::Any SAL_CALL International(sal_Int32 Index) override
virtual void SAL_CALL setScreenUpdating(sal_Bool bUpdate) override
virtual void SAL_CALL setEnableEvents(sal_Bool bEnable) override
ScVbaApplication(const css::uno::Reference< css::uno::XComponentContext > &m_xContext)
virtual ov::TypeAndIID SAL_CALL GetConnectionPoint() override
virtual void SAL_CALL Calculate() override
virtual void SAL_CALL CallSinks(const OUString &Method, css::uno::Sequence< css::uno::Any > &Arguments) override
css::uno::Reference< ov::excel::XFileDialog > m_xFileDialog
virtual OUString SAL_CALL getTemplatesPath() override
virtual OUString SAL_CALL getLibraryPath() override
virtual css::uno::Reference< css::beans::XIntrospectionAccess > SAL_CALL getIntrospection() override
virtual void SAL_CALL setValue(const OUString &PropertyName, const css::uno::Any &Value) override
virtual void SAL_CALL OnKey(const OUString &Key, const css::uno::Any &Procedure) override
virtual double SAL_CALL InchesToPoints(double InchesToPoints) override
virtual OUString SAL_CALL getPathSeparator() override
virtual css::uno::Any SAL_CALL Workbooks(const css::uno::Any &aIndex) override
virtual void SAL_CALL GoTo(const css::uno::Any &Reference, const css::uno::Any &Scroll) override
virtual void SAL_CALL setStatusBar(const css::uno::Any &_statusbar) override
virtual void SAL_CALL Volatile(const css::uno::Any &Volatile) override
virtual void SAL_CALL setDisplayExcel4Menus(sal_Bool bSet) override
virtual sal_Bool SAL_CALL getDisplayFullScreen() override
std::vector< css::uno::Reference< ooo::vba::XSink > > mvSinks
virtual void SAL_CALL setDisplayFormulaBar(sal_Bool _displayformulabar) override
virtual void SAL_CALL setDisplayNoteIndicator(sal_Bool bSet) override
Global application settings shared by all open workbooks.
virtual void SAL_CALL setDefaultFilePath(const OUString &DefaultFilePath) override
virtual css::uno::Any SAL_CALL WorksheetFunction() override
virtual OUString SAL_CALL getDefaultFilePath() override
virtual OUString SAL_CALL getName() override
virtual css::uno::Any SAL_CALL Range(const css::uno::Any &Cell1, const css::uno::Any &Cell2) override
virtual ::sal_Int32 SAL_CALL getCursor() override
virtual void SAL_CALL setDisplayFullScreen(sal_Bool bSet) override
virtual css::uno::Reference< ov::excel::XRange > SAL_CALL Intersect(const css::uno::Reference< ov::excel::XRange > &Arg1, const css::uno::Reference< ov::excel::XRange > &Arg2, const css::uno::Any &Arg3, const css::uno::Any &Arg4, const css::uno::Any &Arg5, const css::uno::Any &Arg6, const css::uno::Any &Arg7, const css::uno::Any &Arg8, const css::uno::Any &Arg9, const css::uno::Any &Arg10, const css::uno::Any &Arg11, const css::uno::Any &Arg12, const css::uno::Any &Arg13, const css::uno::Any &Arg14, const css::uno::Any &Arg15, const css::uno::Any &Arg16, const css::uno::Any &Arg17, const css::uno::Any &Arg18, const css::uno::Any &Arg19, const css::uno::Any &Arg20, const css::uno::Any &Arg21, const css::uno::Any &Arg22, const css::uno::Any &Arg23, const css::uno::Any &Arg24, const css::uno::Any &Arg25, const css::uno::Any &Arg26, const css::uno::Any &Arg27, const css::uno::Any &Arg28, const css::uno::Any &Arg29, const css::uno::Any &Arg30) override
virtual sal_Bool SAL_CALL getShowWindowsInTaskbar() override
ScVbaAppSettings & mrAppSettings
virtual css::uno::Any SAL_CALL Rows(const css::uno::Any &aIndex) override
virtual sal_Bool SAL_CALL getIteration() override
cppu::ImplInheritanceHelper< VbaApplicationBase, ov::excel::XApplication, ov::XSinkCaller > ScVbaApplication_BASE
virtual css::uno::Any SAL_CALL Names(const css::uno::Any &aIndex) override
virtual void SAL_CALL setCutCopyMode(const css::uno::Any &_cutcopymode) override
static bool getDocumentEventsEnabled()
Returns true, if VBA document events are enabled.
virtual sal_Bool SAL_CALL getEnableEvents() override
virtual void SAL_CALL setDisplayScrollBars(sal_Bool bSet) override
void RemoveSink(sal_uInt32 nNumber)
virtual OUString SAL_CALL GetIIDForClassItselfNotCoclass() override
sal_uInt32 AddSink(const css::uno::Reference< ooo::vba::XSink > &xSink)
virtual sal_Bool SAL_CALL getDisplayNoteIndicator() override
virtual css::uno::Any SAL_CALL Dialogs(const css::uno::Any &DialogIndex) override
virtual css::uno::Any SAL_CALL Windows(const css::uno::Any &aIndex) override
unsigned char sal_Bool
virtual void SAL_CALL setDisplayAlerts(sal_Bool displayAlerts) override
sal_Int32 m_nDialogType
virtual void SAL_CALL setCalculation(::sal_Int32 _calculation) override
virtual OUString SAL_CALL getIID() override
virtual ~ScVbaApplication() override
virtual css::uno::Sequence< OUString > getServiceNames() override
virtual css::uno::Any SAL_CALL Worksheets(const css::uno::Any &aIndex) override
virtual css::uno::Any SAL_CALL Caller(const css::uno::Any &aIndex) override
virtual void SAL_CALL setShowWindowsInTaskbar(sal_Bool bSet) override
virtual css::uno::Reference< ov::XConnectionPoint > SAL_CALL FindConnectionPoint() override
virtual css::uno::Reference< ov::excel::XRange > SAL_CALL Union(const css::uno::Reference< ov::excel::XRange > &Arg1, const css::uno::Reference< ov::excel::XRange > &Arg2, const css::uno::Any &Arg3, const css::uno::Any &Arg4, const css::uno::Any &Arg5, const css::uno::Any &Arg6, const css::uno::Any &Arg7, const css::uno::Any &Arg8, const css::uno::Any &Arg9, const css::uno::Any &Arg10, const css::uno::Any &Arg11, const css::uno::Any &Arg12, const css::uno::Any &Arg13, const css::uno::Any &Arg14, const css::uno::Any &Arg15, const css::uno::Any &Arg16, const css::uno::Any &Arg17, const css::uno::Any &Arg18, const css::uno::Any &Arg19, const css::uno::Any &Arg20, const css::uno::Any &Arg21, const css::uno::Any &Arg22, const css::uno::Any &Arg23, const css::uno::Any &Arg24, const css::uno::Any &Arg25, const css::uno::Any &Arg26, const css::uno::Any &Arg27, const css::uno::Any &Arg28, const css::uno::Any &Arg29, const css::uno::Any &Arg30) override
virtual sal_Bool SAL_CALL hasProperty(const OUString &Name) override
virtual sal_Bool SAL_CALL getDisplayAlerts() override
virtual css::uno::Any SAL_CALL getCutCopyMode() override
virtual void SAL_CALL setIteration(sal_Bool bSet) override
virtual css::uno::Reference< css::frame::XModel > getCurrentDocument() override
virtual sal_Bool SAL_CALL getDisplayScrollBars() override
virtual css::uno::Reference< ov::excel::XWorkbook > SAL_CALL getThisWorkbook() override
virtual css::uno::Reference< ov::excel::XRange > SAL_CALL getActiveCell() override
virtual OUString SAL_CALL getExactName(const OUString &aApproximateName) override
virtual css::uno::Reference< ov::XAssistant > SAL_CALL getAssistant() override
virtual OUString SAL_CALL getOperatingSystem() override
virtual css::uno::Reference< ov::excel::XWorksheet > SAL_CALL getActiveSheet() override
virtual void SAL_CALL setCursor(::sal_Int32 _cursor) override
virtual sal_Bool SAL_CALL getDisplayExcel4Menus() override
virtual css::uno::Any SAL_CALL getValue(const OUString &PropertyName) override
struct _ADOKey Key
virtual OUString getServiceImplName() override
struct _ADOIndex Index
virtual void SAL_CALL Undo() override
virtual void SAL_CALL wait(double time) override
OUString getOfficePath(const OUString &sPath)