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

DragInformation Class Reference

Objects derived from this abstract class are used to describe everything useful to know about the current global drag. They allow drag targets to decide what to do with a recieved drag. More...

#include <draginfo.h>

Inheritance diagram for DragInformation:

CCObject SimpleCCObject BitmapDragInformation ColourDragInformation ColourPickerDragInformation SGListDragInfo SGScrollDragInfo GalleryBitmapDragInfo GalleryClipartDragInfo GalleryFillsDragInfo GalleryFontsDragInfo GalleryLibFontsDragInfo GalleryLineDragInfo GalleryNameDragInfo SGNameDrag ColEditorDragInfo GalleryColourDragInfo List of all members.

Public Member Functions

virtual void OnClick (INT32 flags, CNativePoint Point)
 this can be overridden to provide click functionality if the drag didn't materialise
virtual UINT32 GetCursorID ()
 

virtual BOOL GetStatusLineText (String_256 *TheText)
virtual BOOL OnDrawSolidDrag (CNativePoint Origin, CNativeDC *TheDC)
 

virtual UINT32 GetCursorID (DragTarget *pDragTarget)
 

virtual BOOL GetStatusLineText (String_256 *TheText, DragTarget *pDragTarget)
virtual BOOL OnDrawSolidDrag (CNativePoint Origin, CNativeDC *TheDC, DragTarget *pDragTarget)
 

BOOL IsAnAdjustDrag ()
virtual INT32 GetDragTransparency ()
virtual KernelBitmap * GetSolidDragMask ()
virtual BOOL HasTransparentMask ()
virtual wxBitmap * GetTransparentMask ()
virtual BOOL CanDropOnPage ()
virtual BOOL OnPageDrop (ViewDragTarget *)
virtual BOOL OnMouseMove (wxPoint p)
virtual BOOL OnButtonUp (wxPoint p)

Protected Member Functions

 DragInformation (BOOL IsAdjustDrag=FALSE)
 default constructor

Protected Attributes

BOOL DoesSolidDrag
CNativePoint SolidDragOffset
CNativeSize SolidDragSize
BOOL IsAdjustDrag

Static Protected Attributes

static Cursor * MyCursor = NULL

Friends

class DragManagerOp
class CaptureHandler

Detailed Description

Objects derived from this abstract class are used to describe everything useful to know about the current global drag. They allow drag targets to decide what to do with a recieved drag.

Author:
Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
Date:
2/1/95
See also:
DragManagerOp::StartDrag; DragTarget
Documentation: Docs.doc

Definition at line 125 of file draginfo.h.

Constructor & Destructor Documentation

DragInformation::DragInformation (  BOOL  AdjustDrag = FALSE  )  [protected]
 

default constructor

Author:
Jason_Williams (Xara Group Ltd) <camelotdev@xara.com>
Date:
3/1/95
Documentation: Docs.doc

Definition at line 134 of file draginfo.cpp.

00135 {
00136     // default no solid drag
00137     DoesSolidDrag = FALSE;
00138     IsAdjustDrag = AdjustDrag;
00139     SolidDragOffset.x = SolidDragOffset.y = 0;
00140     SolidDragSize.x = SolidDragSize.y = 0;
00141 }

Member Function Documentation

virtual BOOL DragInformation::CanDropOnPage (   )  [inline, virtual]
 

Reimplemented in SGNameDrag, GalleryBitmapDragInfo, GalleryClipartDragInfo, GalleryFillsDragInfo, GalleryNameDragInfo, ColourDragInformation, GalleryFontsDragInfo, GalleryLibFontsDragInfo, and GalleryLineDragInfo.

Definition at line 157 of file draginfo.h.

00157 { return FALSE; }

UINT32 DragInformation::GetCursorID (  DragTarget *  pDragTarget  )  [virtual]
 

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

Reimplemented in SGNameDrag, GalleryBitmapDragInfo, GalleryClipartDragInfo, GalleryFillsDragInfo, GalleryNameDragInfo, BitmapDragInformation, ColourDragInformation, ColourPickerDragInformation, GalleryFontsDragInfo, GalleryLibFontsDragInfo, and GalleryLineDragInfo.

Definition at line 225 of file draginfo.cpp.

00226 {
00227      return _R(IDC_DRAGGING) ;
00228 }

UINT32 DragInformation::GetCursorID (  void   )  [virtual]
 

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

Reimplemented in SGScrollDragInfo, SGListDragInfo, BitmapDragInformation, ColourDragInformation, and ColourPickerDragInformation.

Definition at line 175 of file draginfo.cpp.

00176 {
00177      return _R(IDC_DRAGGING) ;
00178 }

virtual INT32 DragInformation::GetDragTransparency (   )  [inline, virtual]
 

Reimplemented in SGNameDrag, GalleryNameDragInfo, BitmapDragInformation, ColourDragInformation, ColourPickerDragInformation, GalleryFontsDragInfo, GalleryLibFontsDragInfo, and GalleryLineDragInfo.

Definition at line 151 of file draginfo.h.

00151 { return 0; }       // Not transparent

virtual KernelBitmap* DragInformation::GetSolidDragMask (   )  [inline, virtual]
 

Reimplemented in SGNameDrag, GalleryNameDragInfo, BitmapDragInformation, GalleryFontsDragInfo, GalleryLibFontsDragInfo, and GalleryLineDragInfo.

Definition at line 152 of file draginfo.h.

00152 { return NULL; }    // Not masked

BOOL DragInformation::GetStatusLineText (  String_256 *  TheText,
DragTarget *  pDragTarget
)  [virtual]
 

Reimplemented in SGNameDrag, GalleryBitmapDragInfo, GalleryClipartDragInfo, GalleryFillsDragInfo, GalleryNameDragInfo, BitmapDragInformation, ColourDragInformation, ColourPickerDragInformation, GalleryFontsDragInfo, GalleryLibFontsDragInfo, and GalleryLineDragInfo.

Definition at line 239 of file draginfo.cpp.

00240 {
00241     ERROR2IF(TheText==NULL,FALSE,"NULL string in GetStatusLineText()");
00242     * TheText = String_256(_R(IDS_DRAGSTATUSLINETEXT));
00243     return TRUE;
00244 }

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

Reimplemented in SGScrollDragInfo, SGListDragInfo, BitmapDragInformation, ColourDragInformation, and ColourPickerDragInformation.

Definition at line 189 of file draginfo.cpp.

00190 {
00191     ERROR2IF(TheText==NULL,FALSE,"NULL string in GetStatusLineText()");
00192     * TheText = String_256(_R(IDS_DRAGSTATUSLINETEXT));
00193     return TRUE;
00194 }

virtual wxBitmap* DragInformation::GetTransparentMask (   )  [inline, virtual]
 

Reimplemented in BitmapDragInformation.

Definition at line 154 of file draginfo.h.

00154 { return NULL; }

virtual BOOL DragInformation::HasTransparentMask (   )  [inline, virtual]
 

Reimplemented in BitmapDragInformation.

Definition at line 153 of file draginfo.h.

00153 { return FALSE; }

BOOL DragInformation::IsAnAdjustDrag (   )  [inline]
 

Definition at line 148 of file draginfo.h.

00148 { return IsAdjustDrag; }

virtual BOOL DragInformation::OnButtonUp (  wxPoint  p  )  [inline, virtual]
 

Definition at line 160 of file draginfo.h.

00160 { return FALSE; }

void DragInformation::OnClick (  INT32  Flags,
CNativePoint  Point
)  [virtual]
 

this can be overridden to provide click functionality if the drag didn't materialise

Author:
Chris_Snook (Xara Group Ltd) <camelotdev@xara.com>
Date:
15/1/95
Returns:
- Inputs : Flags state of mouse 1 = left click 2 = right click Point Screen Coord of mouse Click

Reimplemented in ColourDragInformation.

Definition at line 158 of file draginfo.cpp.

00159 {
00160     // do nothing in the base function
00161 }

BOOL DragInformation::OnDrawSolidDrag (  CNativePoint  Origin,
CNativeDC *  TheDC,
DragTarget *  pDragTarget
)  [virtual]
 

Author:
Chris_Snook (Xara Group Ltd) <camelotdev@xara.com>
Date:
15/1/95
Returns:
-

Reimplemented in BitmapDragInformation.

Definition at line 257 of file draginfo.cpp.

00258 {
00259   return FALSE;
00260 }

BOOL DragInformation::OnDrawSolidDrag (  CNativePoint  Origin,
CNativeDC *  TheDC
)  [virtual]
 

Author:
Chris_Snook (Xara Group Ltd) <camelotdev@xara.com>
Date:
15/1/95
Returns:
-

Reimplemented in SGNameDrag, BitmapDragInformation, ColourDragInformation, and ColourPickerDragInformation.

Definition at line 207 of file draginfo.cpp.

00208 {
00209   return FALSE;
00210 }

virtual BOOL DragInformation::OnMouseMove (  wxPoint  p  )  [inline, virtual]
 

Reimplemented in ColourPickerDragInformation.

Definition at line 159 of file draginfo.h.

00159 { return FALSE; }

virtual BOOL DragInformation::OnPageDrop (  ViewDragTarget *   )  [inline, virtual]
 

Reimplemented in SGNameDrag, GalleryBitmapDragInfo, GalleryClipartDragInfo, GalleryFillsDragInfo, GalleryNameDragInfo, ColourDragInformation, GalleryFontsDragInfo, GalleryLibFontsDragInfo, and GalleryLineDragInfo.

Definition at line 158 of file draginfo.h.

00158 { return FALSE; }

Friends And Related Function Documentation

friend class CaptureHandler [friend]
 

Definition at line 128 of file draginfo.h.

friend class DragManagerOp [friend]
 

Definition at line 127 of file draginfo.h.

Member Data Documentation

BOOL DragInformation::DoesSolidDrag [protected]
 

Definition at line 165 of file draginfo.h.

BOOL DragInformation::IsAdjustDrag [protected]
 

Definition at line 169 of file draginfo.h.

Cursor * DragInformation::MyCursor = NULL [static, protected]
 

Definition at line 163 of file draginfo.h.

CNativePoint DragInformation::SolidDragOffset [protected]
 

Definition at line 166 of file draginfo.h.

CNativeSize DragInformation::SolidDragSize [protected]
 

Definition at line 167 of file draginfo.h.

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