1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef BASIC_VBAHELPR_HXX
#define BASIC_VBAHELPR_HXX
#include <com/sun/star/container/XEnumeration.hpp>
#include <com/sun/star/frame/XModel.hpp>
#include <rtl/ustring.hxx>
#include "basicdllapi.h"
namespace basic {
namespace vba {
/* This header contains public helper functions for VBA used from this module
and from other VBA implementation modules such as vbahelper.
*/
// ============================================================================
/** Creates and returns an enumeration of all open documents of the same type
as the specified document.
First, the global module manager (com.sun.star.frame.ModuleManager) is
asked for the type of the passed model, and all open documents with the
same type will be stored in an enumeration object.
@param rxModel
A document model determining the type of the documents.
*/
BASIC_DLLPUBLIC ::com::sun::star::uno::Reference< ::com::sun::star::container::XEnumeration > createDocumentsEnumeration(
const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& rxModel );
// ============================================================================
/** Locks or unlocks the controllers of all documents that have the same type
as the specified document.
First, the global module manager (com.sun.star.frame.ModuleManager) is
asked for the type of the passed model, and all open documents with the
same type will be locked or unlocked.
@param rxModel
A document model determining the type of the documents to be locked or
unlocked.
@param bLockControllers
Passing true will lock all controllers, passing false will unlock them.
*/
BASIC_DLLPUBLIC void lockControllersOfAllDocuments(
const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& rxModel,
sal_Bool bLockControllers );
// ============================================================================
/** Enables or disables the container windows of all controllers of all
documents that have the same type as the specified document.
First, the global module manager (com.sun.star.frame.ModuleManager) is
asked for the type of the passed model, and the container windows of all
open documents with the same type will be enabled or disabled.
@param rxModel
A document model determining the type of the documents to be enabled or
disabled.
@param bEnableWindows
Passing true will enable all container windows of all controllers,
passing false will disable them.
*/
BASIC_DLLPUBLIC void enableContainerWindowsOfAllDocuments(
const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& rxModel,
sal_Bool bEnableWindows );
// ============================================================================
/** Registers the passed path as working directory for the application the
passed document belongs to.
@param rxModel
A document model determining the type of the application whose working
directory has been changed.
@param rPath
The new working directory.
*/
BASIC_DLLPUBLIC void registerCurrentDirectory(
const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& rxModel,
const ::rtl::OUString& rPath );
// ============================================================================
/** Returns the working directory of the application the passed document
belongs to.
@param rxModel
A document model determining the type of the application whose working
directory is querried.
@return
The working directory of the specified application, or an empty string
on error (e.g. if the passed document reference is empty).
*/
BASIC_DLLPUBLIC ::rtl::OUString getCurrentDirectory(
const ::com::sun::star::uno::Reference< ::com::sun::star::frame::XModel >& rxModel );
// ============================================================================
} // namespace vba
} // namespace basic
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
