framework/inc/jobs/jobconst.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 #pragma once
  21
  22 #include <rtl/ustring.hxx>
  23
  24 namespace framework
  25 {
  26 /**
  27     @short  defines all constant values used within a job environment.
  28
  29     @descr  The protocol between job executor/dispatch and jobs is fix and well defined.
  30             But why every implemented job should write such constant values directly into
  31             it's code. Typos can occur or code will be changed by new developers ...
  32             Shared set of constant values can help to improve the maintenance of this code.
  33  */
  34 class JobConst
  35 {
  36 public:
  37     static constexpr OUStringLiteral ANSWER_DEACTIVATE_JOB = u"Deactivate";
  38     static constexpr OUStringLiteral ANSWER_SAVE_ARGUMENTS = u"SaveArguments";
  39     static constexpr OUStringLiteral ANSWER_SEND_DISPATCHRESULT = u"SendDispatchResult";
  40 };
  41
  42 } // namespace framework
  43
  44 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */