Panda3D
Public Member Functions | Static Public Member Functions | Friends

PGMouseWatcherRegion Class Reference

This is a specialization on MouseWatcherRegion, to add a bit more fields that are relevant to the PG system. More...

#include "pgMouseWatcherRegion.h"

Inheritance diagram for PGMouseWatcherRegion:
MouseWatcherRegion TypedWritableReferenceCount Namable TypedWritable ReferenceCount MemoryBase TypedObject MemoryBase MemoryBase

List of all members.

Public Member Functions

 PGMouseWatcherRegion (PGItem *item)
virtual void candidate (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever the user selects an option from the IME menu.
virtual void enter_region (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever the mouse enters the region.
virtual void exit_region (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever the mouse exits the region.
virtual TypeHandle force_init_type ()
virtual TypeHandle get_type () const
virtual void keystroke (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever the user presses a key.
virtual void move (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever the user moves the mouse within the region.
virtual void press (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever a mouse or keyboard button is depressed while the mouse is within the region.
virtual void release (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever a mouse or keyboard button previously depressed with press() is released.
virtual void within_region (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever the mouse moves within the boundaries of the region, even if it is also within the boundaries of a nested region.
virtual void without_region (const MouseWatcherParameter &param)
 This is a callback hook function, called whenever the mouse moves completely outside the boundaries of the region.

Static Public Member Functions

static TypeHandle get_class_type ()
static void init_type ()

Friends

class PGItem

Detailed Description

This is a specialization on MouseWatcherRegion, to add a bit more fields that are relevant to the PG system.

Each PGItem corresponds to exactly one PGMouseWatcherRegion.

Definition at line 31 of file pgMouseWatcherRegion.h.


Member Function Documentation

void PGMouseWatcherRegion::candidate ( const MouseWatcherParameter param) [virtual]

This is a callback hook function, called whenever the user selects an option from the IME menu.

Reimplemented from MouseWatcherRegion.

Definition at line 158 of file pgMouseWatcherRegion.cxx.

References PGItem::candidate().

void PGMouseWatcherRegion::enter_region ( const MouseWatcherParameter param) [virtual]

This is a callback hook function, called whenever the mouse enters the region.

The mouse is only considered to be "entered" in one region at a time; in the case of nested regions, it exits the outer region before entering the inner one.

Reimplemented from MouseWatcherRegion.

Definition at line 57 of file pgMouseWatcherRegion.cxx.

References PGItem::enter_region().

void PGMouseWatcherRegion::exit_region ( const MouseWatcherParameter param) [virtual]

This is a callback hook function, called whenever the mouse exits the region.

The mouse is only considered to be "entered" in one region at a time; in the case of nested regions, it exits the outer region before entering the inner one.

Reimplemented from MouseWatcherRegion.

Definition at line 73 of file pgMouseWatcherRegion.cxx.

References PGItem::exit_region().

void PGMouseWatcherRegion::keystroke ( const MouseWatcherParameter param) [virtual]

This is a callback hook function, called whenever the user presses a key.

Reimplemented from MouseWatcherRegion.

Definition at line 145 of file pgMouseWatcherRegion.cxx.

References PGItem::keystroke().

void PGMouseWatcherRegion::move ( const MouseWatcherParameter param) [virtual]

This is a callback hook function, called whenever the user moves the mouse within the region.

Reimplemented from MouseWatcherRegion.

Definition at line 171 of file pgMouseWatcherRegion.cxx.

References PGItem::move().

void PGMouseWatcherRegion::press ( const MouseWatcherParameter param) [virtual]

This is a callback hook function, called whenever a mouse or keyboard button is depressed while the mouse is within the region.

Reimplemented from MouseWatcherRegion.

Definition at line 118 of file pgMouseWatcherRegion.cxx.

References PGItem::press().

void PGMouseWatcherRegion::release ( const MouseWatcherParameter param) [virtual]

This is a callback hook function, called whenever a mouse or keyboard button previously depressed with press() is released.

Reimplemented from MouseWatcherRegion.

Definition at line 132 of file pgMouseWatcherRegion.cxx.

References PGItem::release().

void PGMouseWatcherRegion::within_region ( const MouseWatcherParameter param) [virtual]

This is a callback hook function, called whenever the mouse moves within the boundaries of the region, even if it is also within the boundaries of a nested region.

This is different from "enter", which is only called whenever the mouse is within only that region.

Reimplemented from MouseWatcherRegion.

Definition at line 90 of file pgMouseWatcherRegion.cxx.

References PGItem::within_region().

void PGMouseWatcherRegion::without_region ( const MouseWatcherParameter param) [virtual]

This is a callback hook function, called whenever the mouse moves completely outside the boundaries of the region.

See within_region().

Reimplemented from MouseWatcherRegion.

Definition at line 104 of file pgMouseWatcherRegion.cxx.

References PGItem::without_region().


The documentation for this class was generated from the following files:
 All Classes Functions Variables Enumerations