Ultima::Ultima8::BookGump Class Reference

#include <book_gump.h>

Inheritance diagram for Ultima::Ultima8::BookGump:

Public Member Functions
	BookGump (ObjId owner, const Std::string &msg)
void	onMouseClick (int button, int32 mx, int32 my) override
void	onMouseDouble (int button, int32 mx, int32 my) override
bool	OnKeyDown (int key, int mod) override
void	InitGump (Gump *newparent, bool take_focus=true) override
	INTRINSIC (I_readBook)
bool	loadData (Common::ReadStream *rs, uint32 version)
void	saveData (Common::WriteStream *ws) override
Public Member Functions inherited from Ultima::Ultima8::ModalGump
	ModalGump (int x, int y, int width, int height, uint16 owner=0, uint32 flags=FLAG_DONT_SAVE|FLAG_PREVENT_SAVE, int32 layer=LAYER_MODAL, bool pauseGame=true)
void	InitGump (Gump *newparent, bool take_focus=true) override
void	Close (bool no_del=false) override
bool	PointOnGump (int mx, int my) override
	Detect if a point is on the gump.
Gump *	FindGump (int mx, int my) override
uint16	TraceObjId (int32 mx, int32 my) override
	Trace a click, and return ObjId.
Gump *	onMouseDown (int button, int32 mx, int32 my) override
bool	loadData (Common::ReadStream *rs, uint32 version)
void	saveData (Common::WriteStream *ws) override
Public Member Functions inherited from Ultima::Ultima8::Gump
	Gump (int x, int y, int width, int height, uint16 owner=0, uint32 flags=0, int32 layer=LAYER_NORMAL)
virtual void	CreateNotifier ()
void	SetNotifyProcess (GumpNotifyProcess *proc)
GumpNotifyProcess *	GetNotifyProcess ()
uint32	GetResult ()
void	SetResult (uint32 res)
void	SetShape (const Shape *shape, uint32 frameNum)
	Set the Gump's shape/frame.
void	SetShape (FrameID frame, bool adjustsize=false)
void	UpdateDimsFromShape ()
	Update the width/height to match the gump's current shape frame.
void	Set_frameNum (uint32 frameNum)
	Set the Gump's frame.
virtual Gump *	FindGump (FindGumpPredicate predicate, bool recursive=true)
template<class T >
Gump *	FindGump (bool recursive=true)
virtual bool	GetMouseCursor (int32 mx, int32 my, Shape &shape, int32 &frame)
virtual void	RenderSurfaceChanged ()
virtual void	run ()
	Run the gump.
virtual void	CloseItemDependents ()
virtual void	Paint (RenderSurface *surf, int32 lerp_factor, bool scaled)
virtual void	PaintCompositing (RenderSurface *surf, int32 lerp_factor, int32 scalex, int32 scaley)
bool	IsClosing () const
	Check to see if a Gump is Closing.
virtual void	Move (int32 x, int32 y)
	Move this gump.
virtual void	MoveRelative (int x, int y)
	Move this gump relative to its current position.
void	getLocation (int32 &x, int32 &y) const
virtual void	setRelativePosition (Position pos, int xoffset=0, int yoffset=0)
	Moves this gump to a relative location on the parent gump.
virtual void	GetDims (Rect &d) const
	Get the _dims.
virtual void	SetDims (const Rect &d)
	Set the _dims.
virtual void	ScreenSpaceToGump (int32 &sx, int32 &sy, PointRoundDir r=ROUND_TOPLEFT)
	Convert a screen space point to a gump point.
virtual void	GumpToScreenSpace (int32 &gx, int32 &gy, PointRoundDir r=ROUND_TOPLEFT)
	Convert a gump point to a screen space point.
virtual void	ParentToGump (int32 &px, int32 &py, PointRoundDir r=ROUND_TOPLEFT)
	Convert a parent relative point to a gump point.
virtual void	GumpToParent (int32 &gx, int32 &gy, PointRoundDir r=ROUND_TOPLEFT)
	Convert a gump point to parent relative point.
virtual void	GumpRectToScreenSpace (Rect &gr, RectRoundDir r=ROUND_OUTSIDE)
	Transform a rectangle to screenspace from gumpspace.
virtual void	ScreenSpaceToGumpRect (Rect &sr, RectRoundDir r=ROUND_OUTSIDE)
	Transform a rectangle to gumpspace from screenspace.
virtual bool	GetLocationOfItem (uint16 itemid, int32 &gx, int32 &gy, int32 lerp_factor=256)
virtual void	onMouseUp (int button, int32 mx, int32 my)
virtual Gump *	onMouseMotion (int32 mx, int32 my)
virtual void	onMouseOver ()
virtual void	onMouseLeft ()
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)
	Add a gump to the child list.
virtual void	RemoveChild (Gump *)
	Remove a gump from the child list.
virtual void	MoveChildToFront (Gump *)
	Move child to front (within its layer)
Gump *	GetParent ()
	Get the parent.
Gump *	GetRootGump ()
	Get the root gump (or self)
virtual void	ChildNotify (Gump *child, uint32 message)
void	SetIndex (int32 i)
int32	GetIndex () const
virtual bool	onDragStart (int32 mx, int32 my)
virtual void	onDragStop (int32 mx, int32 my)
virtual void	onDrag (int32 mx, int32 my)
virtual bool	StartDraggingItem (Item *item, int mx, int my)
virtual bool	DraggingItem (Item *item, int mx, int my)
virtual void	DraggingItemLeftGump (Item *item)
	Called when an item that was being dragged over the gump left the gump.
virtual void	StopDraggingItem (Item *item, bool moved)
virtual void	DropItem (Item *item, int mx, int my)
bool	hasFlags (uint flags) const
	Does this gump have any of the given flags mask set.
bool	IsHidden () const
bool	IsDraggable () const
virtual void	HideGump ()
virtual void	UnhideGump ()
void	SetVisibility (bool visible)
bool	mustSave (bool toplevel) const
bool	loadData (Common::ReadStream *rs, uint32 version)
Public Member Functions inherited from Ultima::Ultima8::Object
ObjId	getObjId () const
	get this Object's objID
virtual ObjId	assignObjId ()
virtual void	clearObjId ()
	Clear objID of self and contents (if any)
virtual Common::String	dumpInfo () const
	dump some info about this object to a string
ProcId	callUsecode (uint16 classid, uint16 offset, const uint8 *args=0, int argsize=0)
bool	loadData (Common::ReadStream *rs, uint32 version)

Protected Member Functions
void	NextText ()
Protected Member Functions inherited from Ultima::Ultima8::Gump
virtual void	PaintThis (RenderSurface *surf, int32 lerp_factor, bool scaled)
	Overloadable method to Paint just this Gump (RenderSurface is relative to this)
virtual void	PaintChildren (RenderSurface *surf, int32 lerp_factor, bool scaled)
	Paint the Gumps Children (RenderSurface is relative to this)
virtual void	PaintComposited (RenderSurface *surf, int32 lerp_factor, int32 scalex, int32 scaley)
	Overloadable method to Paint just this gumps unscaled components that require compositing (RenderSurface is relative to parent).

Additional Inherited Members
Public Types inherited from Ultima::Ultima8::Gump
enum	Position {   CENTER = 1, TOP_LEFT = 2, TOP_RIGHT = 3, BOTTOM_LEFT = 4,   BOTTOM_RIGHT = 5, TOP_CENTER = 6, BOTTOM_CENTER = 7, LEFT_CENTER = 8,   RIGHT_CENTER = 9 }
enum	PointRoundDir { ROUND_TOPLEFT = 0, ROUND_BOTTOMRIGHT = 1 }
enum	RectRoundDir { ROUND_INSIDE, ROUND_OUTSIDE }
enum	GumpFlags {   FLAG_DRAGGABLE = 0x0001, FLAG_HIDDEN = 0x0002, FLAG_CLOSING = 0x0004, FLAG_CLOSE_AND_DEL = 0x0008,   FLAG_ITEM_DEPENDENT = 0x0010, FLAG_DONT_SAVE = 0x0020, FLAG_CORE_GUMP = 0x0040, FLAG_KEEP_VISIBLE = 0x0080,   FLAG_PREVENT_SAVE = 0x0100 }
enum	GumpLayers {   LAYER_DESKTOP = -16, LAYER_GAMEMAP = -8, LAYER_NORMAL = 0, LAYER_ABOVE_NORMAL = 8,   LAYER_MODAL = 12, LAYER_CONSOLE = 16 }
enum	Message { GUMP_CLOSING = 0x100 }
Static Public Member Functions inherited from Ultima::Ultima8::Gump
template<int T>
static bool	FindByIndex (const Gump *g)
	A predicate to find a ui element by its index.
Static Protected Member Functions inherited from Ultima::Ultima8::Gump
static int32	ScaleCoord (int32 c, int32 factor)
static int32	UnscaleCoord (int32 c, int32 factor)
Protected Attributes inherited from Ultima::Ultima8::ModalGump
bool	_pauseGame
Protected Attributes inherited from Ultima::Ultima8::Gump
uint16	_owner
Gump *	_parent
int32	_x
int32	_y
Rect	_dims
uint32	_flags
int32	_layer
int32	_index
const Shape *	_shape
uint32	_frameNum
Std::list< Gump * >	_children
Gump *	_focusChild
uint16	_notifier
uint32	_processResult
Protected Attributes inherited from Ultima::Ultima8::Object
ObjId	_objId

Detailed Description

The gump to display the text of a book

Member Function Documentation

InitGump()

void Ultima::Ultima8::BookGump::InitGump ( Gump *  newparent, bool  take_focus = true  )

overridevirtual

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

Parameters

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

Reimplemented from Ultima::Ultima8::Gump.

---

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

• engines/ultima/ultima8/gumps/book_gump.h