summaryrefslogtreecommitdiff
path: root/include/vcl/errinf.hxx
blob: f458ef6da4742e5b3c6a319ed9321d717a7cbf9c (plain)
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
/* -*- 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 __RSC

#ifndef INCLUDED_VCL_ERRINF_HXX
#define INCLUDED_VCL_ERRINF_HXX

#include <limits.h>
#include <rtl/ustring.hxx>
#include <tools/errcode.hxx>
#include <vcl/dllapi.h>
#include <o3tl/typed_flags_set.hxx>
#include <memory>

namespace vcl { class Window; }

class DynamicErrorInfo_Impl;
class ErrorHandler_Impl;

enum class ErrorHandlerFlags
{
    NONE                    = 0x0000,
    ButtonsOk               = 0x0001,
    ButtonsCancel           = 0x0002,
    ButtonsRetry            = 0x0004,
    ButtonsOkCancel         = 0x0003,
    ButtonsNo               = 0x0008,
    ButtonsYes              = 0x0010,
    ButtonsYesNo            = 0x0018,
    ButtonsYesNoCancel      = 0x001a,

    ButtonDefaultsOk        = 0x0100,
    ButtonDefaultsCancel    = 0x0200,
    ButtonDefaultsYes       = 0x0300,
    ButtonDefaultsNo        = 0x0400,

    MessageError            = 0x1000,
    MessageWarning          = 0x2000,
    MessageInfo             = 0x3000,

    MAX                     = USHRT_MAX,
};
namespace o3tl
{
    template<> struct typed_flags<ErrorHandlerFlags> : is_typed_flags<ErrorHandlerFlags, 0xffff> {};
}

class SAL_WARN_UNUSED VCL_DLLPUBLIC ErrorInfo
{
private:
    sal_uInt32             lUserId;

public:

                            ErrorInfo( sal_uInt32 lArgUserId ) :
                                lUserId( lArgUserId ){}
    virtual                 ~ErrorInfo();

    sal_uInt32             GetErrorCode() const { return lUserId; }

    static ErrorInfo*       GetErrorInfo(sal_uInt32);
};

class SAL_WARN_UNUSED VCL_DLLPUBLIC DynamicErrorInfo : public ErrorInfo
{
    friend class DynamicErrorInfo_Impl;

private:
    std::unique_ptr<DynamicErrorInfo_Impl>   pImpl;

public:

                            DynamicErrorInfo(sal_uInt32 lUserId, ErrorHandlerFlags nMask);
    virtual                 ~DynamicErrorInfo() override;

    operator                sal_uInt32() const;
    ErrorHandlerFlags       GetDialogMask() const;
};

class SAL_WARN_UNUSED VCL_DLLPUBLIC StringErrorInfo : public DynamicErrorInfo
{
private:
    OUString                aString;

public:

                            StringErrorInfo( sal_uInt32 lUserId,
                                            const OUString& aStringP,
                                            ErrorHandlerFlags nMask = ErrorHandlerFlags::NONE);
    const OUString&         GetErrorString() const { return aString; }
};

class SAL_WARN_UNUSED VCL_DLLPUBLIC TwoStringErrorInfo: public DynamicErrorInfo
{
private:
    OUString aArg1;
    OUString aArg2;

public:

    TwoStringErrorInfo(sal_uInt32 nUserID, const OUString & rTheArg1,
                       const OUString & rTheArg2, ErrorHandlerFlags nMask):
        DynamicErrorInfo(nUserID, nMask), aArg1(rTheArg1), aArg2(rTheArg2) {}

    const OUString& GetArg1() const { return aArg1; }
    const OUString& GetArg2() const { return aArg2; }
};

struct ErrorContextImpl;
class SAL_WARN_UNUSED VCL_DLLPUBLIC ErrorContext
{
    friend class ErrorHandler;

private:
    std::unique_ptr<ErrorContextImpl> pImpl;

public:
                            ErrorContext(vcl::Window *pWin);
    virtual                 ~ErrorContext();

    virtual bool            GetString( sal_uInt32 nErrId, OUString& rCtxStr ) = 0;
    vcl::Window*            GetParent();

    static ErrorContext*    GetContext();
};

typedef ErrorHandlerFlags WindowDisplayErrorFunc(
    vcl::Window *, ErrorHandlerFlags nMask, const OUString &rErr, const OUString &rAction);

typedef void BasicDisplayErrorFunc(
    const OUString &rErr, const OUString &rAction);

class SAL_WARN_UNUSED VCL_DLLPUBLIC ErrorHandler
{
    friend class ErrorHandler_Impl;

private:
    static ErrorHandlerFlags HandleError_Impl( sal_uInt32 lId,
                              ErrorHandlerFlags nFlags,
                              bool bJustCreateString,
                              OUString & rError);
protected:
    virtual bool        CreateString(const ErrorInfo *, OUString &) const = 0;

public:
                        ErrorHandler();
    virtual             ~ErrorHandler();

    static ErrorHandlerFlags HandleError ( sal_uInt32 lId, ErrorHandlerFlags nMask = ErrorHandlerFlags::MAX );
    static bool         GetErrorString( sal_uInt32 lId, OUString& rStr );

    static void         RegisterDisplay( BasicDisplayErrorFunc* );
    static void         RegisterDisplay( WindowDisplayErrorFunc* );
};

#endif
#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */