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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
|
/* -*- 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_VCL_ABSTDLG_HXX
#define INCLUDED_VCL_ABSTDLG_HXX
#include <sal/types.h>
#include <rtl/ustring.hxx>
#include <vcl/dllapi.h>
#include <vcl/vclptr.hxx>
#include <vcl/vclreferencebase.hxx>
#include <vector>
#include <functional>
#include <memory>
namespace com::sun::star::uno { template <class interface_type> class Reference; }
namespace com::sun::star::frame { class XModel; }
class Dialog;
class BitmapEx;
class DiagramDataInterface;
namespace weld
{
class Dialog;
class DialogController;
class Window;
}
/**
* Some things multiple-inherit from VclAbstractDialog and OutputDevice,
* so we need to use virtual inheritance to keep the referencing counting
* OK.
*/
class VCL_DLLPUBLIC VclAbstractDialog : public virtual VclReferenceBase
{
protected:
virtual ~VclAbstractDialog() override;
public:
virtual short Execute() = 0;
struct AsyncContext {
// for the case where the owner is the dialog itself, and the dialog is an unwelded VclPtr based dialog
VclPtr<VclReferenceBase> mxOwner;
// for the case where the dialog is welded, and owned by a DialogController
std::shared_ptr<weld::DialogController> mxOwnerDialogController;
// for the case where the dialog is welded, and is running async without a DialogController
std::shared_ptr<weld::Dialog> mxOwnerSelf;
std::function<void(sal_Int32)> maEndDialogFn;
bool isSet() const { return !!maEndDialogFn; }
};
bool StartExecuteAsync(const std::function<void(sal_Int32)> &rEndDialogFn)
{
AsyncContext aCtx;
aCtx.mxOwner = this;
aCtx.maEndDialogFn = rEndDialogFn;
return StartExecuteAsync(aCtx);
}
/// Commence execution of a modal dialog.
virtual bool StartExecuteAsync(AsyncContext &);
// Screenshot interface
virtual std::vector<OString> getAllPageUIXMLDescriptions() const;
virtual bool selectPageByUIXMLDescription(const OString& rUIXMLDescription);
virtual BitmapEx createScreenshot() const;
virtual OString GetScreenshotId() const { return OString(); };
};
class VCL_DLLPUBLIC VclAbstractTerminatedDialog : public VclAbstractDialog
{
protected:
virtual ~VclAbstractTerminatedDialog() override = default;
public:
virtual void EndDialog(sal_Int32 nResult) = 0;
};
class VCL_DLLPUBLIC AbstractPasswordToOpenModifyDialog : public VclAbstractDialog
{
protected:
virtual ~AbstractPasswordToOpenModifyDialog() override = default;
public:
virtual OUString GetPasswordToOpen() const = 0;
virtual OUString GetPasswordToModify() const = 0;
virtual bool IsRecommendToOpenReadonly() const = 0;
};
class VCL_DLLPUBLIC AbstractScreenshotAnnotationDlg : public VclAbstractDialog
{
protected:
virtual ~AbstractScreenshotAnnotationDlg() override = default;
};
class VCL_DLLPUBLIC AbstractSignatureLineDialog : public VclAbstractDialog
{
protected:
virtual ~AbstractSignatureLineDialog() override = default;
};
class VCL_DLLPUBLIC AbstractSignSignatureLineDialog : public VclAbstractDialog
{
protected:
virtual ~AbstractSignSignatureLineDialog() override = default;
};
class VCL_DLLPUBLIC AbstractQrCodeGenDialog : public VclAbstractDialog
{
protected:
virtual ~AbstractQrCodeGenDialog() override = default;
};
class VCL_DLLPUBLIC AbstractAboutDialog : public VclAbstractDialog
{
protected:
virtual ~AbstractAboutDialog() override = default;
};
class VCL_DLLPUBLIC AbstractTipOfTheDayDialog : public VclAbstractDialog
{
protected:
virtual ~AbstractTipOfTheDayDialog() override = default;
};
/** Edit Diagram dialog */
class VCL_DLLPUBLIC AbstractDiagramDialog : public VclAbstractDialog
{
protected:
virtual ~AbstractDiagramDialog() override = default;
};
class VCL_DLLPUBLIC VclAbstractDialogFactory
{
public:
virtual ~VclAbstractDialogFactory(); // needed for export of vtable
static VclAbstractDialogFactory* Create();
// The Id is an implementation detail of the factory
virtual VclPtr<VclAbstractDialog> CreateVclDialog(weld::Window* pParent, sal_uInt32 nId) = 0;
// creates instance of PasswordToOpenModifyDialog from cui
virtual VclPtr<AbstractPasswordToOpenModifyDialog> CreatePasswordToOpenModifyDialog(weld::Window * pParent, sal_uInt16 nMaxPasswdLen, bool bIsPasswordToModify) = 0;
// creates instance of SignatureDialog from cui
virtual VclPtr<AbstractSignatureLineDialog>
CreateSignatureLineDialog(weld::Window* pParent,
const css::uno::Reference<css::frame::XModel> xModel,
bool bEditExisting)
= 0;
// creates instance of SignSignatureDialog from cui
virtual VclPtr<AbstractSignSignatureLineDialog>
CreateSignSignatureLineDialog(weld::Window* pParent,
const css::uno::Reference<css::frame::XModel> xModel)
= 0;
// creates instance of QrCodeDialog from cui
virtual VclPtr<AbstractQrCodeGenDialog>
CreateQrCodeGenDialog(weld::Window* pParent,
const css::uno::Reference<css::frame::XModel> xModel,
bool bEditExisting)
= 0;
// creates instance of ScreenshotAnnotationDlg from cui
virtual VclPtr<AbstractScreenshotAnnotationDlg> CreateScreenshotAnnotationDlg(
weld::Dialog& rParentDialog) = 0;
// create about dialog
virtual VclPtr<AbstractAboutDialog>
CreateAboutDialog(weld::Window* pParent) = 0;
// create info dialog to show tip-of-the-day
virtual VclPtr<AbstractTipOfTheDayDialog>
CreateTipOfTheDayDialog(weld::Window* pParent) = 0;
virtual VclPtr<AbstractDiagramDialog> CreateDiagramDialog(
weld::Window* pParent,
std::shared_ptr<DiagramDataInterface> pDiagramData) = 0;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
