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