Panda3D

Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
PGMouseWatcherBackground Class Reference

This is a special kind of MouseWatcherRegion that doesn't have a rectangle and is never active, but just quietly listens for keypresses and sends them to all the PGItems with background focus. More...

`#include "pgMouseWatcherBackground.h"`

Inheritance diagram for PGMouseWatcherBackground:

## Public Member Functions
virtual void | candidate (const MouseWatcherParameter &param)
| This is a callback hook function, called whenever the user uses the IME.
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 | 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 background.
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.
Public Member Functions inherited from MouseWatcherRegion
| MouseWatcherRegion (const std::string &name, const LVecBase4 &frame)
| MouseWatcherRegion (const std::string &name, PN_stdfloat left, PN_stdfloat right, PN_stdfloat bottom, PN_stdfloat top)
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.
bool | get_active () const
PN_stdfloat | get_area () const
const LVecBase4 & | get_frame () const
bool | get_keyboard () const
int | get_sort () const
int | get_suppress_flags () const
virtual void | move (const MouseWatcherParameter &param)
| This is a callback hook function, called whenever a mouse is moved within the region.
bool | operator< (const MouseWatcherRegion &other) const
| Returns true if this region should be preferred over the other region when they overlap, false otherwise.
void | output (std::ostream &out) const
void | set_active (bool active)
void | set_frame (const LVecBase4 &frame)
void | set_frame (PN_stdfloat left, PN_stdfloat right, PN_stdfloat bottom, PN_stdfloat top)
void | set_keyboard (bool keyboard)
void | set_sort (int sort)
void | set_suppress_flags (int suppress_flags)
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.
void | write (std::ostream &out, int indent_level=0) const
Public Member Functions inherited from TypedWritableReferenceCount
| TypedWritableReferenceCount (const TypedWritableReferenceCount &copy)
virtual ReferenceCount * | as_reference_count ()
| Returns the pointer cast to a ReferenceCount pointer, if it is in fact of that type.
void | operator= (const TypedWritableReferenceCount &copy)
Public Member Functions inherited from TypedWritable
| TypedWritable (const TypedWritable &copy)
virtual int | complete_pointers (TypedWritable **p_list, BamReader *manager)
| Receives an array of pointers, one for each time manager->read_pointer() was called in fillin().
vector_uchar | encode_to_bam_stream () const
| Converts the TypedWritable object into a single stream of data using a BamWriter, and returns that data as a bytes object.
bool | encode_to_bam_stream (vector_uchar &data, BamWriter *writer=nullptr) const
| Converts the TypedWritable object into a single stream of data using a BamWriter, and stores that data in the indicated string.
virtual void | fillin (DatagramIterator &scan, BamReader *manager)
| This internal function is intended to be called by each class's make_from_bam() method to read in all of the relevant data from the BamFile for the new object.
virtual void | finalize (BamReader *manager)
| Called by the BamReader to perform any final actions needed for setting up the object after all objects have been read and all pointers have been completed.
UpdateSeq | get_bam_modified () const
| Returns the current bam_modified counter.
void | mark_bam_modified ()
| Increments the bam_modified counter, so that this object will be invalidated and retransmitted on any open bam streams.
void | operator= (const TypedWritable &copy)
virtual bool | require_fully_complete () const
| Some objects require all of their nested pointers to have been completed before the objects themselves can be completed.
virtual void | update_bam_nested (BamWriter *manager)
| Called by the BamWriter when this object has not itself been modified recently, but it should check its nested objects for updates.
virtual void | write_datagram (BamWriter *manager, Datagram &dg)
| Writes the contents of this object to the datagram for shipping out to a Bam file.
Public Member Functions inherited from TypedObject
| TypedObject (const TypedObject &copy)=default
TypedObject * | as_typed_object ()
| Returns the object, upcast (if necessary) to a TypedObject pointer.
const TypedObject * | as_typed_object () const
| Returns the object, upcast (if necessary) to a TypedObject pointer.
int | get_best_parent_from_Set (const std::set< int > &) const
int | get_type_index () const
| Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
bool | is_exact_type (TypeHandle handle) const
| Returns true if the current object is the indicated type exactly.
bool | is_of_type (TypeHandle handle) const
| Returns true if the current object is or derives from the indicated type.
TypedObject & | operator= (const TypedObject &copy)=default
Public Member Functions inherited from MemoryBase
void | operator delete (void *, void *)
void | operator delete (void *ptr)
void | operator delete[] (void *, void *)
void | operator delete[] (void *ptr)
void * | operator new (size_t size)
void * | operator new (size_t size, void *ptr)
void * | operator new[] (size_t size)
void * | operator new[] (size_t size, void *ptr)
Public Member Functions inherited from ReferenceCount
int | get_ref_count () const
WeakReferenceList * | get_weak_list () const
| Returns the WeakReferenceList associated with this ReferenceCount object.
bool | has_weak_list () const
| Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
void | local_object ()
| This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
void | ref () const
| Explicitly increments the reference count.
bool | ref_if_nonzero () const
| Atomically increases the reference count of this object if it is not zero.
bool | test_ref_count_integrity () const
| Does some easy checks to make sure that the reference count isn't completely bogus.
bool | test_ref_count_nonzero () const
| Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
virtual bool | unref () const
| Explicitly decrements the reference count.
bool | unref_if_one () const
| Atomically decreases the reference count of this object if it is one.
WeakReferenceList * | weak_ref ()
| Adds the indicated PointerToVoid as a weak reference to this object.
void | weak_unref ()
| Removes the indicated PointerToVoid as a weak reference to this object.
Public Member Functions inherited from Namable
| Namable (const std::string &initial_name="")
void | clear_name ()
| Resets the Namable's name to empty.
const std::string & | get_name () const
bool | has_name () const
| Returns true if the Namable has a nonempty name set, false if the name is empty.
void | output (std::ostream &out) const
| Outputs the Namable.
void | set_name (const std::string &name)

