svtools/source/misc/ehdl.cxx

   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 #include <unotools/resmgr.hxx>
  21 #include <utility>
  22 #include <vcl/stdtext.hxx>
  23 #include <vcl/svapp.hxx>
  24 #include <vcl/weld.hxx>
  25 #include <sal/log.hxx>
  26
  27 #include <svtools/ehdl.hxx>
  28 #include <svtools/svtresid.hxx>
  29 #include <svtools/sfxecode.hxx>
  30 #include <memory>
  31 #include <errtxt.hrc>
  32
  33 static DialogMask aWndFunc(
  34     weld::Window *pWin,            // Parent of the dialog
  35     DialogMask nFlags,
  36     const OUString &rErr,      // error text
  37     const OUString &rAction)   // action text
  38
  39 /*  [Description]
  40
  41     Draw an errorbox on the screen. Depending on nFlags
  42     Error/Info etc. boxes with the requested buttons are shown.
  43
  44     Returnvalue is the button pressed
  45
  46     */
  47
  48
  49 {
  50     SolarMutexGuard aGuard;
  51
  52     // determine necessary WinBits from the flags
  53     VclButtonsType eButtonsType = VclButtonsType::NONE;
  54     bool bAddRetry = false;
  55     if ( (nFlags & (DialogMask::ButtonsCancel | DialogMask::ButtonsRetry)) == (DialogMask::ButtonsCancel | DialogMask::ButtonsRetry))
  56     {
  57         bAddRetry = true;
  58         eButtonsType = VclButtonsType::Cancel;
  59     }
  60     else if ( (nFlags & DialogMask::ButtonsOk) == DialogMask::ButtonsOk )
  61         eButtonsType = VclButtonsType::Ok;
  62     else if ( (nFlags & DialogMask::ButtonsYesNo) == DialogMask::ButtonsYesNo )
  63         eButtonsType = VclButtonsType::YesNo;
  64
  65     OUString aErr(u"$(ACTION)$(ERROR)"_ustr);
  66     OUString aAction(rAction);
  67     if ( !aAction.isEmpty() )
  68         aAction += ":\n";
  69     aErr = aErr.replaceAll("$(ACTION)", aAction);
  70     aErr = aErr.replaceAll("$(ERROR)", rErr);
  71
  72     VclMessageType eMessageType;
  73     switch (nFlags & DialogMask(0xf000))
  74     {
  75         case DialogMask::MessageError:
  76             eMessageType = VclMessageType::Error;
  77             break;
  78
  79         case DialogMask::MessageWarning:
  80             eMessageType = VclMessageType::Warning;
  81             break;
  82
  83         case DialogMask::MessageInfo:
  84             eMessageType = VclMessageType::Info;
  85             break;
  86
  87         default:
  88         {
  89             SAL_WARN( "svtools.misc", "no MessBox type");
  90             return DialogMask::ButtonsOk;
  91         }
  92     }
  93
  94     std::unique_ptr<weld::MessageDialog> xBox(Application::CreateMessageDialog(pWin,
  95                                               eMessageType, eButtonsType, aErr));
  96
  97     if (bAddRetry)
  98         xBox->add_button(GetStandardText(StandardButtonType::Retry), RET_RETRY);
  99
 100     switch(nFlags & DialogMask(0x0f00))
 101     {
 102         case DialogMask::ButtonDefaultsOk:
 103             xBox->set_default_response(RET_OK);
 104             break;
 105         case DialogMask::ButtonDefaultsCancel:
 106             xBox->set_default_response(RET_CANCEL);
 107             break;
 108         case DialogMask::ButtonDefaultsYes:
 109             xBox->set_default_response(RET_YES);
 110             break;
 111         case DialogMask::ButtonDefaultsNo:
 112             xBox->set_default_response(RET_NO);
 113             break;
 114         default:
 115             break;
 116     }
 117
 118     DialogMask nRet = DialogMask::NONE;
 119     switch (xBox->run())
 120     {
 121         case RET_OK:
 122             nRet = DialogMask::ButtonsOk;
 123             break;
 124         case RET_CANCEL:
 125             nRet = DialogMask::ButtonsCancel;
 126             break;
 127         case RET_RETRY:
 128             nRet = DialogMask::ButtonsRetry;
 129             break;
 130         case RET_YES:
 131             nRet = DialogMask::ButtonsYes;
 132             break;
 133         case RET_NO:
 134             nRet = DialogMask::ButtonsNo;
 135             break;
 136         default:
 137             SAL_WARN( "svtools.misc", "Unknown MessBox return value" );
 138             break;
 139     }
 140
 141     return nRet;
 142 }
 143
 144 SfxErrorHandler::SfxErrorHandler(const ErrMsgCode* pIdPs, ErrCodeArea lStartP, ErrCodeArea lEndP, const std::locale& rLocale)
 145     : lStart(lStartP), lEnd(lEndP), pIds(pIdPs), aResLocale(rLocale)
 146 {
 147     ErrorRegistry::RegisterDisplay(&aWndFunc);
 148 }
 149
 150 SfxErrorHandler::~SfxErrorHandler()
 151 {
 152 }
 153
 154 bool SfxErrorHandler::CreateString(const ErrCodeMsg& nErr, OUString &rStr) const
 155
 156 /*  [Description]
 157
 158     Assemble error string for the ErrorInfo pErr.
 159
 160     */
 161
 162 {
 163     ErrCode nErrCode(sal_uInt32(nErr.GetCode()) & ERRCODE_ERROR_MASK);
 164     if (nErr.GetCode().GetArea() < lStart || lEnd < nErr.GetCode().GetArea())
 165         return false;
 166     if(GetErrorString(nErrCode, rStr))
 167     {
 168         if(!nErr.GetArg1().isEmpty())
 169             rStr = rStr.replaceAll("$(ARG1)", nErr.GetArg1());
 170         if(!nErr.GetArg2().isEmpty())
 171             rStr = rStr.replaceAll("$(ARG2)", nErr.GetArg2());
 172         return true;
 173     }
 174     return false;
 175 }
 176
 177 void SfxErrorHandler::GetClassString(ErrCodeClass lClassId, OUString &rStr)
 178
 179 /*  [Description]
 180
 181     Creates the string for the class of the error. Will always
 182     be read from the resource of the Sfx.
 183
 184     */
 185
 186 {
 187     for (const std::pair<TranslateId, ErrCodeClass>* pItem = RID_ERRHDL_CLASS; pItem->first; ++pItem)
 188     {
 189         if (pItem->second == lClassId)
 190         {
 191             rStr = SvtResId(pItem->first);
 192             break;
 193         }
 194     }
 195 }
 196
 197 bool SfxErrorHandler::GetErrorString(ErrCode lErrId, OUString &rStr) const
 198
 199 /*  [Description]
 200
 201     Creates the error string for the actual error
 202     without its class
 203
 204     */
 205
 206 {
 207     bool bRet = false;
 208     rStr = "$(CLASS)$(ERROR)";
 209
 210     for (const ErrMsgCode* pItem = pIds; pItem->second; ++pItem)
 211     {
 212         if (pItem->second.StripWarning() == lErrId.StripWarning())
 213         {
 214             rStr = rStr.replaceAll("$(ERROR)", Translate::get(pItem->first, aResLocale));
 215             bRet = true;
 216             break;
 217         }
 218     }
 219
 220     if( bRet )
 221     {
 222         OUString aErrStr;
 223         GetClassString(lErrId.GetClass(), aErrStr);
 224         if(!aErrStr.isEmpty())
 225             aErrStr += ".\n";
 226         rStr = rStr.replaceAll("$(CLASS)",aErrStr);
 227     }
 228
 229     return bRet;
 230 }
 231
 232 SfxErrorContext::SfxErrorContext(
 233     sal_uInt16 nCtxIdP, weld::Window *pWindow, const ErrMsgCode* pIdsP, const std::locale& rResLocaleP)
 234 :   ErrorContext(pWindow), nCtxId(nCtxIdP), pIds(pIdsP), aResLocale(rResLocaleP)
 235 {
 236     if (!pIds)
 237         pIds = RID_ERRCTX;
 238 }
 239
 240
 241 SfxErrorContext::SfxErrorContext(
 242     sal_uInt16 nCtxIdP, OUString aArg1P, weld::Window *pWindow,
 243     const ErrMsgCode* pIdsP, const std::locale& rResLocaleP)
 244 :   ErrorContext(pWindow), nCtxId(nCtxIdP), pIds(pIdsP), aResLocale(rResLocaleP),
 245     aArg1(std::move(aArg1P))
 246 {
 247     if (!pIds)
 248         pIds = RID_ERRCTX;
 249 }
 250
 251 bool SfxErrorContext::GetString(const ErrCodeMsg& nErr, OUString &rStr)
 252
 253 /*  [Description]
 254
 255     Constructs the description of an error context
 256     */
 257
 258 {
 259     bool bRet = false;
 260     for (const ErrMsgCode* pItem = pIds; pItem->second; ++pItem)
 261     {
 262         if (sal_uInt32(pItem->second) == nCtxId)
 263         {
 264             rStr = Translate::get(pItem->first, aResLocale);
 265             rStr = rStr.replaceAll("$(ARG1)", aArg1);
 266             bRet = true;
 267             break;
 268         }
 269     }
 270
 271     SAL_WARN_IF(!bRet, "svtools.misc", "ErrorContext cannot find the resource");
 272
 273     if ( bRet )
 274     {
 275         sal_uInt16 nId = nErr.IsWarning() ? ERRCTX_WARNING : ERRCTX_ERROR;
 276         for (const ErrMsgCode* pItem = RID_ERRCTX; pItem->second; ++pItem)
 277         {
 278             if (sal_uInt32(pItem->second) == nId)
 279             {
 280                 rStr = rStr.replaceAll("$(ERR)", Translate::get(pItem->first, aResLocale));
 281                 break;
 282             }
 283         }
 284     }
 285
 286     // SfxInPlaceClient::DoVerb adds some extra info to report
 287     if (bRet && nErr.GetCode() == ERRCODE_SO_GENERALERROR && !nErr.GetArg1().isEmpty())
 288             rStr += "\n" + nErr.GetArg1();
 289
 290     return bRet;
 291 }
 292
 293 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */