LibreOffice Module xmloff (master) 1
ProgressBarHelper.hxx
Go to the documentation of this file.
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_XMLOFF_PROGRESSBARHELPER_HXX
21#define INCLUDED_XMLOFF_PROGRESSBARHELPER_HXX
22
23#include <sal/config.h>
24#include <xmloff/dllapi.h>
25#include <com/sun/star/task/XStatusIndicator.hpp>
26
27inline constexpr OUStringLiteral XML_PROGRESSRANGE = u"ProgressRange";
28inline constexpr OUStringLiteral XML_PROGRESSMAX = u"ProgressMax";
29inline constexpr OUStringLiteral XML_PROGRESSCURRENT = u"ProgressCurrent";
30inline constexpr OUStringLiteral XML_PROGRESSREPEAT = u"ProgressRepeat";
31
33{
34 css::uno::Reference < css::task::XStatusIndicator > xStatusIndicator;
35 sal_Int32 nRange;
36 sal_Int32 nReference;
37 sal_Int32 nValue;
39 bool bStrict;
40 // #96469#; if the value goes over the Range the progressbar starts again
41 bool bRepeat;
42
43#ifdef DBG_UTIL
45#endif
46public:
47 ProgressBarHelper(css::uno::Reference < css::task::XStatusIndicator> xStatusIndicator,
48 const bool bStrict);
50
51 void SetRange(sal_Int32 nVal) { nRange = nVal; }
52 void SetReference(sal_Int32 nVal) { nReference = nVal; }
53 void SetValue(sal_Int32 nValue);
54 void SetRepeat(bool bValue) { bRepeat = bValue; }
55 void Increment(sal_Int32 nInc = 1) { SetValue( nValue+nInc ); }
56 void End() { if (xStatusIndicator.is()) xStatusIndicator->end(); }
57
58 // set the new reference and returns the new value which gives the
59 // Progress Bar the same position as before
60 void ChangeReference(sal_Int32 nNewReference);
61
62 sal_Int32 GetReference() const { return nReference; }
63 sal_Int32 GetValue() const { return nValue; }
64 bool GetRepeat() const { return bRepeat; }
65};
66
67#endif
68
69/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
constexpr OUStringLiteral XML_PROGRESSRANGE
constexpr OUStringLiteral XML_PROGRESSMAX
constexpr OUStringLiteral XML_PROGRESSCURRENT
constexpr OUStringLiteral XML_PROGRESSREPEAT
void SetRepeat(bool bValue)
css::uno::Reference< css::task::XStatusIndicator > xStatusIndicator
void SetReference(sal_Int32 nVal)
sal_Int32 GetReference() const
sal_Int32 GetValue() const
void Increment(sal_Int32 nInc=1)
void SetRange(sal_Int32 nVal)
virtual void SetValue(tools::Long nNew) override
#define XMLOFF_DLLPUBLIC
Definition: dllapi.h:29
float u
sal_Int16 nValue