## Static Public Member Functions
static TypeHandle | get_class_type ()
static void | init_type ()
Static Public Member Functions inherited from MouseWatcherRegion
static TypeHandle | get_class_type ()
static void | init_type ()
Static Public Member Functions inherited from TypedWritableReferenceCount
static TypeHandle | get_class_type ()
static void | init_type ()
static | PT (TypedWritableReferenceCount) decode_from_bam_stream(vector_uchar data
Static Public Member Functions inherited from TypedWritable
static bool | decode_raw_from_bam_stream (TypedWritable *&ptr, ReferenceCount *&ref_ptr, vector_uchar data, BamReader *reader=nullptr)
| Reads the bytes created by a previous call to encode_to_bam_stream(), and extracts the single object on those bytes.
static TypeHandle | get_class_type ()
static void | init_type ()
Static Public Member Functions inherited from TypedObject
static TypeHandle | get_class_type ()
static void | init_type ()
| This function is declared non-inline to work around a compiler bug in g++ 2.96.
Static Public Member Functions inherited from ReferenceCount
static TypeHandle | get_class_type ()
static void | init_type ()
Static Public Member Functions inherited from Namable
static TypeHandle | get_class_type ()
static void | init_type ()

## Additional Inherited Members
Public Types inherited from MouseWatcherRegion
enum | SuppressFlags { SF_mouse_button = 0x001 , SF_other_button = 0x002 , SF_any_button = 0x003 , SF_mouse_position = 0x004 }
Public Attributes inherited from MouseWatcherRegion
| get_active
| Returns whether the region is active or not.
| get_area
| Returns the area of the rectangular region.
| get_frame
| get_keyboard
| Returns whether the region is interested in global keyboard events; see set_keyboard().
| get_sort
| Returns the current sorting order of this region.
| get_suppress_flags
| Returns the current suppress_flags.
| set_active
| Sets whether the region is active or not.
| set_frame
| set_keyboard
| Sets whether the region is interested in global keyboard events.
| set_sort
| Changes the sorting order of this particular region.
| set_suppress_flags
| Sets which events are suppressed when the mouse is over the region.
Public Attributes inherited from TypedWritableReferenceCount
static BamReader * | reader = nullptr)
Public Attributes inherited from TypedObject
| get_type
Public Attributes inherited from ReferenceCount
| get_ref_count
| Returns the current reference count.
Public Attributes inherited from Namable
| get_name
| set_name
Static Public Attributes inherited from TypedWritable
static TypedWritable *const | Null = nullptr

## Detailed Description

This is a special kind of MouseWatcherRegion that doesn't have a rectangle and is never active, but just quietly listens for keypresses and sends them to all the PGItems with background focus.

Definition at line 26 of file pgMouseWatcherBackground.h.

## Constructor & Destructor Documentation

## ◆ PGMouseWatcherBackground()

PGMouseWatcherBackground::PGMouseWatcherBackground | ( |  | ) |

Definition at line 22 of file pgMouseWatcherBackground.cxx.

## ◆ ~PGMouseWatcherBackground()

PGMouseWatcherBackground::~PGMouseWatcherBackground | ( |  | ) |
| virtual

Definition at line 33 of file pgMouseWatcherBackground.cxx.

## Member Function Documentation

## ◆ candidate()

void PGMouseWatcherBackground::candidate | ( | const MouseWatcherParameter & | param | ) |
| virtual

This is a callback hook function, called whenever the user uses the IME.

Reimplemented from MouseWatcherRegion.

Definition at line 66 of file pgMouseWatcherBackground.cxx.

References PGItem::background_candidate().

## ◆ force_init_type()

virtual TypeHandle PGMouseWatcherBackground::force_init_type | ( |  | ) |
| inline virtual

Reimplemented from MouseWatcherRegion.

Definition at line 49 of file pgMouseWatcherBackground.h.

## ◆ get_class_type()

static TypeHandle PGMouseWatcherBackground::get_class_type | ( |  | ) |
| inline static

Definition at line 38 of file pgMouseWatcherBackground.h.

## ◆ get_type()

virtual TypeHandle PGMouseWatcherBackground::get_type | ( |  | ) | const
| inline virtual

Reimplemented from MouseWatcherRegion.

Definition at line 46 of file pgMouseWatcherBackground.h.

## ◆ init_type()

static void PGMouseWatcherBackground::init_type | ( |  | ) |
| inline static

Definition at line 41 of file pgMouseWatcherBackground.h.

## ◆ keystroke()

void PGMouseWatcherBackground::keystroke | ( | const MouseWatcherParameter & | param | ) |
| virtual

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

Reimplemented from MouseWatcherRegion.

Definition at line 58 of file pgMouseWatcherBackground.cxx.

References PGItem::background_keystroke().

## ◆ press()

void PGMouseWatcherBackground::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 background.

Reimplemented from MouseWatcherRegion.

Definition at line 41 of file pgMouseWatcherBackground.cxx.

References PGItem::background_press().

## ◆ release()

void PGMouseWatcherBackground::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 50 of file pgMouseWatcherBackground.cxx.

References PGItem::background_release().

The documentation for this class was generated from the following files:

- panda/src/pgui/pgMouseWatcherBackground.h
- panda/src/pgui/pgMouseWatcherBackground.cxx