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

#include "windowHandle.h"

Inheritance diagram for WindowHandle:

Classes
class	OSHandle

Public Member Functions
	WindowHandle (OSHandle *os_handle)

	WindowHandle (const WindowHandle &copy)

virtual void	attach_child (WindowHandle *child)
	Called on a parent handle to indicate a child window's intention to attach itself. More...

virtual void	detach_child (WindowHandle *child)
	Called on a parent handle to indicate a child window's intention to detach itself. More...

virtual TypeHandle	force_init_type ()

size_t	get_int_handle () const
	Returns the OS-specific handle converted to an integer, if this is possible for the particular representation. More...

OSHandle *	get_os_handle () const

virtual TypeHandle	get_type () const

void	output (std::ostream &out) const

virtual void	receive_windows_message (unsigned int msg, int wparam, int lparam)
	Called on a child handle to deliver a keyboard button event generated in the parent window. More...

virtual void	request_keyboard_focus (WindowHandle *child)
	Called on a parent handle to indicate a child window's wish to receive keyboard button events. More...

void	send_windows_message (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. More...

void	set_os_handle (OSHandle *os_handle)

Public Member Functions inherited from TypedReferenceCount
	TypedReferenceCount (const TypedReferenceCount &copy)

void	operator= (const TypedReferenceCount &copy)

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. More...

const TypedObject *	as_typed_object () const
	Returns the object, upcast (if necessary) to a TypedObject pointer. More...

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. More...

bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly. More...

bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type. More...

TypedObject &	operator= (const TypedObject &copy)=default

Public Member Functions inherited from ReferenceCount
int	get_ref_count () const

WeakReferenceList *	get_weak_list () const
	Returns the WeakReferenceList associated with this ReferenceCount object. More...

bool	has_weak_list () const
	Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. More...

void	local_object ()
	This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. More...

void	ref () const
	Explicitly increments the reference count. More...

bool	ref_if_nonzero () const
	Atomically increases the reference count of this object if it is not zero. More...

bool	test_ref_count_integrity () const
	Does some easy checks to make sure that the reference count isn't completely bogus. More...

bool	test_ref_count_nonzero () const
	Does some easy checks to make sure that the reference count isn't zero, or completely bogus. More...

virtual bool	unref () const
	Explicitly decrements the reference count. More...

WeakReferenceList *	weak_ref ()
	Adds the indicated PointerToVoid as a weak reference to this object. More...

void	weak_unref ()
	Removes the indicated PointerToVoid as a weak reference to this object. More...

Static Public Member Functions
static TypeHandle	get_class_type ()

static void	init_type ()

Static Public Member Functions inherited from TypedReferenceCount
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. More...

Static Public Member Functions inherited from ReferenceCount
static TypeHandle	get_class_type ()

static void	init_type ()

Public Attributes
	get_os_handle
	Returns the OS-specific handle stored internally to the WindowHandle wrapper. More...

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

Public Attributes inherited from TypedObject
	get_type

Public Attributes inherited from ReferenceCount
	get_ref_count
	Returns the current reference count. More...

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.

Definition at line 34 of file windowHandle.h.

Member Function Documentation

◆ attach_child()

void WindowHandle::attach_child ( WindowHandle * child )

virtual

Called on a parent handle to indicate a child window's intention to attach itself.

Definition at line 68 of file windowHandle.cxx.

◆ detach_child()

void WindowHandle::detach_child ( WindowHandle * child )

virtual

Called on a parent handle to indicate a child window's intention to detach itself.

Definition at line 76 of file windowHandle.cxx.

◆ get_int_handle()

size_t WindowHandle::get_int_handle ( ) const

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

Returns 0 if it is not.

Definition at line 44 of file windowHandle.cxx.

◆ receive_windows_message()

void WindowHandle::receive_windows_message	(	unsigned int	msg,
		int	wparam,
		int	lparam
	)

virtual

Called on a child handle to deliver a keyboard button event generated in the parent window.

Definition at line 96 of file windowHandle.cxx.

◆ request_keyboard_focus()

void WindowHandle::request_keyboard_focus ( WindowHandle * child )

virtual

Called on a parent handle to indicate a child window's wish to receive keyboard button events.

Definition at line 87 of file windowHandle.cxx.

◆ send_windows_message()

void WindowHandle::send_windows_message	(	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.

Definition at line 33 of file windowHandle.cxx.

Member Data Documentation

◆ get_os_handle

WindowHandle::OSHandle * WindowHandle::get_os_handle

inline

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

Definition at line 44 of file windowHandle.h.

◆ set_os_handle

void WindowHandle::set_os_handle

inline

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

Definition at line 44 of file windowHandle.h.

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

panda/src/display/windowHandle.h
panda/src/display/windowHandle.cxx
panda/src/display/windowHandle.I

Classes

Public Member Functions

Static Public Member Functions

Public Attributes

Detailed Description

Member Function Documentation

◆ attach_child()

◆ detach_child()

◆ get_int_handle()

◆ receive_windows_message()

◆ request_keyboard_focus()

◆ send_windows_message()

Member Data Documentation

◆ get_os_handle

◆ set_os_handle