PCL
ProgressBarStatus.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.7.0
6 // ----------------------------------------------------------------------------
7 // pcl/ProgressBarStatus.h - Released 2024-06-18T15:48:54Z
8 // ----------------------------------------------------------------------------
9 // This file is part of the PixInsight Class Library (PCL).
10 // PCL is a multiplatform C++ framework for development of PixInsight modules.
11 //
12 // Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
13 //
14 // Redistribution and use in both source and binary forms, with or without
15 // modification, is permitted provided that the following conditions are met:
16 //
17 // 1. All redistributions of source code must retain the above copyright
18 // notice, this list of conditions and the following disclaimer.
19 //
20 // 2. All redistributions in binary form must reproduce the above copyright
21 // notice, this list of conditions and the following disclaimer in the
22 // documentation and/or other materials provided with the distribution.
23 //
24 // 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
25 // of their contributors, may be used to endorse or promote products derived
26 // from this software without specific prior written permission. For written
27 // permission, please contact info@pixinsight.com.
28 //
29 // 4. All products derived from this software, in any form whatsoever, must
30 // reproduce the following acknowledgment in the end-user documentation
31 // and/or other materials provided with the product:
32 //
33 // "This product is based on software from the PixInsight project, developed
34 // by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
35 //
36 // Alternatively, if that is where third-party acknowledgments normally
37 // appear, this acknowledgment must be reproduced in the product itself.
38 //
39 // THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
40 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
41 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
43 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
44 // EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
45 // INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
46 // DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49 // POSSIBILITY OF SUCH DAMAGE.
50 // ----------------------------------------------------------------------------
51 
52 #ifndef __PCL_ProgressBarStatus_h
53 #define __PCL_ProgressBarStatus_h
54 
56 
57 #ifndef __PCL_BUILDING_PIXINSIGHT_APPLICATION
58 
59 #include <pcl/Defs.h>
60 
61 #include <pcl/AutoPointer.h>
62 #include <pcl/Control.h>
63 #include <pcl/StatusMonitor.h>
64 
65 namespace pcl
66 {
67 
68 // ----------------------------------------------------------------------------
69 
70 class PCL_CLASS ProgressDialog;
71 
85 class PCL_CLASS ProgressBarStatus : public StatusCallback
86 {
87 public:
88 
98  ProgressBarStatus( const String& title, Control& parent = Control::Null() );
99 
103  ~ProgressBarStatus() override;
104 
109  int Initialized( const StatusMonitor& monitor ) const override;
110 
115  int Updated( const StatusMonitor& monitor ) const override;
116 
121  int Completed( const StatusMonitor& monitor ) const override;
122 
127  void InfoUpdated( const StatusMonitor& monitor ) const override;
128 
129 private:
130 
131  mutable AutoPointer<ProgressDialog> m_progressDialog;
132 };
133 
134 // ----------------------------------------------------------------------------
135 
136 } // pcl
137 
138 #endif // __PCL_BUILDING_PIXINSIGHT_APPLICATION
139 
140 #endif // __PCL_ProgressBarStatus_h
141 
142 // ----------------------------------------------------------------------------
143 // EOF pcl/ProgressBarStatus.h - Released 2024-06-18T15:48:54Z
A smart pointer with exclusive object ownership and optional automatic object destruction.
Definition: AutoPointer.h:241
Client-side interface to a PixInsight Control object.
Definition: Control.h:126
static Control & Null()
A status monitoring callback that shows a modal progress dialog.
int Updated(const StatusMonitor &monitor) const override
~ProgressBarStatus() override
void InfoUpdated(const StatusMonitor &monitor) const override
int Initialized(const StatusMonitor &monitor) const override
ProgressBarStatus(const String &title, Control &parent=Control::Null())
int Completed(const StatusMonitor &monitor) const override
Provides status monitoring callback functions.
Definition: StatusMonitor.h:98
An asynchronous status monitoring system.
Unicode (UTF-16) string.
Definition: String.h:8113
PCL root namespace.
Definition: AbstractImage.h:77