00001 // $Id: ktimer.cpp 1080 2006-05-16 13:24:45Z 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 00100 #include "camtypes.h" 00101 00102 #include "ktimer.h" 00103 00104 CC_IMPLEMENT_DYNAMIC(KernelTimer, CCObject); 00105 CC_IMPLEMENT_DYNAMIC(TimerMsg, Msg); 00106 00107 // Note all the implementation is in the .h file, so this is really just IMPLEMENT_DYNAMIC and some 00108 // documentation 00109 00110 /******************************************************************************************** 00111 00112 > KernelTimer::KernelTimer(CCRuntimeClass * BroadcastClass = NULL) 00113 00114 Author: Alex_Bligh <alex@alex.org.uk> 00115 Created: 25/04/2005 00116 Inputs: BroadcastClass - the class to broadcast to, or NULL for all 00117 Outputs: None 00118 Returns: - 00119 Purpose: Constructor 00120 Errors: - 00121 SeeAlso: - 00122 00123 Use BroadcastClass to restrict the amount of broadcast traffic, e.g. 00124 KernelTimer MyTimer(CC_RUNTIME_CLASS(DialogOp)); 00125 00126 ********************************************************************************************/ 00127 00128 /******************************************************************************************** 00129 00130 > void KernelTimer::SetBroadcastClass (CCRuntimeClass * BroadcastClass) 00131 00132 Author: Alex_Bligh <alex@alex.org.uk> 00133 Created: 25/04/2005 00134 Inputs: BroadcastClass - the class to broadcast to, or NULL for all 00135 Outputs: None 00136 Returns: - 00137 Purpose: Change the broadcast class 00138 Errors: - 00139 SeeAlso: - 00140 00141 ********************************************************************************************/ 00142 00143 /******************************************************************************************** 00144 00145 > CCRuntimeClass * KernelTimer::GetBroadcastClass () const 00146 00147 Author: Alex_Bligh <alex@alex.org.uk> 00148 Created: 25/04/2005 00149 Inputs: None 00150 Outputs: None 00151 Returns: The current broadcast class 00152 Purpose: Return the current broadcast class 00153 Errors: - 00154 SeeAlso: - 00155 00156 ********************************************************************************************/ 00157 00158 /******************************************************************************************** 00159 00160 > virtual void KernelTimer::Notify() 00161 00162 Author: Alex_Bligh <alex@alex.org.uk> 00163 Created: 25/04/2005 00164 Inputs: None 00165 Outputs: None 00166 Returns: None 00167 Purpose: Called when a timer event occurs 00168 Errors: - 00169 SeeAlso: - 00170 00171 This function by default broadcasts a TimerMsg::Notify to all message handlers (or 00172 to the subset set up in the constructor or KernelTimer::SetBroadcast). It can be 00173 overridden to do something else (or something additional). 00174 00175 ********************************************************************************************/ 00176 00177 /******************************************************************************************** 00178 00179 > virtual void KernelTimer::GetInterval() 00180 00181 Author: Alex_Bligh <alex@alex.org.uk> 00182 Created: 25/04/2005 00183 Inputs: None 00184 Outputs: None 00185 Returns: Current interval 00186 Purpose: Returns the current interval that has been set 00187 Errors: - 00188 SeeAlso: - 00189 00190 ********************************************************************************************/ 00191 00192 /******************************************************************************************** 00193 00194 > BOOL KernelTimer::IsOneShost() const 00195 00196 Author: Alex_Bligh <alex@alex.org.uk> 00197 Created: 25/04/2005 00198 Inputs: None 00199 Outputs: None 00200 Returns: TRUE if the timer is one shot, FALSE if the timer repeats 00201 Purpose: - 00202 Errors: - 00203 SeeAlso: - 00204 00205 ********************************************************************************************/ 00206 00207 /******************************************************************************************** 00208 00209 > BOOL KernelTimer::IsRunning() const 00210 00211 Author: Alex_Bligh <alex@alex.org.uk> 00212 Created: 25/04/2005 00213 Inputs: None 00214 Outputs: None 00215 Returns: TRUE if the timer is running, FALSE otherwise 00216 Purpose: - 00217 Errors: - 00218 SeeAlso: - 00219 00220 ********************************************************************************************/ 00221 00222 /******************************************************************************************** 00223 00224 > BOOL KernelTimer::Start(INT32 milliseconds = -1, BOOL OneShot = FALSE) 00225 00226 Author: Alex_Bligh <alex@alex.org.uk> 00227 Created: 25/04/2005 00228 Inputs: milliseconds - number of ms until the next timer events (or between events) 00229 or -1 to use the previous value 00230 OneShot - TRUE to make it a one shot rather than repeating timer 00231 Outputs: None 00232 Returns: TRUE if the timer was successfully started 00233 Purpose: - 00234 Errors: - 00235 SeeAlso: - 00236 00237 ********************************************************************************************/ 00238 00239 /******************************************************************************************** 00240 00241 > BOOL void KernelTimer::Stop() 00242 00243 Author: Alex_Bligh <alex@alex.org.uk> 00244 Created: 25/04/2005 00245 Inputs: None 00246 Outputs: None 00247 Returns: TRUE if the timer was successfully stopped 00248 Purpose: - 00249 Errors: - 00250 SeeAlso: - 00251 00252 ********************************************************************************************/ 00253
1.4.4