Class Hierarchy¶

Inheritance diagram for class DragImage:

Methods Summary¶

Class API¶

class wx.DragImage(Object)¶

Possible constructors:

DragImage() -> None

DragImage(image, cursor=NullCursor) -> None

DragImage(image, cursor=NullCursor) -> None

DragImage(text, cursor=NullCursor) -> None

DragImage(treeCtrl, id) -> None

DragImage(listCtrl, id) -> None

This class is used when you wish to drag an object on the screen, and a simple cursor is not enough.

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

---

__init__ (self)

Default constructor.

Return type:

None

---

__init__ (self, image, cursor=NullCursor)

Constructs a drag image from a bitmap and optional cursor.

Parameters:

• image (wx.Bitmap) – Bitmap to be used as the drag image. The bitmap can have a mask.

• cursor (wx.Cursor) – Optional cursor to combine with the image.

Return type:

None

---

__init__ (self, image, cursor=NullCursor)

Constructs a drag image from an icon and optional cursor.

Parameters:

• image (wx.Icon) – Icon to be used as the drag image.

• cursor (wx.Cursor) – Optional cursor to combine with the image.

Return type:

None

---

__init__ (self, text, cursor=NullCursor)

Constructs a drag image from a text string and optional cursor.

Parameters:

• text (string) – Text used to construct a drag image.

• cursor (wx.Cursor) – Optional cursor to combine with the image.

Return type:

None

---

__init__ (self, treeCtrl, id)

Constructs a drag image from the text in the given tree control item, and optional cursor.

Parameters:

• treeCtrl (wx.TreeCtrl) – Tree control for constructing a tree drag image.

• id (wx.TreeItemId) – Tree control item id.

Return type:

None

---

__init__ (self, listCtrl, id)

Constructs a drag image from the text in the given list control item, and optional cursor.

Parameters:

• listCtrl (wx.ListCtrl) – List control for constructing a list drag image.

• id (long) – List control item id.

Return type:

None

---

---

BeginDrag(self, *args, **kw)¶

Overloaded Implementations:

---

BeginDrag (self, hotspot, window, fullScreen=False, rect=None)

Start dragging the image, in a window or full screen.

You need to then call Show and Move to show the image on the screen. Call EndDrag when the drag has finished.

Note that this call automatically calls CaptureMouse().

Parameters:

• hotspot (wx.Point) – The location of the drag position relative to the upper-left corner of the image.

• window (wx.Window) – The window that captures the mouse, and within which the dragging is limited unless fullScreen is True.

• fullScreen (bool) – If True, specifies that the drag will be visible over the full screen, or over as much of the screen as is specified by rect. Note that the mouse will still be captured in window.

• rect (wx.Rect) – If non-null, specifies the rectangle (in screen coordinates) that bounds the dragging operation. Specifying this can make the operation more efficient by cutting down on the area under consideration, and it can also make a visual difference since the drag is clipped to this area.

Return type:

bool

---

BeginDrag (self, hotspot, window, boundingWindow)

Start dragging the image, using the first window to capture the mouse and the second to specify the bounding area.

This form is equivalent to using the first form, but more convenient than working out the bounding rectangle explicitly.

You need to then call Show and Move to show the image on the screen. Call EndDrag when the drag has finished.

Note that this call automatically calls CaptureMouse().

Parameters:

• hotspot (wx.Point) – The location of the drag position relative to the upper-left corner of the image.

• window (wx.Window) – The window that captures the mouse, and within which the dragging is limited.

• boundingWindow (wx.Window) – Specifies the area within which the drag occurs.

Return type:

bool

---

---

EndDrag(self)¶

Call this when the drag has finished.

Return type:

bool

Note

This function automatically releases mouse capture.

---

Hide(self)¶

Hides the image.

You may wish to call this before updating the window contents (perhaps highlighting an item). Then call Move and Show .

Return type:

bool

---

Move(self, pt)¶

Call this to move the image to a new position.

The image will only be shown if Show has been called previously (for example at the start of the drag).

Parameters:

pt (wx.Point) – The position in client coordinates (relative to the window specified in BeginDrag ).

Return type:

bool

---

Show(self)¶

Shows the image.

Call this at least once when dragging.

Return type:

bool