00001 // $Id: progress.h 1282 2006-06-09 09:46:49Z alex $ 00002 /* @@tag:xara-cn@@ DO NOT MODIFY THIS LINE 00003 ================================XARAHEADERSTART=========================== 00004 00005 Xara LX, a vector drawing and manipulation program. 00006 Copyright (C) 1993-2006 Xara Group Ltd. 00007 Copyright on certain contributions may be held in joint with their 00008 respective authors. See AUTHORS file for details. 00009 00010 LICENSE TO USE AND MODIFY SOFTWARE 00011 ---------------------------------- 00012 00013 This file is part of Xara LX. 00014 00015 Xara LX is free software; you can redistribute it and/or modify it 00016 under the terms of the GNU General Public License version 2 as published 00017 by the Free Software Foundation. 00018 00019 Xara LX and its component source files are distributed in the hope 00020 that it will be useful, but WITHOUT ANY WARRANTY; without even the 00021 implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 00022 See the GNU General Public License for more details. 00023 00024 You should have received a copy of the GNU General Public License along 00025 with Xara LX (see the file GPL in the root directory of the 00026 distribution); if not, write to the Free Software Foundation, Inc., 51 00027 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 00028 00029 00030 ADDITIONAL RIGHTS 00031 ----------------- 00032 00033 Conditional upon your continuing compliance with the GNU General Public 00034 License described above, Xara Group Ltd grants to you certain additional 00035 rights. 00036 00037 The additional rights are to use, modify, and distribute the software 00038 together with the wxWidgets library, the wxXtra library, and the "CDraw" 00039 library and any other such library that any version of Xara LX relased 00040 by Xara Group Ltd requires in order to compile and execute, including 00041 the static linking of that library to XaraLX. In the case of the 00042 "CDraw" library, you may satisfy obligation under the GNU General Public 00043 License to provide source code by providing a binary copy of the library 00044 concerned and a copy of the license accompanying it. 00045 00046 Nothing in this section restricts any of the rights you have under 00047 the GNU General Public License. 00048 00049 00050 SCOPE OF LICENSE 00051 ---------------- 00052 00053 This license applies to this program (XaraLX) and its constituent source 00054 files only, and does not necessarily apply to other Xara products which may 00055 in part share the same code base, and are subject to their own licensing 00056 terms. 00057 00058 This license does not apply to files in the wxXtra directory, which 00059 are built into a separate library, and are subject to the wxWindows 00060 license contained within that directory in the file "WXXTRA-LICENSE". 00061 00062 This license does not apply to the binary libraries (if any) within 00063 the "libs" directory, which are subject to a separate license contained 00064 within that directory in the file "LIBS-LICENSE". 00065 00066 00067 ARRANGEMENTS FOR CONTRIBUTION OF MODIFICATIONS 00068 ---------------------------------------------- 00069 00070 Subject to the terms of the GNU Public License (see above), you are 00071 free to do whatever you like with your modifications. However, you may 00072 (at your option) wish contribute them to Xara's source tree. You can 00073 find details of how to do this at: 00074 http://www.xaraxtreme.org/developers/ 00075 00076 Prior to contributing your modifications, you will need to complete our 00077 contributor agreement. This can be found at: 00078 http://www.xaraxtreme.org/developers/contribute/ 00079 00080 Please note that Xara will not accept modifications which modify any of 00081 the text between the start and end of this header (marked 00082 XARAHEADERSTART and XARAHEADEREND). 00083 00084 00085 MARKS 00086 ----- 00087 00088 Xara, Xara LX, Xara X, Xara X/Xtreme, Xara Xtreme, the Xtreme and Xara 00089 designs are registered or unregistered trademarks, design-marks, and/or 00090 service marks of Xara Group Ltd. All rights in these marks are reserved. 00091 00092 00093 Xara Group Ltd, Gaddesden Place, Hemel Hempstead, HP2 6EX, UK. 00094 http://www.xara.com/ 00095 00096 =================================XARAHEADEREND============================ 00097 */ 00098 00099 // The progress indicator, for slow jobs (kernel interface). 00100 00101 #ifndef PROGRESS__INC 00102 #define PROGRESS__INC 00103 00104 //#include "list.h" - in camtypes.h [AUTOMATICALLY REMOVED] 00105 00106 // **** DEPRECATED INTERFACE **** 00107 // Use the calls provided by the ProgressState class (kernel\progstat.h) in future. DO NOT USE these ones! 00108 BOOL BeginSlowJob(INT32 final = -1, BOOL delay = TRUE, String_64 *Description = NULL); 00109 BOOL ContinueSlowJob(INT32 upto = 0); 00110 void EndSlowJob(void); 00111 void SmashSlowJob(void); 00112 // **** -------------------- **** 00113 00114 /******************************************************************************************** 00115 00116 > class Progress : public CC_CLASS_MEMDUMP 00117 00118 Author: Jason_Williams (Xara Group Ltd) <camelotdev@xara.com> 00119 Created: 11/12/95 00120 00121 Purpose: Encapsulates progress displays in a tidy class layout. 00122 As well as providing a tidier static interface which emulates the old 00123 'SlowJob' system, a local instance of this class can be created in your 00124 busy function, which will _automatically_ turn off progress indications 00125 when it is destructed on exit from your function. 00126 00127 Notes: You shouldn't call the Progress class directly. Use ProgressState instead 00128 00129 SeeAlso: class ProgressState; Progress::Start; Progress::Progress 00130 00131 ********************************************************************************************/ 00132 00133 class String_64; 00134 class MonotonicTime; 00135 00136 00137 class Progress : public CC_CLASS_MEMDUMP 00138 { 00139 CC_DECLARE_MEMDUMP(Progress) 00140 00141 public: // Initialisation/Deinitialisation 00142 static BOOL Init(void); 00143 // Returns FALSE if initialisation failed 00144 00145 static BOOL Deinit(void); 00146 // Returns FALSE if deinitialisation failed 00147 00148 00149 public: // External interface 00150 Progress(); 00151 // Do not use this constructor, except in special circumstances 00152 00153 Progress(StringBase *Description, INT32 FinalCount = -1,BOOL Delay = TRUE, BOOL bEnable = TRUE); 00154 Progress(UINT32 DescriptionID, INT32 FinalCount = -1,BOOL Delay = TRUE, BOOL bEnable = TRUE); 00155 ~Progress(); 00156 // An instance of this class will automatically start a progresss 00157 // indication going, and stop it again on destruction 00158 00159 public: 00160 static void Start(BOOL Delay = FALSE, StringBase *Description = NULL, INT32 FinalCount = -1); 00161 static void Start(BOOL Delay, UINT32 DescriptionID, INT32 FinalCount = -1); 00162 // Start a progress indication going 00163 00164 static BOOL Update(INT32 CurrentCount = 0,BOOL FreqEscChecks = FALSE); 00165 // Update the progress indicator. 00166 // Called to change the displayed percentage and implement show-with-delay. 00167 00168 static void Stop(void); 00169 // Stop a progress indication going 00170 00171 static void Smash(BOOL ForceSmash = FALSE); 00172 // Stop all current progress indications 00173 00174 static void SetFinalCount(INT32 n); 00175 // Allows you to set the final count after construction. Use before you call Update(). 00176 // Only updates the count if this is the only progress object around. 00177 00178 // Functions for maintaining a count var for this instance of a Progress object 00179 // These are provided for convenience 00180 INT32 GetCount(INT32 n=0); // Get the current count, and add 'n' to it, while you're at it 00181 void ResetCount(INT32 n=0); // Reset the count to 'n' 00182 00183 static BOOL SetDescription(const StringBase* const Description); 00184 00185 static void RalphAbortJob(){AbortJob = TRUE;}; 00186 static void ClearRalphAbortJob(){AbortJob = FALSE;}; 00187 static BOOL IsRalphAbort(){return AbortJob;}; 00188 00189 public: 00190 static void ThreadCallback(void); 00191 // INTERNAL USE ONLY. Called back by a thread for delayed-show of the hourglass 00192 00193 00194 protected: // Internal state variables 00195 static INT32 ActiveDisplays; // A count of the number of active progress incarnations 00196 static BOOL JobCancelled; // TRUE if the job has been cancelled 00197 00198 static BOOL JobDelayed; // TRUE if the hourglass startup is delayed 00199 00200 static INT32 FinalCount; // The number we're currently counting up to 00201 static INT32 CurrentPercent; // The last percentage that we displayed 00202 00203 static BOOL HourglassShown; // TRUE if we have already shown the hourglass 00204 00205 static String_64 JobDescription; // A description of the current job 00206 static BOOL HaveJobDescription; // TRUE if we have a proper caller-supplied job description 00207 00208 static MonotonicTime StartTime; // Time the first call to Show() was made 00209 00210 // static CProgressBar *ProgBar; // The progress bar object (if used) 00211 00212 static BOOL AbortJob; // used to abort jobs in ralph - fake an escape condition 00213 protected: // Preferences 00214 static INT32 DisplayBar; // Preference: Is progress bar shown? 00215 00216 // The current count for this instance of a progress object 00217 INT32 ProgressCount; 00218 }; 00219 00220 00221 #endif // PROGRESS__INC
1.4.4