swfbuttn.h

Go to the documentation of this file.
00001 // $Id: swfbuttn.h 1261 2006-06-06 11:58:26Z 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 #ifndef INC_FLASH_BUTTON_RECORD
00099 #define INC_FLASH_BUTTON_RECORD
00100 
00101 #include "swfplace.h"
00102 
00103 /********************************************************************************************
00104 
00105 >   class FlashButtonRecord : public CCObject
00106 
00107     Author:     Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
00108     Created:    8/12/99
00109     Purpose:    Maintains a record of the buttons used by the Flash file.
00110 
00111 ********************************************************************************************/
00112 
00113 class FlashButtonRecord : public CCObject
00114 {
00115 public:
00116     // Constructor and destructor.
00117     FlashButtonRecord ( void );                                 // Constructor.
00118     ~FlashButtonRecord ( void );                                // Destructor.
00119 
00120     // Add and remove elements to a linked list.
00121     FlashButtonRecord*  AddElement ( void );                    // Adds an element.
00122     void                DeleteNextElement ( void );             // Deletes the next element.
00123     void                DeleteLastElement ( void );             // Deletes the last element.
00124 
00125     // Data access functions.
00126     WORD                GetButtonID ( void );                   // Gets mButtonID.
00127     WORD                GetHitID ( void );                      // Gets mHitID.
00128     WORD                GetDownID ( void );                     // Gets mDownID.
00129     WORD                GetOverID ( void );                     // Gets mOverID.
00130     WORD                GetUpID ( void );                       // Gets mUpID.
00131     WORD                GetRawHitID ( void );                   // Gets the raw mHitID.
00132     WORD                GetRawDownID ( void );                  // Gets the raw mDownID.
00133     WORD                GetRawOverID ( void );                  // Gets the raw mOverID.
00134     WORD                GetRawUpID ( void );                    // Gets the raw mUpID.
00135     DocCoord            GetHitPosition ( void );                // Gets mHitPosition.
00136     DocCoord            GetDownPosition ( void );               // Gets mDownPosition.
00137     DocCoord            GetOverPosition ( void );               // Gets mOverPosition.
00138     DocCoord            GetUpPosition ( void );                 // Gets mUpPosition.
00139     BOOL                GetTransformHit ( void );               // Gets mTransformHit.
00140     BOOL                GetTransformDown ( void );              // Gets mTransformDown.
00141     BOOL                GetTransformOver ( void );              // Gets mTransformOver.
00142     BOOL                GetTransformUp ( void );                // Gets mTransformUp.
00143     FlashType           GetHitType ( void );                    // Gets mHitType.
00144     FlashType           GetDownType ( void );                   // Gets mDownType.
00145     FlashType           GetOverType ( void );                   // Gets mOverType.
00146     FlashType           GetUpType ( void );                     // Gets mUpType.
00147     TCHAR*              GetURL ( void );                        // Gets mURL.
00148     TCHAR*              GetFrame ( void );                      // Gets mpFrame.
00149     TCHAR*              GetName ( void );                       // Gets a pointer to mName.
00150     BOOL                IsAMatch ( const TCHAR *pName );        // Do the states match?
00151     FlashButtonRecord*  GetNext ( void );                       // Gets mpNext.
00152     FlashButtonRecord*  GetLast ( void );                       // Gets mpLast.
00153 
00154     // Set value functions.
00155     void                SetButtonID ( WORD ID );                // Sets mButtonID.
00156     void                SetHitID ( WORD ID,                     // Sets mHitID.
00157                                    FlashType Type );
00158     void                SetDownID ( WORD ID,                    // Sets mDownID.
00159                                     FlashType Type );
00160     void                SetOverID ( WORD ID,                    // Sets mOverID.
00161                                     FlashType Type );
00162     void                SetUpID ( WORD ID,                      // Sets mUpID.
00163                                   FlashType Type );
00164     void                SetHitPosition ( DocCoord Position,     // Sets mHitPosition.
00165                                           BOOL DoTransform );
00166     void                SetDownPosition ( DocCoord Position,    // Sets mDownPosition.
00167                                            BOOL DoTransform );
00168     void                SetOverPosition ( DocCoord Position,    // Sets mOverPosition.
00169                                            BOOL DoTransform );
00170     void                SetUpPosition ( DocCoord Position,      // Sets mUpPosition.
00171                                          BOOL DoTransform );
00172     void                SetURL ( String_256 Address );          // Sets mURL.
00173     void                SetFrame ( TCHAR *pFrame );             // Sets mFrame.
00174     void                SetName ( const TCHAR* pName );         // Sets mName.
00175     void                SetNext ( FlashButtonRecord *pNext );   // Sets the value of mpNext.
00176     void                SetLast ( FlashButtonRecord *pLast );   // Sets the value of mpLast.
00177 
00178 private:
00179     WORD                GetActualID ( WORD ID,                  // Gets the actual Flash ID.
00180                                       FlashType Type );
00181 
00182     // Member variables.
00183     WORD                mButtonID;                              // ID value for the button.
00184 
00185     WORD                mHitID;                                 // Object used for hit test.
00186     WORD                mDownID;                                // Button down state object.
00187     WORD                mOverID;                                // Over button state object.
00188     WORD                mUpID;                                  // Release state object.
00189 
00190     FlashType           mHitType;                               // Is hit object a shape?
00191     FlashType           mDownType;                              // Is down object a shape?
00192     FlashType           mOverType;                              // Is over object a shape?
00193     FlashType           mUpType;                                // Is up object a shape?
00194 
00195     DocCoord            mHitPosition;                           // The hit state's position.
00196     DocCoord            mDownPosition;                          // The down state's position.
00197     DocCoord            mOverPosition;                          // The over state's position.
00198     DocCoord            mUpPosition;                            // The up state's position.
00199 
00200     BOOL                mTransformHit;                          // Transform hit position?
00201     BOOL                mTransformDown;                         // Transform down position?
00202     BOOL                mTransformOver;                         // Transform over position?
00203     BOOL                mTransformUp;                           // Transform up position?
00204 
00205     BOOL                mHasHit;                                // Has a hit state been set?
00206     BOOL                mHasDown;                               // Has a down state been set?
00207     BOOL                mHasOver;                               // Has an over state been set?
00208     BOOL                mHasUp;                                 // Has an up state been set?
00209 
00210     BOOL                mHasURL;                                // Has an URL name been set?
00211     BOOL                mHasFrame;                              // Has a frame name been set?
00212 
00213     String_256          mURL;                                   // Pointer to the URL called.
00214     String_256          mFrame;                                 // The frame to open URL in.
00215     String_256          mName;                                  // The name of the button.
00216 
00217     FlashButtonRecord   *mpNext;                                // Pointer to the next node.
00218     FlashButtonRecord   *mpLast;                                // Pointer to the next node.
00219 };
00220 
00221 #endif

Generated on Sat Nov 10 03:47:06 2007 for Camelot by  doxygen 1.4.4