Panda3D
Classes | Public Member Functions | Static Public Member Functions

WindowHandle Class Reference

This object represents a window on the desktop, not necessarily a Panda window. More...

Inheritance diagram for WindowHandle:
TypedReferenceCount TypedObject ReferenceCount MemoryBase MemoryBase NativeWindowHandle

List of all members.

Classes

class  OSHandle

Public Member Functions

 WindowHandle (WindowHandle const copy)
 WindowHandle (OSHandle os_handle)
unsigned int getIntHandle ()
 Returns the OS-specific handle converted to an integer, if this is possible for the particular representation.
OSHandle getOsHandle ()
 Returns the OS-specific handle stored internally to the WindowHandle wrapper.
int getRefCount ()
 Returns the current reference count.
TypeHandle getType ()
int getTypeIndex ()
 Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.
bool isExactType (TypeHandle handle)
 Returns true if the current object is the indicated type exactly.
bool isOfType (TypeHandle handle)
 Returns true if the current object is or derives from the indicated type.
 output (ostream out)
 ref ()
 Explicitly increments the reference count.
 sendWindowsMessage (unsigned int msg, int wparam, int lparam)
 Call this method on a parent WindowHandle to deliver a Windows message to the current child window, if any.
 setOsHandle (OSHandle os_handle)
 Changes the OS-specific handle stored internally to the WindowHandle wrapper.
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
bool unref ()
 Explicitly decrements the reference count.

Static Public Member Functions

static TypeHandle getClassType ()

Detailed Description

This object represents a window on the desktop, not necessarily a Panda window.

This structure can be assigned to a WindowProperties to indicate a parent window.

It also has callbacks so the Panda window can communicate with its parent window, which is particularly important when running embedded in a browser.

To create a WindowHandle, you would usually call one of the NativeWindowHandle.make_*() methods, depending on the kind of native window handle object you already have.


Constructor & Destructor Documentation

WindowHandle ( WindowHandle const  copy)
WindowHandle ( OSHandle  os_handle)

Member Function Documentation

static TypeHandle getClassType ( ) [static]

Reimplemented from TypedReferenceCount.

Reimplemented in NativeWindowHandle.

unsigned int getIntHandle ( )

Returns the OS-specific handle converted to an integer, if this is possible for the particular representation.

Returns 0 if it is not.

OSHandle getOsHandle ( )

Returns the OS-specific handle stored internally to the WindowHandle wrapper.

int getRefCount ( ) [inherited]

Returns the current reference count.

TypeHandle getType ( ) [inherited]

Reimplemented in AnimChannelBase.

int getTypeIndex ( ) [inherited]

Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.

This is equivalent to get_type().get_index().

bool isExactType ( TypeHandle  handle) [inherited]

Returns true if the current object is the indicated type exactly.

bool isOfType ( TypeHandle  handle) [inherited]

Returns true if the current object is or derives from the indicated type.

output ( ostream  out)
ref ( ) [inherited]

Explicitly increments the reference count.

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

sendWindowsMessage ( unsigned int  msg,
int  wparam,
int  lparam 
)

Call this method on a parent WindowHandle to deliver a Windows message to the current child window, if any.

This is used in the web plugin system to deliver button events detected directly by the browser system into Panda, which is particularly necessary on Vista.

setOsHandle ( OSHandle  os_handle)

Changes the OS-specific handle stored internally to the WindowHandle wrapper.

bool testRefCountIntegrity ( ) [inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Returns true if ok, false otherwise.

Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.

bool testRefCountNonzero ( ) [inherited]

Does some easy checks to make sure that the reference count isn't zero, or completely bogus.

Returns true if ok, false otherwise.

bool unref ( ) [inherited]

Explicitly decrements the reference count.

Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete().

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

The return value is true if the new reference count is nonzero, false if it is zero.

Reimplemented in GeomVertexArrayFormat, and GeomVertexFormat.

 All Classes Namespaces Functions Variables Enumerations Enumerator Properties