Gump Class Reference

#include <Gump.h>

Inheritance diagram for Gump:


Public Types
	CENTER = 1
	TOP_LEFT = 2
	TOP_RIGHT = 3
	BOTTOM_LEFT = 4
	BOTTOM_RIGHT = 5
	TOP_CENTER = 6
	BOTTOM_CENTER = 7
	ROUND_TOPLEFT = 0
	ROUND_BOTTOMRIGHT = 1
	ROUND_INSIDE
	ROUND_OUTSIDE
	FLAG_DRAGGABLE = 0x01
	FLAG_HIDDEN = 0x02
	FLAG_CLOSING = 0x04
	FLAG_CLOSE_AND_DEL = 0x08
	FLAG_ITEM_DEPENDENT = 0x10
	FLAG_DONT_SAVE = 0x20
	FLAG_CORE_GUMP = 0x40
	FLAG_KEEP_VISIBLE = 0x80
	LAYER_DESKTOP = -16
	LAYER_GAMEMAP = -8
	LAYER_NORMAL = 0
	LAYER_ABOVE_NORMAL = 8
	LAYER_MODAL = 12
	LAYER_CONSOLE = 16
enum	Position { CENTER = 1, TOP_LEFT = 2, TOP_RIGHT = 3, BOTTOM_LEFT = 4, BOTTOM_RIGHT = 5, TOP_CENTER = 6, BOTTOM_CENTER = 7 }
enum	PointRoundDir { ROUND_TOPLEFT = 0, ROUND_BOTTOMRIGHT = 1 }
enum	RectRoundDir { ROUND_INSIDE, ROUND_OUTSIDE }
enum	GumpFlags { FLAG_DRAGGABLE = 0x01, FLAG_HIDDEN = 0x02, FLAG_CLOSING = 0x04, FLAG_CLOSE_AND_DEL = 0x08, FLAG_ITEM_DEPENDENT = 0x10, FLAG_DONT_SAVE = 0x20, FLAG_CORE_GUMP = 0x40, FLAG_KEEP_VISIBLE = 0x80 }
enum	GumpLayers { LAYER_DESKTOP = -16, LAYER_GAMEMAP = -8, LAYER_NORMAL = 0, LAYER_ABOVE_NORMAL = 8, LAYER_MODAL = 12, LAYER_CONSOLE = 16 }
Public Member Functions
	ENABLE_RUNTIME_CLASSTYPE ()
	Gump ()
	Gump (int x, int y, int width, int height, uint16 owner=0, uint32 _Flags=0, sint32 layer=LAYER_NORMAL)
virtual	~Gump ()
virtual void	CreateNotifier ()
void	SetNotifyProcess (GumpNotifyProcess *proc)
GumpNotifyProcess *	GetNotifyProcess ()
uint32	GetResult ()
void	SetShape (Shape *_shape, uint32 _framenum)
void	SetShape (FrameID frame, bool adjustsize=false)
void	SetFramenum (uint32 _framenum)
virtual void	InitGump (Gump *newparent, bool take_focus=true)
virtual Gump *	FindGump (const RunTimeClassType &t, bool recursive=true, bool no_inheritance=false)
template<class T>
Gump *	FindGump (bool recursive=true, bool no_inheritance=false)
virtual Gump *	FindGump (int mx, int my)
virtual bool	GetMouseCursor (int mx, int my, Shape &shape, sint32 &frame)
virtual void	RenderSurfaceChanged ()
virtual bool	Run (const uint32 framenum)
virtual void	CloseItemDependents (void)
virtual void	Paint (RenderSurface *surf, sint32 lerp_factor, bool scaled)
virtual void	PaintCompositing (RenderSurface *surf, sint32 lerp_factor, sint32 scalex, sint32 scaley)
virtual void	Close (bool no_del=false)
bool	IsClosing ()
virtual void	Move (int x_, int y_)
virtual void	MoveRelative (int x_, int y_)
virtual void	setRelativePosition (Position pos, int xoffset=0, int yoffset=0)
virtual void	GetDims (Pentagram::Rect &d)
virtual bool	PointOnGump (int mx, int my)
virtual void	ScreenSpaceToGump (int &sx, int &sy, PointRoundDir r=ROUND_TOPLEFT)
virtual void	GumpToScreenSpace (int &gx, int &gy, PointRoundDir r=ROUND_TOPLEFT)
virtual void	ParentToGump (int &px, int &py, PointRoundDir r=ROUND_TOPLEFT)
virtual void	GumpToParent (int &gx, int &gy, PointRoundDir r=ROUND_TOPLEFT)
virtual void	GumpRectToScreenSpace (int &gx, int &gy, int &gw, int &gh, RectRoundDir r=ROUND_OUTSIDE)
virtual void	ScreenSpaceToGumpRect (int &sx, int &sy, int &sw, int &sh, RectRoundDir r=ROUND_OUTSIDE)
virtual uint16	TraceObjId (int mx, int my)
virtual bool	GetLocationOfItem (uint16 itemid, int &gx, int &gy, sint32 lerp_factor=256)
virtual Gump *	OnMouseDown (int button, int mx, int my)
virtual void	OnMouseUp (int button, int mx, int my)
virtual void	OnMouseClick (int button, int mx, int my)
virtual void	OnMouseDouble (int button, int mx, int my)
virtual Gump *	OnMouseMotion (int mx, int my)
virtual void	OnMouseOver ()
virtual void	OnMouseLeft ()
virtual bool	OnKeyDown (int key, int mod)
virtual bool	OnKeyUp (int key)
virtual bool	OnTextInput (int unicode)
virtual void	OnFocus (bool)
virtual void	MakeFocus ()
bool	IsFocus ()
Gump *	GetFocusChild ()
void	FindNewFocusChild ()
virtual void	AddChild (Gump *, bool take_focus=true)
virtual void	RemoveChild (Gump *)
virtual void	MoveChildToFront (Gump *)
Gump *	GetParent ()
Gump *	GetRootGump ()
virtual void	ChildNotify (Gump *child, uint32 message)
void	SetIndex (sint32 i)
sint32	GetIndex ()
virtual bool	StartDraggingChild (Gump *gump, int mx, int my)
virtual void	DraggingChild (Gump *gump, int mx, int my)
virtual void	StopDraggingChild (Gump *gump)
virtual bool	StartDraggingItem (Item *item, int mx, int my)
virtual bool	DraggingItem (Item *item, int mx, int my)
virtual void	DraggingItemLeftGump (Item *item)
virtual void	StopDraggingItem (Item *item, bool moved)
virtual void	DropItem (Item *item, int mx, int my)
bool	IsHidden ()
bool	IsDraggable ()
virtual void	HideGump ()
virtual void	UnhideGump ()
bool	mustSave (bool toplevel)
bool	loadData (IDataSource *ids, uint32 version)
Protected Member Functions
virtual void	PaintThis (RenderSurface *surf, sint32 lerp_factor, bool scaled)
virtual void	PaintChildren (RenderSurface *surf, sint32 lerp_factor, bool scaled)
virtual void	PaintComposited (RenderSurface *surf, sint32 lerp_factor, sint32 scalex, sint32 scaley)
virtual void	saveData (ODataSource *ods)
Static Protected Member Functions
static sint32	ScaleCoord (sint32 c, sint32 factor)
static sint32	UnscaleCoord (sint32 c, sint32 factor)
Protected Attributes
uint16	owner
Gump *	parent
sint32	x
sint32	y
Pentagram::Rect	dims
uint32	flags
sint32	layer
sint32	index
Shape *	shape
uint32	framenum
std::list< Gump * >	children
Gump *	focus_child
uint16	notifier
uint32	process_result
Friends
class	GumpList

Detailed Description

Definition at line 38 of file Gump.h.

Member Enumeration Documentation

enum Gump::GumpFlags

Enumerator:

FLAG_DRAGGABLE
FLAG_HIDDEN
FLAG_CLOSING
FLAG_CLOSE_AND_DEL
FLAG_ITEM_DEPENDENT
FLAG_DONT_SAVE
FLAG_CORE_GUMP
FLAG_KEEP_VISIBLE

Definition at line 379 of file Gump.h.

enum Gump::GumpLayers

Enumerator:

LAYER_DESKTOP
LAYER_GAMEMAP
LAYER_NORMAL
LAYER_ABOVE_NORMAL
LAYER_MODAL
LAYER_CONSOLE

Definition at line 403 of file Gump.h.

enum Gump::PointRoundDir

Enumerator:

ROUND_TOPLEFT
ROUND_BOTTOMRIGHT

Definition at line 217 of file Gump.h.

enum Gump::Position

Enumerator:

CENTER
TOP_LEFT
TOP_RIGHT
BOTTOM_LEFT
BOTTOM_RIGHT
TOP_CENTER
BOTTOM_CENTER

Definition at line 191 of file Gump.h.

enum Gump::RectRoundDir

Enumerator:

ROUND_INSIDE
ROUND_OUTSIDE

Definition at line 221 of file Gump.h.

Constructor & Destructor Documentation

Gump::Gump ( )

Definition at line 36 of file Gump.cpp.

Referenced by U8SaveGump::InitGump(), QuitGump::InitGump(), and MenuGump::InitGump().

Gump::Gump	(	int	x,
		int	y,
		int	width,
		int	height,
		uint16	owner = `0`,
		uint32	_Flags = `0`,
		sint32	layer = `LAYER_NORMAL`
	)

Definition at line 41 of file Gump.cpp.

References Object::assignObjId().

Gump::~Gump ( ) [virtual]

Definition at line 51 of file Gump.cpp.

References children, focus_child, and OnFocus().

Member Function Documentation

void Gump::AddChild	(	Gump *	,
		bool	take_focus = `true`
	)			`[virtual]`

Add a gump to the child list.

Definition at line 647 of file Gump.cpp.

References children, focus_child, GetParent(), if(), layer, and RemoveChild().

Referenced by GUIApp::addGump(), InitGump(), and loadData().

virtual void Gump::ChildNotify	(	Gump *	child,
		uint32	message
	)			`[inline, virtual]`

This function is used by our children to notifty us of 'something' Think of it as a generic call back function

Reimplemented in AskGump, ControlEntryGump, ControlsGump, MenuGump, OptionsGump, PagedGump, PaperdollGump, PentagramMenuGump, QuitGump, SliderGump, U8SaveGump, and GameWidget.

Definition at line 336 of file Gump.h.

Referenced by GameWidget::ChildNotify(), ControlEntryGump::ChildNotify(), EditWidget::OnKeyDown(), BindGump::OnKeyDown(), ButtonWidget::OnMouseClick(), ButtonWidget::OnMouseDouble(), BindGump::OnMouseDown(), and ButtonWidget::OnMouseUp().

void Gump::Close ( bool no_del = false ) [virtual]

Close the gump

Parameters:

no_del

If true, do not delete after closing

Reimplemented in ContainerGump, CreditsGump, MenuGump, ModalGump, MovieGump, PagedGump, PaperdollGump, SliderGump, TargetGump, and U8SaveGump.

Definition at line 115 of file Gump.cpp.

References FLAG_CLOSE_AND_DEL, FLAG_CLOSING, flags, GetNotifyProcess(), notifier, GumpNotifyProcess::notifyClosing(), parent, and process_result.

Referenced by U8SaveGump::ChildNotify(), AskGump::ChildNotify(), U8SaveGump::Close(), PaperdollGump::Close(), ModalGump::Close(), ContainerGump::Close(), Item::closeGump(), CloseItemDependents(), MiniMapGump::ConCmd_toggle(), FastAreaVisGump::ConCmd_toggle(), ItemRelativeGump::GetItemLocation(), Item::leaveFastArea(), OptionsGump::OnKeyDown(), MiniStatsGump::OnMouseDouble(), BarkGump::OnMouseDown(), BarkGump::Run(), and GumpNotifyProcess::terminate().

void Gump::CloseItemDependents ( void ) [virtual]

Close item-dependent gumps (recursively). Called when there is a map change (so the gumps can self terminate among other things), or when backspace is pressed by the user.

Definition at line 177 of file Gump.cpp.

References children, Close(), CloseItemDependents(), FindNewFocusChild(), FLAG_CLOSE_AND_DEL, FLAG_CLOSING, FLAG_ITEM_DEPENDENT, and flags.

Referenced by CloseItemDependents(), GUIApp::ConCmd_closeItemGumps(), and World::switchMap().

void Gump::CreateNotifier ( ) [virtual]

Definition at line 92 of file Gump.cpp.

References Kernel::addProcess(), Kernel::get_instance(), notifier, owner, and GumpNotifyProcess::setGump().

Referenced by ContainerGump::DropItem(), TargetGump::InitGump(), InitGump(), and MovieGump::U8MovieViewer().

void Gump::DraggingChild	(	Gump *	gump,
		int	mx,
		int	my
	)			`[virtual]`

Reimplemented in DesktopGump, PentagramMenuGump, and SliderGump.

Definition at line 736 of file Gump.cpp.

Referenced by GUIApp::moveDragging().

virtual bool Gump::DraggingItem	(	Item *	item,
		int	mx,
		int	my
	)			`[inline, virtual]`

Called when an item is being dragged over the gump. Note: this may be called on a different gump than StartDraggingItem.

Returns:: false if the item can't be dragged to this location.

Reimplemented in ContainerGump, GameMapGump, and PaperdollGump.

Definition at line 355 of file Gump.h.

Referenced by GUIApp::moveDragging().

virtual void Gump::DraggingItemLeftGump ( Item * item ) [inline, virtual]

Called when an item that was being dragged over the gump left the gump.

Reimplemented in ContainerGump, and GameMapGump.

