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 _SFX_PROGRESS_HXX
  20 #define _SFX_PROGRESS_HXX
  21
  22 #include "sal/config.h"
  23 #include "sfx2/dllapi.h"
  24 #include "sal/types.h"
  25 #include <tools/solar.h>
  26 #include <tools/link.hxx>
  27 #include <rtl/ustring.hxx>
  28
  29 class String;
  30 class SfxObjectShell;
  31 struct SfxProgress_Impl;
  32 struct PlugInLoadStatus;
  33 struct SvProgressArg;
  34
  35 //=======================================================================
  36
  37 class SFX2_DLLPUBLIC SfxProgress
  38 {
  39     SfxProgress_Impl*       pImp;
  40     sal_uIntPtr                 nVal;
  41     sal_Bool                    bSuspended;
  42
  43 public:
  44                             SfxProgress( SfxObjectShell* pObjSh,
  45                                          const String& rText,
  46                                          sal_uIntPtr nRange, sal_Bool bAllDocs = sal_False,
  47                                          sal_Bool bWait = sal_True );
  48     virtual                 ~SfxProgress();
  49
  50     virtual void            SetText( const OUString& rText );
  51     sal_Bool                    SetStateText( sal_uIntPtr nVal, const String &rVal, sal_uIntPtr nNewRange = 0 );
  52     virtual sal_Bool            SetState( sal_uIntPtr nVal, sal_uIntPtr nNewRange = 0 );
  53     sal_uIntPtr                 GetState() const { return nVal; }
  54
  55     void                    Resume();
  56     void                    Suspend();
  57     sal_Bool                    IsSuspended() const { return bSuspended; }
  58
  59     void                    UnLock();
  60     void                    Reschedule();
  61
  62     void                    Stop();
  63
  64     static SfxProgress*     GetActiveProgress( SfxObjectShell *pDocSh = 0 );
  65     static void             EnterLock();
  66     static void             LeaveLock();
  67
  68     DECL_DLLPRIVATE_STATIC_LINK( SfxProgress, SetStateHdl, PlugInLoadStatus* );
  69     DECL_DLLPRIVATE_STATIC_LINK( SfxProgress, DefaultBindingProgress, SvProgressArg* );
  70 };
  71
  72 #endif
  73
  74 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */