include/sfx2/progress.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 #ifndef INCLUDED_SFX2_PROGRESS_HXX
  20 #define INCLUDED_SFX2_PROGRESS_HXX
  21
  22 #include <rtl/ustring.hxx>
  23 #include <sal/config.h>
  24 #include <sal/types.h>
  25 #include <sfx2/dllapi.h>
  26 #include <memory>
  27
  28
  29 class SfxObjectShell;
  30 struct SfxProgress_Impl;
  31
  32 class SFX2_DLLPUBLIC SfxProgress
  33 {
  34     std::unique_ptr< SfxProgress_Impl >       pImpl;
  35     sal_uInt32              nVal;
  36     bool                    bSuspended;
  37
  38 public:
  39                             SfxProgress( SfxObjectShell* pObjSh,
  40                                          const OUString& rText,
  41                                          sal_uInt32 nRange,
  42                                          bool bWait = true);
  43     virtual                 ~SfxProgress();
  44
  45     void                    SetState( sal_uInt32 nVal, sal_uInt32 nNewRange = 0 );
  46     sal_uInt32              GetState() const { return nVal; }
  47
  48     void                    Resume();
  49     void                    Suspend();
  50     bool                    IsSuspended() const { return bSuspended; }
  51
  52     static void             Reschedule();
  53
  54     void                    Stop();
  55
  56     static SfxProgress*     GetActiveProgress( SfxObjectShell const *pDocSh = nullptr );
  57     static void             EnterLock();
  58     static void             LeaveLock();
  59 };
  60
  61 #endif
  62
  63 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */