ModalGump Class Reference

#include <ModalGump.h>

Inheritance diagram for ModalGump:

List of all members.

Public Member Functions
	ENABLE_RUNTIME_CLASSTYPE ()
	ModalGump ()
	ModalGump (int x, int y, int width, int height, uint16 owner=0, uint32 _Flags=0, sint32 layer=LAYER_MODAL)
	~ModalGump ()
virtual void	InitGump (Gump *newparent, bool take_focus=true)
virtual void	Close (bool no_del=false)
virtual bool	PointOnGump (int mx, int my)
virtual Gump *	FindGump (int mx, int my)
virtual uint16	TraceObjId (int mx, int my)
virtual Gump *	OnMouseDown (int button, int mx, int my)
bool	loadData (IDataSource *ids, uint32 version)
Protected Member Functions
virtual void	saveData (ODataSource *ods)

---

Detailed Description

Definition at line 24 of file ModalGump.h.

---

Constructor & Destructor Documentation

ModalGump::ModalGump

(

)

Definition at line 31 of file ModalGump.cpp.

ModalGump::ModalGump	(	int	x,
		int	y,
		int	width,
		int	height,
		uint16	owner = 0,
		uint32	_Flags = 0,
		sint32	layer = LAYER_MODAL
	)

Definition at line 37 of file ModalGump.cpp.

ModalGump::~ModalGump

(

)

Definition at line 44 of file ModalGump.cpp.

---

Member Function Documentation

void ModalGump::Close

(

bool

no_del = false

)

[virtual]

Close the gump

Parameters:

no_del

If true, do not delete after closing

Reimplemented from Gump.

Reimplemented in CreditsGump, MenuGump, MovieGump, PagedGump, SliderGump, and TargetGump.

Definition at line 82 of file ModalGump.cpp.

References Gump::Close(), AudioProcess::get_instance(), Kernel::get_instance(), GUIApp::get_instance(), GUIApp::leaveTextMode(), Kernel::unpause(), and AudioProcess::unpauseAllSamples().

Referenced by QuitGump::ChildNotify(), TargetGump::Close(), SliderGump::Close(), PagedGump::Close(), MovieGump::Close(), MenuGump::Close(), CreditsGump::Close(), ScrollGump::NextText(), BookGump::NextText(), ShapeViewerGump::OnKeyDown(), QuitGump::OnKeyDown(), BindGump::OnKeyDown(), ScrollGump::OnMouseDouble(), BookGump::OnMouseDouble(), ReadableGump::OnMouseDown(), BindGump::OnMouseDown(), QuitGump::OnTextInput(), and ShapeViewerGump::PaintThis().

ModalGump::ENABLE_RUNTIME_CLASSTYPE

(

)

Reimplemented from Gump.

Reimplemented in BindGump, BookGump, CreditsGump, MenuGump, MovieGump, PagedGump, PentagramMenuGump, QuitGump, ReadableGump, ScrollGump, ShapeViewerGump, SliderGump, and TargetGump.

Gump * ModalGump::FindGump	(	int	mx,
		int	my
	)			[virtual]

Find gump (this, child or NULL) at parent coordinates (mx,my)

Returns:

the Gump at these coordinates, or NULL if none

Reimplemented from Gump.

Definition at line 61 of file ModalGump.cpp.

References Gump::FindGump().

void ModalGump::InitGump	(	Gump *	newparent,
		bool	take_focus = true
	)			[virtual]

Init the gump and add it to parent; call after construction When newparent is 0, this will call GUIApp::addGump().

Parameters:

	newparent	The Gump's new parent or 0.
	takefocus	If true, set parent's focus_child to this

Reimplemented from Gump.

Reimplemented in BindGump, BookGump, CreditsGump, MenuGump, MovieGump, PagedGump, PentagramMenuGump, QuitGump, ReadableGump, ScrollGump, SliderGump, and TargetGump.

Definition at line 48 of file ModalGump.cpp.

References GUIApp::enterTextMode(), AudioProcess::get_instance(), Kernel::get_instance(), GUIApp::get_instance(), Gump::InitGump(), Kernel::pause(), and AudioProcess::pauseAllSamples().

Referenced by TargetGump::InitGump(), SliderGump::InitGump(), ScrollGump::InitGump(), ReadableGump::InitGump(), QuitGump::InitGump(), PentagramMenuGump::InitGump(), PagedGump::InitGump(), MovieGump::InitGump(), MenuGump::InitGump(), CreditsGump::InitGump(), BookGump::InitGump(), BindGump::InitGump(), MenuGump::inputName(), MenuGump::showMenu(), ShapeViewerGump::U8ShapeViewer(), and QuitGump::verifyQuit().

bool ModalGump::loadData	(	IDataSource *	ids,
		uint32	version
	)

Reimplemented from Gump.

Reimplemented in BookGump, ReadableGump, ScrollGump, SliderGump, and TargetGump.

Definition at line 108 of file ModalGump.cpp.

Gump * ModalGump::OnMouseDown	(	int	button,
		int	mx,
		int	my
	)			[virtual]

Reimplemented from Gump.

Reimplemented in BindGump, PentagramMenuGump, and ReadableGump.

Definition at line 95 of file ModalGump.cpp.

References Gump::OnMouseDown().

bool ModalGump::PointOnGump	(	int	mx,
		int	my
	)			[virtual]

Detect if a point is on the gump.

Reimplemented from Gump.

Reimplemented in TargetGump.

Definition at line 69 of file ModalGump.cpp.

Referenced by TargetGump::PointOnGump().

void ModalGump::saveData

(

ODataSource *

ods

)

[protected, virtual]

save the actual Object data

Reimplemented from Gump.

Reimplemented in BindGump, BookGump, MovieGump, PagedGump, QuitGump, ReadableGump, ScrollGump, ShapeViewerGump, SliderGump, and TargetGump.

Definition at line 103 of file ModalGump.cpp.

uint16 ModalGump::TraceObjId	(	int	mx,
		int	my
	)			[virtual]

Trace a click, and return ObjId.

Reimplemented from Gump.

Reimplemented in PentagramMenuGump.

Definition at line 74 of file ModalGump.cpp.

References Object::getObjId(), Object::objid, and Gump::TraceObjId().

---

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

• ModalGump.h
• ModalGump.cpp

---