Main Page | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Search for 

FlashButtonRecord Class Reference

Maintains a record of the buttons used by the Flash file. More...

#include <swfbuttn.h>

Inheritance diagram for FlashButtonRecord:

CCObject SimpleCCObject List of all members.

Public Member Functions

 FlashButtonRecord (void)
 Creates a FlashButtonRecord list node, and initialises all member variables.
 ~FlashButtonRecord (void)
 Destroys this instance of FlashButtonRecord.
FlashButtonRecord * AddElement (void)
 Adds an element to the tail of the list.
void DeleteNextElement (void)
 Deletes the next item in the list.
void DeleteLastElement (void)
 Deletes the previous item in the list.
WORD GetButtonID (void)
 Gets the value of mButtonID.
WORD GetHitID (void)
 Gets the value of mHitID.
WORD GetDownID (void)
 Gets the value of mDownID.
WORD GetOverID (void)
 Gets the value of mOverID.
WORD GetUpID (void)
 Gets the value of mUpID.
WORD GetRawHitID (void)
 Gets the raw value of mHitID.
WORD GetRawDownID (void)
 Gets the raw value of mDownID.
WORD GetRawOverID (void)
 Gets the raw value of mOverID.
WORD GetRawUpID (void)
 Gets the raw value of mUpID.
DocCoord GetHitPosition (void)
 Gets the position of this button state.
DocCoord GetDownPosition (void)
 Gets the position of this button state.
DocCoord GetOverPosition (void)
 Gets the position of this button state.
DocCoord GetUpPosition (void)
 Gets the position of this button state..
BOOL GetTransformHit (void)
 Do these co-ordinates need to be transformed into Flash co-ordinates? This is included to allow objects to be positioned at (0, 0).
BOOL GetTransformDown (void)
 Do these co-ordinates need to be transformed into Flash co-ordinates? This is included to allow objects to be positioned at (0, 0).
BOOL GetTransformOver (void)
 Do these co-ordinates need to be transformed into Flash co-ordinates? This is included to allow objects to be positioned at (0, 0).
BOOL GetTransformUp (void)
 Do these co-ordinates need to be transformed into Flash co-ordinates? This is included to allow objects to be positioned at (0, 0).
FlashType GetHitType (void)
 Gets the class of object that is to be rendered in this button state.
FlashType GetDownType (void)
 Gets the class of object that is to be rendered in this button state.
FlashType GetOverType (void)
 Gets the class of object that is to be rendered in this button state.
FlashType GetUpType (void)
 Gets the class of object that is to be rendered in this button state.
TCHAR * GetURL (void)
 Gets the contents of mURL.
TCHAR * GetFrame (void)
 Gets the contents of mFrame.
TCHAR * GetName (void)
 Gets the contents of mName.
BOOL IsAMatch (const TCHAR *pName)
 Compares the names of two buttons (which is how Camelot IDs them), and determines whether or not they're identical.
FlashButtonRecord * GetNext (void)
 Gets mpNext.
FlashButtonRecord * GetLast (void)
 Gets mpLast.
void SetButtonID (WORD ID)
 Sets the value of mButtonID.
void SetHitID (WORD ID, FlashType Type)
 Sets the values of mHitID and mHitType.
void SetDownID (WORD ID, FlashType Type)
 Sets the values of mDownID and mDownType.
void SetOverID (WORD ID, FlashType Type)
 Sets the values of mOverID and mOverType.
void SetUpID (WORD ID, FlashType Type)
 Sets the values of mUpID and mUpType.
void SetHitPosition (DocCoord Position, BOOL DoTransform)
 Sets the values of mHitPosition and mTransformHit.
void SetDownPosition (DocCoord Position, BOOL DoTransform)
 Sets the values of mDownPosition and mTransformDown.
void SetOverPosition (DocCoord Position, BOOL DoTransform)
 Sets the values of mOverPosition and mTransformOver.
void SetUpPosition (DocCoord Position, BOOL DoTransform)
 Sets the values of mUpPosition and mTransformUp.
void SetURL (String_256 Address)
 Sets the value of mURL. mHasURL is also set, so that only the first URL string encountered is used. This is to keep it consistent with the Camelot button class.
void SetFrame (TCHAR *pFrame)
 Sets the value of mFrame.
void SetName (const TCHAR *pName)
 Sets the value of mName.
void SetNext (FlashButtonRecord *pNext)
 Sets the value of mpNext.
void SetLast (FlashButtonRecord *pLast)
 Sets the value of mpLast.

Private Member Functions

WORD GetActualID (WORD ID, FlashType Type)
 Gets the value of mHitID.

Private Attributes

WORD mButtonID
WORD mHitID
WORD mDownID
WORD mOverID
WORD mUpID
FlashType mHitType
FlashType mDownType
FlashType mOverType
FlashType mUpType
DocCoord mHitPosition
DocCoord mDownPosition
DocCoord mOverPosition
DocCoord mUpPosition
BOOL mTransformHit
BOOL mTransformDown
BOOL mTransformOver
BOOL mTransformUp
BOOL mHasHit
BOOL mHasDown
BOOL mHasOver
BOOL mHasUp
BOOL mHasURL
BOOL mHasFrame
String_256 mURL
String_256 mFrame
String_256 mName
FlashButtonRecord * mpNext
FlashButtonRecord * mpLast

Detailed Description

Maintains a record of the buttons used by the Flash file.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
8/12/99

Definition at line 113 of file swfbuttn.h.

Constructor & Destructor Documentation

FlashButtonRecord::FlashButtonRecord (  void   ) 
 

Creates a FlashButtonRecord list node, and initialises all member variables.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
8/12/99
Parameters:
- [INPUTS]
Returns:
-

Definition at line 116 of file swfbuttn.cpp.

00117 {
00118     // Create constant variables for initial states.
00119     const DocCoord  Position    ( 0, 0 );       // Default position for all co-ordinates.
00120 
00121     // Pointers should always be initialised to NULL when created.
00122     mpNext          = NULL;                 // No subsequent nodes.
00123     mpLast          = NULL;                 // No previous nodes.
00124 
00125     // Attached objects.
00126     mButtonID       = 0;
00127     mHitID          = 0;
00128     mDownID         = 0;
00129     mOverID         = 0;
00130     mUpID           = 0;
00131 
00132     // Clear the strings.
00133     mURL.Empty ();
00134     mFrame.Empty ();
00135     mName.Empty ();
00136 
00137     // Place object positions.
00138     mHitPosition    = Position;
00139     mDownPosition   = Position;
00140     mOverPosition   = Position;
00141     mUpPosition     = Position;
00142 
00143     // Object states.
00144     mHitType        = FLASH_SHAPE;
00145     mDownType       = FLASH_SHAPE;
00146     mOverType       = FLASH_SHAPE;
00147     mUpType         = FLASH_SHAPE;
00148 
00149     mHasHit         = FALSE;
00150     mHasDown        = FALSE;
00151     mHasOver        = FALSE;
00152     mHasUp          = FALSE;
00153 
00154     mTransformHit   = FALSE;
00155     mTransformDown  = FALSE;
00156     mTransformOver  = FALSE;
00157     mTransformUp    = FALSE;
00158 
00159     mHasURL         = FALSE;
00160     mHasFrame       = FALSE;
00161 }

FlashButtonRecord::~FlashButtonRecord (  void   ) 
 

Destroys this instance of FlashButtonRecord.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
- [INPUTS]
Returns:
-

Definition at line 175 of file swfbuttn.cpp.

00176 {
00177     // Clean up any stray values.
00178 }

Member Function Documentation

FlashButtonRecord * FlashButtonRecord::AddElement (  void   ) 
 

Adds an element to the tail of the list.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
- [INPUTS]
Returns:
pTail - The pointer to the new node.

Definition at line 192 of file swfbuttn.cpp.

00193 {
00194     FlashButtonRecord *pTail = new FlashButtonRecord;
00195     ASSERT ( pTail != NULL );
00196 
00197     // Set the appropriate pointers.
00198     pTail->SetLast ( this );        // Ensure that a reference exists to this object...
00199     pTail->SetNext ( NULL );        // Avoids any problems if mpLast isn't NULL.
00200     mpNext = pTail;                 // ... and a reference exists to the new one.
00201 
00202     return pTail;
00203 }

void FlashButtonRecord::DeleteLastElement (  void   ) 
 

Deletes the previous item in the list.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
- [INPUTS]
Returns:
-

Definition at line 217 of file swfbuttn.cpp.

00218 {
00219     FlashButtonRecord *pToDelete = mpLast;
00220     
00221     // Reset mpLast to be mpLast->GetLast (), so that the list isn't broken.
00222     mpLast = mpLast->GetLast ();
00223 
00224     delete pToDelete;
00225 }

void FlashButtonRecord::DeleteNextElement (  void   ) 
 

Deletes the next item in the list.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
- [INPUTS]
Returns:
-

Definition at line 239 of file swfbuttn.cpp.

00240 {
00241     FlashButtonRecord *pToDelete = mpNext;
00242     
00243     // Reset mpNext to be mpNext->GetNext (), so that the list isn't broken.
00244     mpNext = mpNext->GetNext ();
00245 
00246     delete pToDelete;
00247 }

WORD FlashButtonRecord::GetActualID (  WORD  ID,
FlashType  Type
)  [private]
 

Gets the value of mHitID.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
9/12/99
Parameters:
ID - The basic ID value of the object to be used as a button state. [INPUTS] Type - The type of object to be rendered.
Returns:
ID - The actual value of this object's ID within the Flash file.

Definition at line 1021 of file swfbuttn.cpp.

01023 {
01024     // Step 1:  Increment the ID value past the font and bitmap records that are never
01025     //          rendered directly.
01026     ID += FlashPlaceObject::GetBitmapCount () + FlashPlaceObject::GetFontCount () +
01027           FLASH_FIRST_ID;
01028 
01029     // Step 2:  If the record is a shape record, increment it past the text records.
01030     if ( Type == FLASH_SHAPE )
01031     {
01032         ID += FlashPlaceObject::GetTextCount ();
01033     }
01034     else if ( Type == FLASH_SPRITE )
01035     {
01036         ID += FlashPlaceObject::GetShapeCount ();
01037     }
01038 
01039     // Step 3:  Return the ID value.
01040     return ID;
01041 }

WORD FlashButtonRecord::GetButtonID (  void   ) 
 

Gets the value of mButtonID.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
8/12/99
Parameters:
- [INPUTS]
Returns:
mButtonID - The internal ID number used by the Flash file for the button.

Definition at line 261 of file swfbuttn.cpp.

00262 {
00263     return mButtonID;
00264 }

WORD FlashButtonRecord::GetDownID (  void   ) 
 

Gets the value of mDownID.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
8/12/99
Parameters:
- [INPUTS]
Returns:
mDownID - Down state ID.

Definition at line 295 of file swfbuttn.cpp.

00296 {
00297     return GetActualID ( mDownID, mDownType );
00298 }

DocCoord FlashButtonRecord::GetDownPosition (  void   ) 
 

Gets the position of this button state.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
- [INPUTS]
Returns:
mDownPosition - Down state position.

Definition at line 431 of file swfbuttn.cpp.

00432 {
00433     return mDownPosition;
00434 }

FlashType FlashButtonRecord::GetDownType (  void   ) 
 

Gets the class of object that is to be rendered in this button state.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
- [INPUTS]
Returns:
mDownType - The object type to be rendered.

Definition at line 571 of file swfbuttn.cpp.

00572 {
00573     return mDownType;
00574 }

TCHAR * FlashButtonRecord::GetFrame (  void   ) 
 

Gets the contents of mFrame.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
17/1/00
Parameters:
- [INPUTS]
Returns:
mFrame - A pointer to a string containing the frame value to use.

Definition at line 639 of file swfbuttn.cpp.

00640 {
00641     return ( TCHAR * ) mFrame;
00642 }

WORD FlashButtonRecord::GetHitID (  void   ) 
 

Gets the value of mHitID.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
8/12/99
Parameters:
- [INPUTS]
Returns:
mHitID - Hit state ID.

Definition at line 278 of file swfbuttn.cpp.

00279 {
00280     return GetActualID ( mHitID, mHitType );
00281 }

DocCoord FlashButtonRecord::GetHitPosition (  void   ) 
 

Gets the position of this button state.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
- [INPUTS]
Returns:
mHitPosition - Hit state position.

Definition at line 414 of file swfbuttn.cpp.

00415 {
00416     return mHitPosition;
00417 }

FlashType FlashButtonRecord::GetHitType (  void   ) 
 

Gets the class of object that is to be rendered in this button state.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
- [INPUTS]
Returns:
mHitType - The object type to be rendered.

Definition at line 554 of file swfbuttn.cpp.

00555 {
00556     return mHitType;
00557 }

FlashButtonRecord * FlashButtonRecord::GetLast (  void   ) 
 

Gets mpLast.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
- [INPUTS]
Returns:
*mpLast - A pointer to the previous node in the linked list.

Definition at line 691 of file swfbuttn.cpp.

00692 {
00693     return mpLast;
00694 }

TCHAR * FlashButtonRecord::GetName (  void   ) 
 

Gets the contents of mName.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
14/1/00
Parameters:
- [INPUTS]
Returns:
mName - A pointer to a string containing the Camelot name for the button.

Definition at line 656 of file swfbuttn.cpp.

00657 {
00658     return ( TCHAR * ) mName;
00659 }

FlashButtonRecord * FlashButtonRecord::GetNext (  void   ) 
 

Gets mpNext.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
- [INPUTS]
Returns:
*mpNext - A pointer to the next node in the linked list.

Definition at line 708 of file swfbuttn.cpp.

00709 {
00710     return mpNext;
00711 }

WORD FlashButtonRecord::GetOverID (  void   ) 
 

Gets the value of mOverID.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
8/12/99
Parameters:
- [INPUTS]
Returns:
mOverID - Over state ID.

Definition at line 312 of file swfbuttn.cpp.

00313 {
00314     return GetActualID ( mOverID, mOverType );
00315 }

DocCoord FlashButtonRecord::GetOverPosition (  void   ) 
 

Gets the position of this button state.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
- [INPUTS]
Returns:
mOverPosition - Over state position.

Definition at line 448 of file swfbuttn.cpp.

00449 {
00450     return mOverPosition;
00451 }

FlashType FlashButtonRecord::GetOverType (  void   ) 
 

Gets the class of object that is to be rendered in this button state.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
- [INPUTS]
Returns:
mOverType - The object type to be rendered.

Definition at line 588 of file swfbuttn.cpp.

00589 {
00590     return mOverType;
00591 }

WORD FlashButtonRecord::GetRawDownID (  void   ) 
 

Gets the raw value of mDownID.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
- [INPUTS]
Returns:
mDownID - Down state ID.

Definition at line 363 of file swfbuttn.cpp.

00364 {
00365     return mDownID;
00366 }

WORD FlashButtonRecord::GetRawHitID (  void   ) 
 

Gets the raw value of mHitID.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
- [INPUTS]
Returns:
mHitID - Hit state ID.

Definition at line 346 of file swfbuttn.cpp.

00347 {
00348     return mHitID;
00349 }

WORD FlashButtonRecord::GetRawOverID (  void   ) 
 

Gets the raw value of mOverID.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
- [INPUTS]
Returns:
mOverID - Over state ID.

Definition at line 380 of file swfbuttn.cpp.

00381 {
00382     return mOverID;
00383 }

WORD FlashButtonRecord::GetRawUpID (  void   ) 
 

Gets the raw value of mUpID.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
- [INPUTS]
Returns:
mUpID - Up state ID.

Definition at line 397 of file swfbuttn.cpp.

00398 {
00399     return mUpID;
00400 }

BOOL FlashButtonRecord::GetTransformDown (  void   ) 
 

Do these co-ordinates need to be transformed into Flash co-ordinates? This is included to allow objects to be positioned at (0, 0).

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
- [INPUTS]
Returns:
mTransformDown - Is a transform required for mDownPosition?

Definition at line 501 of file swfbuttn.cpp.

00502 {
00503     return mTransformDown;
00504 }

BOOL FlashButtonRecord::GetTransformHit (  void   ) 
 

Do these co-ordinates need to be transformed into Flash co-ordinates? This is included to allow objects to be positioned at (0, 0).

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
- [INPUTS]
Returns:
mTransformHit - Is a transform required for mHitPosition?

Definition at line 483 of file swfbuttn.cpp.

00484 {
00485     return mTransformHit;
00486 }

BOOL FlashButtonRecord::GetTransformOver (  void   ) 
 

Do these co-ordinates need to be transformed into Flash co-ordinates? This is included to allow objects to be positioned at (0, 0).

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
- [INPUTS]
Returns:
mTransformOver - Is a transform required for mOverPosition?

Definition at line 519 of file swfbuttn.cpp.

00520 {
00521     return mTransformOver;
00522 }

BOOL FlashButtonRecord::GetTransformUp (  void   ) 
 

Do these co-ordinates need to be transformed into Flash co-ordinates? This is included to allow objects to be positioned at (0, 0).

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
- [INPUTS]
Returns:
mTransformUp - Is a transform required for mUpPosition?

Definition at line 537 of file swfbuttn.cpp.

00538 {
00539     return mTransformUp;
00540 }

WORD FlashButtonRecord::GetUpID (  void   ) 
 

Gets the value of mUpID.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
8/12/99
Parameters:
- [INPUTS]
Returns:
mUpID - Up state ID.

Definition at line 329 of file swfbuttn.cpp.

00330 {
00331     return GetActualID ( mUpID, mUpType );
00332 }

DocCoord FlashButtonRecord::GetUpPosition (  void   ) 
 

Gets the position of this button state..

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
- [INPUTS]
Returns:
mUpPosition - Up state position.

Definition at line 465 of file swfbuttn.cpp.

00466 {
00467     return mUpPosition;
00468 }

FlashType FlashButtonRecord::GetUpType (  void   ) 
 

Gets the class of object that is to be rendered in this button state.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
- [INPUTS]
Returns:
mUpType - The object type to be rendered.

Definition at line 605 of file swfbuttn.cpp.

00606 {
00607     return mUpType;
00608 }

TCHAR * FlashButtonRecord::GetURL (  void   ) 
 

Gets the contents of mURL.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
8/12/99
Parameters:
- [INPUTS]
Returns:
mURL - A pointer to a string containing a URL.

Definition at line 622 of file swfbuttn.cpp.

00623 {
00624     return ( TCHAR * ) mURL;
00625 }

BOOL FlashButtonRecord::IsAMatch (  const TCHAR *  pName  ) 
 

Compares the names of two buttons (which is how Camelot IDs them), and determines whether or not they're identical.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
14/1/00
Parameters:
- [INPUTS]
Returns:
TRUE if the names match, otherwise FALSE.

Definition at line 674 of file swfbuttn.cpp.

00675 {
00676     return mName.IsIdentical ( pName );
00677 }

void FlashButtonRecord::SetButtonID (  WORD  ID  ) 
 

Sets the value of mButtonID.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
8/12/99
Parameters:
ID - The ID value for this button. [INPUTS]
Returns:
-

Definition at line 725 of file swfbuttn.cpp.

00726 {
00727     mButtonID = ID;
00728 }

void FlashButtonRecord::SetDownID (  WORD  ID,
FlashType  Type
) 
 

Sets the values of mDownID and mDownType.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
8/12/99
Parameters:
ID - The ID value for this button state. [INPUTS] Type - Is it a shape record? (Used for returning the ID value.)
Returns:
-

Definition at line 766 of file swfbuttn.cpp.

00768 {
00769     mDownID     = ID;       // Set the ID value for this state.
00770     mDownType   = Type;     // And whether or not it's a shape.
00771     mHasDown    = TRUE;     // Record that this state has been set.
00772 }

void FlashButtonRecord::SetDownPosition (  DocCoord  Position,
BOOL  DoTransform
) 
 

Sets the values of mDownPosition and mTransformDown.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
Position - The position to place the object. [INPUTS] DoTransform - Do the co-ordinates need to be transformed into Flash ones?
Returns:
-

Definition at line 863 of file swfbuttn.cpp.

00865 {
00866     mDownPosition   = Position;
00867     mTransformDown  = DoTransform;
00868 }

void FlashButtonRecord::SetFrame (  TCHAR *  pFrame  ) 
 

Sets the value of mFrame.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
17/1/00
Parameters:
pFrame - A reference to a frame.. [INPUTS]
Returns:
-

Definition at line 947 of file swfbuttn.cpp.

00948 {
00949     if ( !mHasFrame )
00950     {
00951         mFrame = pFrame;
00952         mHasFrame = TRUE;
00953     }
00954 }

void FlashButtonRecord::SetHitID (  WORD  ID,
FlashType  Type
) 
 

Sets the values of mHitID and mHitType.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
8/12/99
Parameters:
ID - The ID value for this button state. [INPUTS] Type - Is it a shape record? (Used for returning the ID value.)
Returns:
-

Definition at line 744 of file swfbuttn.cpp.

00746 {
00747     mHitID      = ID;       // Set the ID value for this state.
00748     mHitType    = Type;     // And whether or not it's a shape.
00749     mHasHit     = TRUE;     // Record that this state has been set.
00750 }

void FlashButtonRecord::SetHitPosition (  DocCoord  Position,
BOOL  DoTransform
) 
 

Sets the values of mHitPosition and mTransformHit.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
Position - The position to place the object. [INPUTS] DoTransform - Do the co-ordinates need to be transformed into Flash ones?
Returns:
-

Definition at line 842 of file swfbuttn.cpp.

00844 {
00845     mHitPosition    = Position;
00846     mTransformHit   = DoTransform;
00847 }

void FlashButtonRecord::SetLast (  FlashButtonRecord *  pLast  ) 
 

Sets the value of mpLast.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
pLast - A pointer to the previous FlashButtonRecord in the linked list. [INPUTS]
Returns:
-

Definition at line 985 of file swfbuttn.cpp.

00986 {
00987     mpLast = pLast;
00988 }

void FlashButtonRecord::SetName (  const TCHAR *  pName  ) 
 

Sets the value of mName.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
14/1/00
Parameters:
pName - A reference to a button. [INPUTS]
Returns:
-

Definition at line 968 of file swfbuttn.cpp.

00969 {
00970     mName = pName;
00971 }

void FlashButtonRecord::SetNext (  FlashButtonRecord *  pNext  ) 
 

Sets the value of mpNext.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
16/11/99
Parameters:
pNext - A pointer to the next FlashButtonRecord in the linked list. [INPUTS]
Returns:
-

Definition at line 1002 of file swfbuttn.cpp.

01003 {
01004     mpNext = pNext;
01005 }

void FlashButtonRecord::SetOverID (  WORD  ID,
FlashType  Type
) 
 

Sets the values of mOverID and mOverType.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
8/12/99
Parameters:
ID - The ID value for this button state. [INPUTS] Type - Is it a shape record? (Used for returning the ID value.)
Returns:
-

Definition at line 788 of file swfbuttn.cpp.

00790 {
00791     mOverID     = ID;       // Set the ID value for this state.
00792     mOverType   = Type;     // And whether or not it's a shape.
00793     mHasOver    = TRUE;     // Record that this state has been set.
00794 }

void FlashButtonRecord::SetOverPosition (  DocCoord  Position,
BOOL  DoTransform
) 
 

Sets the values of mOverPosition and mTransformOver.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
Position - The position to place the object. [INPUTS] DoTransform - Do the co-ordinates need to be transformed into Flash ones?
Returns:
-

Definition at line 884 of file swfbuttn.cpp.

00886 {
00887     mOverPosition   = Position;
00888     mTransformOver  = DoTransform;
00889 }

void FlashButtonRecord::SetUpID (  WORD  ID,
FlashType  Type
) 
 

Sets the values of mUpID and mUpType.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
8/12/99
Parameters:
ID - The ID value for this button state. [INPUTS] Type - Is it a shape record? (Used for returning the ID value.)
Returns:
-

Definition at line 810 of file swfbuttn.cpp.

00812 {
00813     mUpID       = ID;       // Set the ID value for this state.
00814     mUpType     = Type;     // And whether or not it's a shape.
00815     mHasUp      = TRUE;     // Record that this state has been set.
00816 
00817     // I'm treating up as the default state, so ensure that all other states are set.
00818     if ( !mHasHit )
00819         SetHitID ( ID, Type );
00820 
00821     if ( !mHasOver )
00822         SetOverID ( ID, Type );
00823 
00824     if ( !mHasDown )
00825         SetDownID ( ID, Type );
00826 }

void FlashButtonRecord::SetUpPosition (  DocCoord  Position,
BOOL  DoTransform
) 
 

Sets the values of mUpPosition and mTransformUp.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
18/1/00
Parameters:
Position - The position to place the object. [INPUTS] DoTransform - Do the co-ordinates need to be transformed into Flash ones?
Returns:
-

Definition at line 905 of file swfbuttn.cpp.

00907 {
00908     mUpPosition     = Position;
00909     mTransformUp    = DoTransform;
00910 }

void FlashButtonRecord::SetURL (  String_256  Address  ) 
 

Sets the value of mURL. mHasURL is also set, so that only the first URL string encountered is used. This is to keep it consistent with the Camelot button class.

Author:
Graeme_Sutherland (Xara Group Ltd) <camelotdev@xara.com>
Date:
8/12/99
Parameters:
Address - A reference to a URL. [INPUTS]
Returns:
-

Definition at line 926 of file swfbuttn.cpp.

00927 {
00928     if ( !mHasURL )
00929     {
00930         mURL = Address;
00931         mHasURL = TRUE;
00932     }
00933 }

Member Data Documentation

WORD FlashButtonRecord::mButtonID [private]
 

Definition at line 183 of file swfbuttn.h.

WORD FlashButtonRecord::mDownID [private]
 

Definition at line 186 of file swfbuttn.h.

DocCoord FlashButtonRecord::mDownPosition [private]
 

Definition at line 196 of file swfbuttn.h.

FlashType FlashButtonRecord::mDownType [private]
 

Definition at line 191 of file swfbuttn.h.

String_256 FlashButtonRecord::mFrame [private]
 

Definition at line 214 of file swfbuttn.h.

BOOL FlashButtonRecord::mHasDown [private]
 

Definition at line 206 of file swfbuttn.h.

BOOL FlashButtonRecord::mHasFrame [private]
 

Definition at line 211 of file swfbuttn.h.

BOOL FlashButtonRecord::mHasHit [private]
 

Definition at line 205 of file swfbuttn.h.

BOOL FlashButtonRecord::mHasOver [private]
 

Definition at line 207 of file swfbuttn.h.

BOOL FlashButtonRecord::mHasUp [private]
 

Definition at line 208 of file swfbuttn.h.

BOOL FlashButtonRecord::mHasURL [private]
 

Definition at line 210 of file swfbuttn.h.

WORD FlashButtonRecord::mHitID [private]
 

Definition at line 185 of file swfbuttn.h.

DocCoord FlashButtonRecord::mHitPosition [private]
 

Definition at line 195 of file swfbuttn.h.

FlashType FlashButtonRecord::mHitType [private]
 

Definition at line 190 of file swfbuttn.h.

String_256 FlashButtonRecord::mName [private]
 

Definition at line 215 of file swfbuttn.h.

WORD FlashButtonRecord::mOverID [private]
 

Definition at line 187 of file swfbuttn.h.

DocCoord FlashButtonRecord::mOverPosition [private]
 

Definition at line 197 of file swfbuttn.h.

FlashType FlashButtonRecord::mOverType [private]
 

Definition at line 192 of file swfbuttn.h.

FlashButtonRecord* FlashButtonRecord::mpLast [private]
 

Definition at line 218 of file swfbuttn.h.

FlashButtonRecord* FlashButtonRecord::mpNext [private]
 

Definition at line 217 of file swfbuttn.h.

BOOL FlashButtonRecord::mTransformDown [private]
 

Definition at line 201 of file swfbuttn.h.

BOOL FlashButtonRecord::mTransformHit [private]
 

Definition at line 200 of file swfbuttn.h.

BOOL FlashButtonRecord::mTransformOver [private]
 

Definition at line 202 of file swfbuttn.h.

BOOL FlashButtonRecord::mTransformUp [private]
 

Definition at line 203 of file swfbuttn.h.

WORD FlashButtonRecord::mUpID [private]
 

Definition at line 188 of file swfbuttn.h.

DocCoord FlashButtonRecord::mUpPosition [private]
 

Definition at line 198 of file swfbuttn.h.

FlashType FlashButtonRecord::mUpType [private]
 

Definition at line 193 of file swfbuttn.h.

String_256 FlashButtonRecord::mURL [private]
 

Definition at line 213 of file swfbuttn.h.

The documentation for this class was generated from the following files:
Generated on Sat Nov 10 03:54:22 2007 for Camelot by  doxygen 1.4.4