Line data    Source code

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