Definition at line 359 of file Gump.h.

Referenced by GUIApp::moveDragging(), and GUIApp::stopDragging().

virtual void Gump::DropItem	(	Item *	item,
		int	mx,
		int	my
	)			`[inline, virtual]`

Called when an item has been dropped on a gump. This is called after StopDraggingItem has been called, but possibly on a different gump. It's guaranteed that a gump will only receive a DropItem at a location if a DraggingItem there returned true.

Reimplemented in ContainerGump, GameMapGump, and PaperdollGump.

Definition at line 372 of file Gump.h.

Referenced by GUIApp::stopDragging().

Gump::ENABLE_RUNTIME_CLASSTYPE ( )

Reimplemented from Object.

Reimplemented in AskGump, BarkGump, BindGump, BookGump, ConsoleGump, ContainerGump, ControlEntryGump, ControlsGump, CreditsGump, DesktopGump, FastAreaVisGump, GameMapGump, InverterGump, ItemRelativeGump, MenuGump, MiniMapGump, MiniStatsGump, ModalGump, MovieGump, OptionsGump, PagedGump, PaperdollGump, PentagramMenuGump, QuitGump, ReadableGump, ScalerGump, ScrollGump, ShapeViewerGump, SliderGump, TargetGump, U8SaveGump, ButtonWidget, EditWidget, GameWidget, SlidingWidget, and TextWidget.

Gump * Gump::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 in ModalGump.

Definition at line 366 of file Gump.cpp.

References children, FindGump(), ParentToGump(), and PointOnGump().

template<class T>

Gump* Gump::FindGump	(	bool	recursive = `true`,
		bool	no_inheritance = `false`
	)			`[inline]`

Find a gump of the specified type (this or child)

Parameters:

	T	Type of gump to look for
	recursive	Recursively search through children?
	no_inheritance	Exactly this type, or is a subclass also allowed?

Returns:: the desired Gump, or NULL if not found

Definition at line 110 of file Gump.h.

References FindGump().

Gump * Gump::FindGump	(	const RunTimeClassType &	t,
		bool	recursive = `true`,
		bool	no_inheritance = `false`
	)			`[virtual]`

Find a gump of the specified type (this or child)

Parameters:

	t	Type of gump to look for
	recursive	Recursively search through children?
	no_inheritance	Exactly this type, or is a subclass also allowed?

Returns:: the desired Gump, or NULL if not found

Definition at line 576 of file Gump.cpp.

References children, FLAG_CLOSING, and if().

Referenced by ScalerGump::ConCmd_changeScaler(), MiniMapGump::ConCmd_toggle(), FastAreaVisGump::ConCmd_toggle(), ModalGump::FindGump(), FindGump(), ItemRelativeGump::GetItemLocation(), ContainerGump::GetItemLocation(), GUIApp::moveDragging(), GUIApp::saveGame(), SliderGump::setSliderPos(), GUIApp::startDragging(), and GUIApp::stopDragging().

void Gump::FindNewFocusChild ( )

Definition at line 631 of file Gump.cpp.

References children, focus_child, and OnFocus().

Referenced by CloseItemDependents(), RemoveChild(), and Run().

virtual void Gump::GetDims ( Pentagram::Rect & d ) [inline, virtual]

Gump* Gump::GetFocusChild ( ) [inline]

Definition at line 309 of file Gump.h.

References focus_child.

sint32 Gump::GetIndex ( ) [inline]

Definition at line 338 of file Gump.h.

References index.

Referenced by U8SaveGump::ChildNotify(), SliderGump::ChildNotify(), OptionsGump::ChildNotify(), MenuGump::ChildNotify(), GameWidget::ChildNotify(), AskGump::ChildNotify(), SliderGump::DraggingChild(), PentagramMenuGump::PaintChildren(), and SliderGump::StartDraggingChild().

bool Gump::GetLocationOfItem	(	uint16	itemid,
		int &	gx,
		int &	gy,
		sint32	lerp_factor = `256`
	)			`[virtual]`

Get the location of an item in the gump (coords relative to this).

Returns:: false on failure

Reimplemented in ContainerGump, GameMapGump, and PaperdollGump.

Definition at line 567 of file Gump.cpp.

Referenced by ItemRelativeGump::GetItemLocation(), and ContainerGump::GetItemLocation().

bool Gump::GetMouseCursor	(	int	mx,
		int	my,
		Shape &	shape,
		sint32 &	frame
	)			`[virtual]`

Get the mouse cursor for position mx, my relative to parents position. If this gump doesn't want to set the cursor, the gump list will attempt to get the cursor shape from the next lower gump.