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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef INCLUDED_SVTOOLS_GENERICUNODIALOG_HXX
#define INCLUDED_SVTOOLS_GENERICUNODIALOG_HXX
#include <svtools/svtdllapi.h>
#include <com/sun/star/lang/XServiceInfo.hpp>
#include <com/sun/star/lang/XInitialization.hpp>
#include <com/sun/star/awt/XWindow.hpp>
#include <com/sun/star/uno/XComponentContext.hpp>
#include <com/sun/star/ui/dialogs/XExecutableDialog.hpp>
#include <com/sun/star/beans/PropertyValue.hpp>
#include <com/sun/star/beans/PropertyAttribute.hpp>
#include <com/sun/star/lang/NotInitializedException.hpp>
#include <cppuhelper/implbase.hxx>
#include <cppuhelper/propshlp.hxx>
#include <comphelper/proparrhlp.hxx>
#include <comphelper/uno3.hxx>
#include <comphelper/propertycontainer.hxx>
#include <comphelper/broadcasthelper.hxx>
#include <tools/link.hxx>
#include <vcl/vclptr.hxx>
class Dialog;
namespace vcl { class Window; }
class VclWindowEvent;
namespace svt
{
#define UNODIALOG_PROPERTY_ID_TITLE 1
#define UNODIALOG_PROPERTY_ID_PARENT 2
#define UNODIALOG_PROPERTY_TITLE "Title"
#define UNODIALOG_PROPERTY_PARENT "ParentWindow"
typedef cppu::WeakImplHelper< css::ui::dialogs::XExecutableDialog,
css::lang::XServiceInfo,
css::lang::XInitialization > OGenericUnoDialogBase;
/** abstract base class for implementing UNO objects representing dialogs (com.sun.star.awt::XDialog)
*/
class SVT_DLLPUBLIC OGenericUnoDialog
:public OGenericUnoDialogBase
,public ::comphelper::OMutexAndBroadcastHelper
,public ::comphelper::OPropertyContainer
{
protected:
VclPtr<Dialog> m_pDialog; /// the dialog to execute
bool m_bExecuting : 1; /// we're currently executing the dialog
bool m_bTitleAmbiguous : 1; /// m_sTitle has not been set yet
bool m_bInitialized : 1; /// has "initialize" been called?
bool m_bNeedInitialization : 1; /// do we need to be initialized before any other API call is allowed?
// <properties>
OUString m_sTitle; /// title of the dialog
css::uno::Reference<css::awt::XWindow> m_xParent; /// parent window
// </properties>
css::uno::Reference<css::uno::XComponentContext> m_aContext;
public:
bool needInitialization() const { return m_bNeedInitialization && !m_bInitialized; }
protected:
OGenericUnoDialog(const css::uno::Reference< css::uno::XComponentContext >& _rxContext);
virtual ~OGenericUnoDialog() override;
public:
// UNO
DECLARE_UNO3_DEFAULTS(OGenericUnoDialog, OGenericUnoDialogBase)
virtual css::uno::Any SAL_CALL queryInterface(const css::uno::Type& _rType) override;
// XTypeProvider
virtual css::uno::Sequence<css::uno::Type> SAL_CALL getTypes( ) override;
virtual css::uno::Sequence<sal_Int8> SAL_CALL getImplementationId( ) override = 0;
// XServiceInfo
virtual OUString SAL_CALL getImplementationName() override = 0;
virtual sal_Bool SAL_CALL supportsService(const OUString& ServiceName) override;
virtual css::uno::Sequence<OUString> SAL_CALL getSupportedServiceNames() override = 0;
// OPropertySetHelper
virtual void SAL_CALL setFastPropertyValue_NoBroadcast( sal_Int32 nHandle, const css::uno::Any& rValue ) override;
virtual sal_Bool SAL_CALL convertFastPropertyValue( css::uno::Any& rConvertedValue, css::uno::Any& rOldValue, sal_Int32 nHandle, const css::uno::Any& rValue) override;
// XExecutableDialog
virtual void SAL_CALL setTitle( const OUString& aTitle ) override;
virtual sal_Int16 SAL_CALL execute( ) override;
// XInitialization
virtual void SAL_CALL initialize( const css::uno::Sequence< css::uno::Any >& aArguments ) override;
protected:
/** create the concrete dialog instance. note that m_aMutex is not locked when this method get's called,
but the application-wide solar mutex is (to guard the not thread-safe ctor of the dialog).
@param pParent the parent window for the new dialog
*/
virtual VclPtr<Dialog> createDialog(vcl::Window* _pParent) = 0;
/// called to destroy the dialog used. deletes m_pDialog and resets it to NULL
void destroyDialog();
/** called after the dialog has been executed
@param _nExecutionResult the execution result as returned by Dialog::Execute
*/
virtual void executedDialog(sal_Int16 /*_nExecutionResult*/) { }
/** smaller form of <method>initialize</method>.<p/>
The <method>initialize</method> method is called with a sequence of com.sun.star.uno::Any's,
which is split up into the single elements, which are passed to implInitialize. The default implementation
tries to extract an com.sun.star.beans::PropertyValue from the value an pass it to the
com.sun.star.beans::XPropertySet interface of the object.
*/
virtual void implInitialize(const css::uno::Any& _rValue);
private:
DECL_LINK( OnDialogDying, VclWindowEvent&, void );
/** ensures that m_pDialog is not <NULL/>
This method does nothing if m_pDialog is already non-<NULL/>. Else, it calls createDialog and does
all necessary initializations of the new dialog instance.
@precond
m_aMutex is locked
@return
<TRUE/> if and only if m_pDialog is non-<NULL/> upon returning from the method. Note that the only
case where m_pDialog is <NULL/> is when createDialog returned <NULL/>, which is will fire an assertion
in non-product builds.
*/
bool impl_ensureDialog_lck();
};
/// helper class for guarding access to methods of a OGenericUnoDialog
class UnoDialogEntryGuard
{
public:
UnoDialogEntryGuard( OGenericUnoDialog& _rDialog )
:m_aGuard( _rDialog.GetMutex() )
{
if ( _rDialog.needInitialization() )
throw css::lang::NotInitializedException();
}
private:
::osl::MutexGuard m_aGuard;
};
} // namespace svt
#endif // INCLUDED_SVTOOLS_GENERICUNODIALOG_HXX
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
