vgui_wx Class Reference

#include <vgui_wx.h>

Inheritance diagram for vgui_wx:

List of all members.

---

Detailed Description

wxWidgets implementation of vgui_toolkit.

Provides functions for controlling the event loop and creating new windows and dialogs.

Definition at line 23 of file vgui_wx.h.

Public Member Functions
virtual vgui_dialog_extensions_impl *	produce_dialog_extension (char const *name)
Static Public Member Functions
static vgui_wx *	instance ()
	Singleton method instance.
static void	InitVguiHandlers ()
	Initialize all vgui_wx XML Resource Handlers.
static vgui_toolkit *	lookup (char const *)
static vcl_vector< vgui_toolkit * > *	registry ()
Private Member Functions
virtual vcl_string	name () const
	Returns the name of the GUI toolkit ("wx").
	vgui_wx ()
	Constructor - default.
virtual	~vgui_wx ()
	Destructor.
virtual void	init (int &, char **)
	Initialize the wxWidgets GUI framework.
virtual void	uninit ()
virtual void	run ()
	Run the event loop.
virtual void	run_one_event ()
	Run the next event.
virtual void	run_till_idle ()
	Run until event queue is empty.
virtual void	flush ()
	Clear all events from the queue.
virtual void	add_event (const vgui_event &)
	Add an event to the queue.
virtual void	quit ()
	Quit the application.
virtual vgui_window *	produce_window (int width, int height, const vgui_menu &menubar, const char *title="vgui wx window")
	Create a new window with a menubar.
virtual vgui_window *	produce_window (int width, int height, const char *title="vgui wx popup")
	Create a new window.
virtual vgui_dialog_impl *	produce_dialog (const char *name)
	Create a new dialog window.
Private Attributes
vcl_vector< vgui_window * >	windows_to_delete_
	Handle to windows created that need deleting.
bool	adaptor_embedded_
	True if we are embedding vgui_adaptor into wxWidgets app.

---

Constructor & Destructor Documentation

vgui_wx::vgui_wx

(

)

[private]

Constructor - default.

Definition at line 52 of file vgui_wx.cxx.

vgui_wx::~vgui_wx

(

)

[private, virtual]

Destructor.

Definition at line 61 of file vgui_wx.cxx.

---

Member Function Documentation

vgui_wx * vgui_wx::instance

(

)

[static]

Singleton method instance.

Definition at line 42 of file vgui_wx.cxx.

vcl_string vgui_wx::name

(

)

const [private, virtual]

Returns the name of the GUI toolkit ("wx").

Implements vgui_toolkit.

Definition at line 49 of file vgui_wx.cxx.

void vgui_wx::init	(	int &	,
		char **
	)			[private, virtual]

Initialize the wxWidgets GUI framework.

Reimplemented from vgui_toolkit.

Definition at line 69 of file vgui_wx.cxx.

void vgui_wx::uninit

(

)

[private, virtual]

Reimplemented from vgui_toolkit.

Definition at line 137 of file vgui_wx.cxx.

void vgui_wx::run

(

)

[private, virtual]

Run the event loop.

Implements vgui_toolkit.

Definition at line 183 of file vgui_wx.cxx.

void vgui_wx::run_one_event

(

)

[private, virtual]

Run the next event.

Reimplemented from vgui_toolkit.

Definition at line 200 of file vgui_wx.cxx.

void vgui_wx::run_till_idle

(

)

[private, virtual]

Run until event queue is empty.

Reimplemented from vgui_toolkit.

Definition at line 206 of file vgui_wx.cxx.

void vgui_wx::flush

(

)

[private, virtual]

Clear all events from the queue.

Reimplemented from vgui_toolkit.

Definition at line 217 of file vgui_wx.cxx.

void vgui_wx::add_event

(

const vgui_event &

)

[private, virtual]

Add an event to the queue.

Reimplemented from vgui_toolkit.

Definition at line 224 of file vgui_wx.cxx.

void vgui_wx::quit

(

)

[private, virtual]

Quit the application.

Reimplemented from vgui_toolkit.

Definition at line 231 of file vgui_wx.cxx.

vgui_window * vgui_wx::produce_window	(	int	width,
		int	height,
		const vgui_menu &	menubar,
		const char *	title = "vgui wx window"
	)			[private, virtual]

Create a new window with a menubar.

Reimplemented from vgui_toolkit.

Definition at line 248 of file vgui_wx.cxx.

vgui_window * vgui_wx::produce_window	(	int	width,
		int	height,
		const char *	title = "vgui wx popup"
	)			[private, virtual]

Create a new window.

Reimplemented from vgui_toolkit.

Definition at line 258 of file vgui_wx.cxx.

vgui_dialog_impl * vgui_wx::produce_dialog

(

const char *

name

)

[private, virtual]

Create a new dialog window.

Reimplemented from vgui_toolkit.

Definition at line 267 of file vgui_wx.cxx.

void vgui_wx::InitVguiHandlers

(

)

[static]

Initialize all vgui_wx XML Resource Handlers.

Call this right after you call wxXmlResource::Get()->InitAllHandlers();

Definition at line 15 of file vgui_wx.cxx.

vgui_dialog_extensions_impl * vgui_toolkit::produce_dialog_extension

(

char const *

name

)

[virtual, inherited]

Reimplemented in vgui_mfc.

Definition at line 90 of file vgui_toolkit.cxx.

vgui_toolkit * vgui_toolkit::lookup

(

char const *

)

[static, inherited]

Definition at line 28 of file vgui_toolkit.cxx.

vcl_vector< vgui_toolkit * > * vgui_toolkit::registry

(

)

[static, inherited]

Definition at line 22 of file vgui_toolkit.cxx.

---

Member Data Documentation

vcl_vector<vgui_window*> vgui_wx::windows_to_delete_ [private]

Handle to windows created that need deleting.

Definition at line 75 of file vgui_wx.h.

bool vgui_wx::adaptor_embedded_ [private]

True if we are embedding vgui_adaptor into wxWidgets app.

Definition at line 78 of file vgui_wx.h.

---

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

• core/vgui/impl/wx/vgui_wx.h
• core/vgui/wx/vgui_wx.h
• core/vgui/impl/wx/vgui_wx.cxx
• core/vgui/wx/vgui_wx.cxx

---