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

SGScrollDragInfo Class Reference

Describes a supergallery scroll drag. More...

#include <sgdrag.h>

Inheritance diagram for SGScrollDragInfo:

DragInformation CCObject SimpleCCObject List of all members.

Public Member Functions

 SGScrollDragInfo ()
 Default constructor. DO NOT CALL THIS CONSTRUCTOR.
 SGScrollDragInfo (SGDisplayRootScroll *ParentRootNode, SGDragType TheDragType, SGMiscInfo *MiscInfo, INT32 DragAnchorOffset, BOOL IsAdjust=FALSE)
 Constructor.
void OnClick (INT32 Flags, POINT Point)
 This is called if a drag was attempted but never started because it was a click all along.
virtual UINT32 GetCursorID (void)
 To provide the resource ID of the cursor to use during this drag. For scrollbar drags, the cursor should remain the normal arrow shape.
virtual BOOL GetStatusLineText (String_256 *TheText)
 Provide status line text for this drag - While dragging scrollbars no help is required/given, so this always returns FALSE.
SGDisplayRootScroll * GetDragRootNode (void)
SGDragType GetDragType (void)
SGMiscInfo * GetDragMiscInfo (void)
INT32 GetDragAnchorOffset (void)
BOOL IsAdjustDrag (void)

Private Attributes

SGDisplayRootScroll * DragRootNode
SGDragType DragType
SGMiscInfo DragMiscInfo
INT32 DragAnchor
BOOL DragAdjust

Detailed Description

Describes a supergallery scroll drag.

Author:
Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
Date:
26/2/95

Definition at line 188 of file sgdrag.h.

Constructor & Destructor Documentation

SGScrollDragInfo::SGScrollDragInfo (   ) 
 

Default constructor. DO NOT CALL THIS CONSTRUCTOR.

Author:
Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
Date:
27/2/95

Definition at line 434 of file sgdrag.cpp.

00435 {
00436     ERROR3("Default SGScrollDragInfo constructor called");  
00437 }

SGScrollDragInfo::SGScrollDragInfo (  SGDisplayRootScroll *  ParentRootNode,
SGDragType  TheDragType,
SGMiscInfo *  MiscInfo,
INT32  DragAnchorOffset,
BOOL  IsAdjust = FALSE
) 
 

Constructor.

Author:
Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
Date:
27/2/95
Parameters:
ParentRootNode - The SGDisplayRootScroll for the DisplayTree for which [INPUTS] the drag is occurring
TheDragType - The SGDragType indicating what is being dragged

MiscInfo - The normal SGMiscInfo as recieved by display tree event handlers

DragAnchorOffset - The offset, in millipoints, from the top of the scroll sausage to the point where the drag started (used only when dragging the sausage, to "lock" the sausage to the mouse pointer)

IsAdjust - TRUE if it is an "adjust" drag [NOTE - Adjust drags are legal when dragging scrollbars, and are not turned into clicks like normal drags]

Definition at line 470 of file sgdrag.cpp.

00475                  : DragInformation(FALSE)
00476 {
00477     DragRootNode = ParentRootNode;
00478     DragType = TheDragType;
00479     DragAnchor = DragAnchorOffset;
00480     DragAdjust = IsAdjust;
00481 
00482     DragMiscInfo = *MiscInfo;       // Copy the MiscInfo structure for ourselves
00483 
00484     // Set up a few things about this drag - it does not do solid drag
00485     DoesSolidDrag = FALSE;
00486     SolidDragOffset.x = SolidDragOffset.y = 0;  // Set up defaults just in case
00487     SolidDragSize.Set(1,1);
00488 }

Member Function Documentation

UINT32 SGScrollDragInfo::GetCursorID (  void   )  [virtual]
 

To provide the resource ID of the cursor to use during this drag. For scrollbar drags, the cursor should remain the normal arrow shape.

Author:
Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
Date:
27/2/95
Returns:
a cursor ID to set during this drag

Reimplemented from DragInformation.

Definition at line 506 of file sgdrag.cpp.

00507 {
00508      return(0);
00509 }

INT32 SGScrollDragInfo::GetDragAnchorOffset (  void   )  [inline]
 

Definition at line 206 of file sgdrag.h.

00206 { return(DragAnchor); }

SGMiscInfo* SGScrollDragInfo::GetDragMiscInfo (  void   )  [inline]
 

Definition at line 205 of file sgdrag.h.

00205 { return(&DragMiscInfo); }

SGDisplayRootScroll* SGScrollDragInfo::GetDragRootNode (  void   )  [inline]
 

Definition at line 203 of file sgdrag.h.

00203 { return(DragRootNode); }

SGDragType SGScrollDragInfo::GetDragType (  void   )  [inline]
 

Definition at line 204 of file sgdrag.h.

00204 { return(DragType); }

BOOL SGScrollDragInfo::GetStatusLineText (  String_256 *  TheText  )  [virtual]
 

Provide status line text for this drag - While dragging scrollbars no help is required/given, so this always returns FALSE.

Author:
Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
Date:
27/2/95
Returns:
FALSE - The string has not been filled in

Reimplemented from DragInformation.

Definition at line 526 of file sgdrag.cpp.

00527 {
00528     return(FALSE);
00529 }

BOOL SGScrollDragInfo::IsAdjustDrag (  void   )  [inline]
 

Definition at line 207 of file sgdrag.h.

00207 { return(DragAdjust); }

void SGScrollDragInfo::OnClick (  INT32  Flags,
POINT  Point
) 
 

This is called if a drag was attempted but never started because it was a click all along.

Author:
Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
Date:
27/2/95
Parameters:
Flags - Some flags [INPUTS] Point - the point which was clicked

Definition at line 547 of file sgdrag.cpp.

00548 {
00549     // Do nothing. As the thing is scrolled once immediately on SGEVENT_INITIALISE, we
00550     // have already applied the correct click action.
00551 }

Member Data Documentation

BOOL SGScrollDragInfo::DragAdjust [private]
 

Definition at line 215 of file sgdrag.h.

INT32 SGScrollDragInfo::DragAnchor [private]
 

Definition at line 213 of file sgdrag.h.

SGMiscInfo SGScrollDragInfo::DragMiscInfo [private]
 

Definition at line 212 of file sgdrag.h.

SGDisplayRootScroll* SGScrollDragInfo::DragRootNode [private]
 

Definition at line 210 of file sgdrag.h.

SGDragType SGScrollDragInfo::DragType [private]
 

Definition at line 211 of file sgdrag.h.

The documentation for this class was generated from the following files:
Generated on Sat Nov 10 04:01:12 2007 for Camelot by  doxygen 1.4.4