include/vcl/errinf.hxx

   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
  20 #ifndef INCLUDED_VCL_ERRINF_HXX
  21 #define INCLUDED_VCL_ERRINF_HXX
  22
  23 #include <rtl/ustring.hxx>
  24 #include <comphelper/errcode.hxx>
  25 #include <vcl/dllapi.h>
  26
  27 #include <vector>
  28 #include <memory>
  29
  30 namespace weld { class Window; }
  31
  32 class ErrorHandler;
  33 class ErrorContext;
  34 enum class DialogMask;
  35
  36 class UNLESS_MERGELIBS(VCL_DLLPUBLIC) ErrorStringFactory
  37 {
  38 public:
  39     static bool CreateString(const ErrCodeMsg&, OUString&);
  40 };
  41
  42 typedef void (* DisplayFnPtr)();
  43
  44 typedef DialogMask WindowDisplayErrorFunc(
  45     weld::Window*, DialogMask eMask, const OUString &rErr, const OUString &rAction);
  46
  47 typedef void BasicDisplayErrorFunc(
  48     const OUString &rErr, const OUString &rAction);
  49
  50 class VCL_DLLPUBLIC ErrorRegistry
  51 {
  52     friend class ErrorHandler;
  53     friend class ErrorContext;
  54     friend class ErrorStringFactory;
  55
  56 public:
  57                                 ErrorRegistry();
  58
  59     static void                 RegisterDisplay(BasicDisplayErrorFunc*);
  60     static void                 RegisterDisplay(WindowDisplayErrorFunc*);
  61
  62     static void SetLock(bool bLock);
  63     static bool GetLock();
  64
  65     static void                 Reset();
  66
  67 private:
  68     DisplayFnPtr                pDsp;
  69     bool                        bIsWindowDsp;
  70
  71     bool m_bLock;
  72
  73     std::vector<ErrorHandler*>  errorHandlers;
  74     std::vector<ErrorContext*>  contexts;
  75 };
  76
  77 class SAL_WARN_UNUSED VCL_DLLPUBLIC ErrorHandler
  78 {
  79     friend class ErrorStringFactory;
  80
  81 public:
  82                             ErrorHandler();
  83     virtual                 ~ErrorHandler();
  84
  85     /** Handles an error.
  86
  87         If nFlags is not set, the DynamicErrorInfo flags or the
  88         resource flags will be used. Thus the order is:
  89
  90         1. nFlags,
  91         2. Resource Flags
  92         3. Dynamic Flags
  93         4. Default ButtonsOk, MessageError
  94
  95         @param nErrCodeId        error id
  96         @param pParent           parent window the error dialog will be modal for. nullptr for unrecommended "pick default"
  97         @param nFlags            error flags.
  98
  99         @return what sort of dialog to use, with what buttons
 100     */
 101     static DialogMask       HandleError(const ErrCodeMsg& nId, weld::Window* pParent = nullptr, DialogMask nMask = DialogMask::MAX);
 102     static bool             GetErrorString(const ErrCodeMsg& nId, OUString& rStr);
 103
 104 protected:
 105     virtual bool            CreateString(const ErrCodeMsg&, OUString &) const = 0;
 106
 107 };
 108
 109 struct ImplErrorContext;
 110
 111 class SAL_WARN_UNUSED VCL_DLLPUBLIC ErrorContext
 112 {
 113     friend class ErrorHandler;
 114
 115 public:
 116                             ErrorContext(weld::Window *pWin);
 117     virtual                 ~ErrorContext();
 118
 119     virtual bool            GetString(const ErrCodeMsg& nErrId, OUString& rCtxStr) = 0;
 120     weld::Window*           GetParent();
 121
 122     static ErrorContext*    GetContext();
 123
 124 private:
 125     std::unique_ptr<ImplErrorContext> pImpl;
 126
 127 };
 128
 129 #endif
 130
 131 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */