pawsWidget Class Reference

The main base widget that all other widgets should inherit from. More...

#include <pawswidget.h>

Classes
class	iWidgetData
	A class that can be inherited to store extra data in a widget. More...

Public Member Functions
void	AddChild (pawsWidget *widget)
	Add a child widget to this widget. More...
void	AddChild (size_t Index, pawsWidget *widget)
	Add a child widget to this widget at a specified position. More...
virtual void	BringToTop (pawsWidget *widget)
	Move this widget up the z order to the top. More...
virtual double	CalcFunction (MathEnvironment *env, const char *functionName, const double *params)
virtual void	CenterTo (int x, int y)
	Move this widget so that its center is at given location. More...
virtual void	CenterToMouse ()
	Move this widget so that its center is at mouse pointer, but it is fully on screen. More...
void	ChangeFontSize (float newSize)
	Change font to new size and reload font to make it take effect. More...
virtual bool	CheckButtonPressed (int button, int modifiers, pawsWidget *pressedWidget)
	Test button for activity. More...
virtual bool	CheckButtonReleased (int button, int modifiers, pawsWidget *pressedWidget)
	Test button for activity. More...
virtual bool	CheckKeyHandled (int)
	Allow pawsButton to simulate button pushes based on keypresses. More...
void	ClearBackgroundColor ()
void	ClearMaskingImage ()
	Clears the masking image. More...
csRect	ClipRect ()
	This returns the current clipping rectangle. More...
void	ClipToParent (bool allowForBackgroundBorder)
	Determines clipping area to use. More...
virtual void	Close ()
	Simply calls Hide() unless overidden. More...
virtual bool	Contains (int x, int y)
	Determines if the coordinates are within this widget. More...
virtual void	CreateWidgetConfigWindow ()
	Creates a popup window that the user can use to adjust the settings of this window. More...
virtual void	DeleteChild (pawsWidget *widget)
	Removes the widget from list of children and destructs it. More...
void	DeleteYourself ()
	Removes and destructs itself. More...
virtual void	DestroyWidgetConfigWindow ()
	Called by ApplyAlphaOnChildren to remove the config window to prevent weird stuff. More...
virtual void	Draw ()
	Draws the widget and all of it's children. More...
virtual void	Draw3D (iGraphics3D *)
virtual void	DrawBackground ()
	Draws the background with a color or an image. More...
virtual void	DrawChildren ()
	Draws all children marked visible. More...
void	DrawForeground ()
	Does the second part of the drawing drawing the background of the window. More...
virtual void	DrawMask ()
	Draws the mask picture. More...
virtual void	DrawToolTip (int x, int y)
	This draws the tool tip if a widget is visible and a tool tip is available. More...
void	DrawWidgetText (const char *text, int x, int y, int style=-1)
	Draw text in the widget at specified location. More...
bool	DrawWindow ()
	Does the first part of the drawing. More...
virtual void	Dump (csString tab="")
	Prints the widget names for the widget and all it's children. More...
const char *	FindDefaultWidgetStyle (const char *factoryName)
pawsWidget *	FindWidget (const char *name, bool complain=true)
	Find a child widget of this widget. More...
pawsWidget *	FindWidget (int id, bool complain=true)
	Find a child widget of this widget. More...
pawsWidget *	FindWidgetXMLBinding (const char *xmlbinding)
	Find a child widget of this widget with the given XML binding. More...
void	FormatToolTip (const char *fmt,...)
	Changes the format of a tool tip. More...
int	GetActualHeight (int myValue=-1)
	Returns the actual Height assuming the passed value was in 800x600 resolution. More...
int	GetActualWidth (int myValue=-1)
	Returns the actual width assuming the passed value was in 800x600 resolution. More...
csString	GetBackground ()
	Retrieve the background image name. More...
virtual pawsBorder *	GetBorder ()
	This returns the border created by UseBorder(). More...
virtual int	GetBorderColour (int which)
	Get the color for this widgets border. More...
virtual int	GetBorderStyle ()
	This returns the BORDER_BUMP style. More...
pawsWidget *	GetChild (size_t i)
	Used if you need to loop through the children of a widget. More...
size_t	GetChildrenCount ()
	Used if you need to loop through the children of a widget. More...
const char *	GetCloseName ()
	Returns the closeName of this widget. More...
virtual csRect	GetDefaultFrame ()
	Returns the default csRect. More...
iWidgetData *	GetExtraData ()
	Grabs extra data stored in the widget. More...
float	GetFadeSpeed ()
	Gets the fading speed. More...
int	GetFadeVal ()
	Gets the fade value of this widget. More...
const char *	GetFilename ()
	Returns the filename. More...
virtual bool	GetFocusOverridesControls () const
	Test if the widget should intercept all key presses. More...
iFont *	GetFont (bool scaled=true)
	Gets the current font as an iFont. More...
virtual int	GetFontColour ()
	Gets the current font color. More...
int	GetFontShadowColour ()
	Gets the current shadow color. More...
float	GetFontSize ()
	Gets the current font size. More...
int	GetFontStyle ()
	Gets the current font style. More...
int	GetID ()
	Gets the id of a widget. More...
int	GetLogicalHeight (int myValue)
int	GetLogicalWidth (int myValue)
int	GetMaxAlpha ()
	Gets the maximum alpha value of this widget. More...
int	GetMinAlpha ()
	Gets the minimim alpha value of this widget. More...
void	GetMinSize (int &width, int &height)
const char *	GetName ()
	Get the name of this widget. More...
pawsWidget *	GetParent ()
	Get this widget's parent. More...
csString	GetPathInWidgetTree ()
	Returns textual description of path to our widget through the widget tree. More...
virtual double	GetProperty (MathEnvironment *env, const char *ptr)
virtual csRect	GetScreenFrame ()
	Returns the csRect that defines widget area. More...
csString &	GetToolTip ()
	Gets the text from a tool tip. More...
const char *	GetType ()
	Gets the current factory type. More...
csRect	GetWidgetTextRect (const char *text, int x, int y, int style=-1)
	Get the rectangle containing the text DrawWidgetText will produce. More...
virtual const csString &	GetXMLBinding ()
	Get the xml nodes of this widget. More...
virtual bool	HasFocus ()
	Test focus of the widget. More...
virtual void	Hide ()
	Makes widget invisible and removes focus if widget has current focus. More...
virtual void	Ignore (bool ig)
bool	Includes (pawsWidget *widget)
	Returns true if widget equals this, or widget is a child of this. More...
bool	IsAlwaysOnTop ()
	Tests value of this widgets alwaysOnTop flag. More...
bool	IsChildOf (pawsWidget *someParent)
	Returns true, if this widget is the child of 'someParent'. More...
bool	IsConfigurable ()
	Tests if widget settings (alpha, fade, etc) are configurable. More...
bool	isFadeEnabled ()
	Gets the fade status of this widget. More...
bool	IsIndirectChild (pawsWidget *widget)
	Returns true, if 'widget' is child of our widget, even if it is indirect. More...
bool	IsResizable ()
	Test widget to see if it is resizable. More...
bool	isScalingFont ()
	Returns whether or not font is being auto-scaled. More...
bool	IsVisible ()
	Is the widget currently set visible? More...
virtual bool	Load (iDocumentNode *node)
	Load a widget based on its <widget></widget> tag. More...
virtual bool	LoadAttributes (iDocumentNode *node)
	Load standard widget attributes based on its <widget></widget> tag. More...
virtual bool	LoadChildren (iDocumentNode *node)
	Load widget children based on subtags of its <widget></widget> tag. More...
virtual bool	LoadEventScripts (iDocumentNode *node)
	Load event scripts for this widget. More...
bool	LoadFromFile (const csString &fileName)
	Parses XML file 'fileName', finds first widget tag and Load()s itself from this tag. More...
virtual csRect	LoadPositions ()
	Get the position of this widget that was stored in a cfg file. More...
virtual void	LoadSettings ()
	Loads current widget settings from an XML file. More...
void	MakeFullyVisible ()
	If some part of the widget is not within the rectangle of its parent, then the widget is moved inside (if it is small enough). More...
virtual void	MouseOver (bool value)
	Sets hasMouseFocus. More...
virtual void	MoveDelta (int dx, int dy)
	Move a widget by a delta amount. More...
virtual void	MoveTo (int x, int y)
	Moves this widget and all of its children to a new screen location. More...
bool	NeedsRender () const
	Whether we need to r2t. More...
virtual void	NewSubscription (const char *dataname)
virtual bool	OnButtonPressed (int button, int keyModifier, pawsWidget *widget)
	Called whenever a button is pressed. More...
virtual bool	OnButtonReleased (int button, int keyModifier, pawsWidget *widget)
	Called whenever a button is released. More...
virtual bool	OnChange (pawsWidget *widget)
	Called whenever a widget is selected. More...
virtual bool	OnChildMouseEnter (pawsWidget *child)
	Called when mouse enters a child widget. More...
virtual bool	OnChildMouseExit (pawsWidget *child)
	Called when a mouse exits a child widget. More...
virtual bool	OnClipboard (const csString &content)
	Process Clipboard content, as a response to RequestClipboardContent. More...
virtual bool	OnDoubleClick (int button, int modifiers, int x, int y)
	Manage mouse double click event. More...
virtual bool	OnGainFocus (bool=true)
	Changes hasFocus to TRUE and reports status to parent. More...
virtual bool	OnJoypadDown (int key, int modifiers)
	Process joypadDown messages. More...
virtual bool	OnKeyDown (utf32_char keyCode, utf32_char keyChar, int modifiers)
	Process keydown messages. More...
virtual void	OnListAction (pawsListBox *selected, int status)
	Called whenever an item in a child list box is selected. More...
virtual void	OnLostFocus ()
	Sets hasFocus false and notifys parent. More...
virtual bool	OnMenuAction (pawsWidget *widget, const pawsMenuAction &action)
	Called whenever a menu action occurs. More...
virtual bool	OnMouseDown (int button, int modifiers, int x, int y)
	Manage mouse down event to test for and apply window changes. More...
virtual bool	OnMouseEnter ()
	Called whenever the mouse enters this widget. More...
virtual bool	OnMouseExit ()
	Called whenever the mouse leaves this widget. More...
virtual bool	OnMouseUp (int button, int modifiers, int x, int y)
	Manage mouse up event. More...
virtual void	OnResize ()
	Sets the new position of the close button. More...
virtual bool	OnScroll (int scrollDirection, pawsScrollBar *widget)
	Called whenever a window is scrolled. More...
virtual bool	OnSelected (pawsWidget *widget)
	Called whenever a widget is selected. More...
virtual void	OnUpdateData (const char *, PAWSData &)
virtual bool	ParentDraw () const
	Whether to draw via the parent-child draw tree. More...
	pawsWidget ()
	pawsWidget (const pawsWidget &origin)
virtual void	PerformAction (const char *action)
	Does an action based on this string. More...
virtual bool	PostSetup ()
	This is called after the widget and all of it's children have been created. More...
void	RecalcScreenPositions ()
	This re-calculates a widget's on screen position to draw based on it's relative position and parent screen location. More...
void	ReloadWidget ()
	Reloads widget from XML file. More...
void	RemoveChild (pawsWidget *widget)
	Removes the widget from list of children but does NOT destruct it. More...
void	RemoveTitle ()
virtual void	ResetToDefaultFrame ()
	Resets the position, width and height to the default position. More...
virtual void	Resize (int flags)
	Resize a widget based on the current mouse position. More...
virtual void	Resize (int dx, int dy, int flags)
	Resize a widget by a delta amount. More...
virtual void	Resize ()
	Resize a widget based on it's parent's size. More...
void	RunScriptEvent (PAWS_WIDGET_SCRIPT_EVENTS event)
	Executes any pawsScript associated with the given event. More...
virtual void	SavePosition ()
	Saves the position of this widget to the config file. More...
virtual void	SaveSettings ()
	Saves current widget settings to an XML file. More...
virtual bool	SelfPopulate (iDocumentNode *node)
	This function allows a widget to fill in its own contents from an xml node supplied and calls the same function for all children. More...
virtual bool	SelfPopulateXML (const char *xmlstr)
	This function parses the xml string and calls SelfPopulate with the resulting DOM structure if valid. More...
virtual void	SendToBottom (pawsWidget *widget)
	Move this widget down the z order to the bottom. More...
void	SetAlwaysOnTop (bool value)
	Sets value of this widgets alwaysOnTop flag. More...
virtual void	SetAttachFlags (int flags)
	Modify attachFlags to control widget construction. More...
virtual void	SetBackground (const char *imageName)
	Sets the background image, logs error if NULL. More...
virtual void	SetBackgroundAlpha (int alphaValue)
	Sets the alpha level of the background. More...
void	SetBackgroundColor (int r, int g, int b)
	Sets the background color. More...
void	SetColour (int newColour=-2)
	Set text color. More...
void	SetContextMenu (const csString &fileName)
	Sets name of the PAWS xml-file that describes context menu of our widget. More...
void	SetDefaultToolTip ()
	Sets the tool tip to the one defined in the XML. More...
void	SetExtraData (iWidgetData *data)
	Stores extra data into this widget. More...
void	SetFactory (const char *myfactory)
	Sets the type of factory. More...
void	SetFade (bool value)
	Used to control the fading feature of the widget. More...
void	SetFadeSpeed (float speed)
	Sets the fading speed. More...
void	SetFilename (const char *name)
	Changes filename to the name provided. More...
void	SetFont (const char *fontName, int Size=0)
	Set font to use programmatically. More...
void	SetFontScaling (bool value)
	Used to control the font scaling of the widget. More...
void	SetFontStyle (int style)
	Sets the current font style. More...
virtual void	SetForceSize (int newWidth, int newHeight)
	Same as above, but does not resize children. More...
void	SetID (int newID)
	Change the id of a widget. More...
void	SetMaskingImage (const char *image)
	Sets a masking image which will be drawn after the normal stuff. More...
void	SetMaxAlpha (int value)
	Sets the maximum alpha of this widget. More...
void	SetMaxSize (int width, int height)
	Set the max size for height and width. More...
void	SetMinAlpha (int value)
	Sets the minimim alpha of this widget. More...
void	SetMinSize (int width, int height)
	Set the minimum height and width to protect the widget from negatives. More...
void	SetModalState (bool isModal)
	Registers mode with the windowManager. More...
void	SetMovable (bool value)
	Makes a widget movable. More...
void	SetName (const char *newName)
	Set the name of this widget. More...
void	SetNeedsRender (bool needs)
	Marks that we need to r2t. More...
void	SetParent (pawsWidget *widget)
	Set the owner of this widget. More...
virtual void	SetProperty (const char *ptr, double value)
virtual void	SetRelativeFrame (int x, int y, int width, int height)
	Set the size of this widget and it's position relative to the parent. More...
virtual void	SetRelativeFramePos (int x, int y)
	Set the position of this widget relative to the parent. More...
virtual void	SetRelativeFrameSize (int width, int height)
	Sets defaultFrame and screenFrame size attributes. More...
void	SetResizeShow (bool v)
	Sets the showResize flag, controlling if the resize widget should be drawn. More...
virtual void	SetSize (int newWidth, int newHeight)
	Set the size of a particlar widget. More...
void	SetTitle (const char *title)
	Sets the border title of this widget. More...
bool	SetTitle (const char *text, const char *image, const char *align, const char *close_button, const bool shadowTitle=true)
	Sets up the title bar for the widget. More...
void	SetToolTip (const char *text)
	Changes the text for a tool tip. More...
virtual bool	Setup (iDocumentNode *)
	Setup this widget. More...
void	SetVisibility (bool visible)
	Make the widget visible or hides it. More...
virtual void	SetXMLBinding (csString &xmlbinding)
	Sets the xml nodes of this widget. More...
virtual void	Show ()
	Makes widget visible and brings it to the front. More...
virtual void	ShowBehind ()
	Makes widget visible and brings it to the front but behind widget with current focus. More...
virtual void	StopResize ()
	Called once the mouse up is done after resizing a widget. More...
const char *	ToString ()
virtual void	UseBorder (const char *style=0)
	Creates a new border and links it to the widget. More...
virtual pawsWidget *	WidgetAt (int x, int y)
	Locate a widget that is at these screen coordindates. More...
virtual	~pawsWidget ()
Public Member Functions inherited from iPAWSSubscriber
virtual	~iPAWSSubscriber ()
Public Member Functions inherited from iScriptableVar
virtual	~iScriptableVar ()

Public Attributes
csArray< csString >	publishList

Protected Member Functions
int	CalcChildPosition (pawsWidget *child)
	Calculates the right position in array of children for a given child (depends on always-on-top state). More...
bool	CreateContextMenu ()
	Creates context menu from file ('contextMenuFile' attribute) More...
int	GetAttachFlag (const char *flag)
	Convert from string flag to int flag. More...
void	LoadBorderColours (iDocumentNode *node)
	Loads custom border color preferences. More...
bool	ReadDefaultWidgetStyles (iDocumentNode *node)
int	ResizeFlags (int mouseX, int mouseY)
	This will check to see if the mouse is over the resize hot spot. More...
void	SetCloseButtonPos ()
	Gets button from widget and sets it's location. More...

Protected Attributes
int	alpha
	The original background alpha. More...
int	alphaMin
	The minimum background alpha. More...
bool	alwaysOnTop
	Is this windows painted on top of other windows. More...
int	attachFlags
	The attachpoints for when a resize takes place. More...
int	bgColour
	Stores the bgColour for this widget. More...
csRef< iPawsImage >	bgImage
	Background image. More...
pawsBorder *	border
	border created by GetBorder(). More...
int	borderColours [5]
	Custom border colors for this window. More...
bool	borderTitleShadow
	whether the title in the border should be shadow font More...
csArray< pawsWidget * >	children
	The child widgets. More...
csRect	clipRect
	Current clipping rectangle. More...
pawsButton *	close_widget
	Used in SetTitle() for the new close button. More...
csString	closeName
	Old name of the widget with "_close" appended by SetName(). More...
bool	configurable
	Determines if the settings (alpha, fade, etc) of this widget are configurable. More...
pawsMenu *	contextMenu
	Existing context menu of the widget. More...
csString	contextMenuFile
	Path to the file that describes context menu of our widget (invoked by mouse right-click). More...
int	defaultFontColour
	Optional color to use when drawing text with this widget. More...
int	defaultFontShadowColour
	Optional color to use when doing text dropshadows. More...
float	defaultFontSize
	Default font size. More...
csRect	defaultFrame
	The default frame for the widget. More...
csString	defaultToolTip
	Default tool tip string for the widget. More...
csHash< csString, csString >	defaultWidgetStyles
iWidgetData *	extraData
	Holds any extra data the widget may need. More...
csString	factory
	factory name More...
bool	fade
	Set to false to disable fading. More...
float	fadeSpeed
	The speed of the fading process. More...
float	fadeVal
	The direction and percentage of current fade in progress. More...
csString	filename
	filename to load from or save to. More...
csString	fontName
	Name of currently selected font. More...
float	fontSize
	Current font size. More...
int	fontStyle
	Current font style. More...
csRef< iGraphics2D >	graphics2D
	The 2D graphics interface. More...
bool	hasBorderColours
	Flag to indicate using custom border colors. More...
bool	hasFocus
	Flag for widget focus. More...
bool	hasMouseFocus
	Flag for mouse over behavior. More...
int	id
	The id of the widget. More...
bool	ignore
	Flag determines if WidgetAT() ignores this widget. More...
bool	isResizable
	Determines if this widget can be resized by user. More...
bool	keepaspect
	Enforce keeping the default aspect ratio when resizing. More...
int	margin
	Stores margin value. Used in LoadAttributes(). More...
csRef< iPawsImage >	maskImage
	Masking image, used for nice-looking stuff. More...
int	max_height
	Defines the maximum height that the widget can be. More...
int	max_width
	Defines the maximum width that the widget can be. More...
int	min_height
	Defines the minimum height that the widget can be. More...
int	min_width
	Defines the minimum width that the widget can be. More...
bool	movable
	Determines if this widget is movable. More...
csRef< iFont >	myFont
	Optional font to use when drawing this widget. More...
csString	name
	The name of this widget. More...
bool	needsRender
	Whether we need to do a r2t update. More...
pawsWidget *	onEnter
	Widget to call if enter is pressed. More...
bool	overwrite_subscription
	Flag of whether OnUpdateData should overwrite the previous value or add to it. More...
pawsWidget *	parent
	This widget's parent. More...
bool	parentDraw
	Whether to draw this widget (different from visible, used to decide if Draw() is called via parent-child tree). More...
bool	resizeToScreen
	Determines if this widget should be auto resized with screen resolution. More...
bool	saveWidgetPositions
	Determines if this widget should write/load it's position from a config file. More...
bool	scaleFont
	Determines whether or not to scale font when a widget it resized. More...
csRect	screenFrame
	The screen area of the widget. More...
pawsScript *	scriptEvents [PW_SCRIPT_EVENT_COUNT]
bool	showOnMouseOver
	Stores status of showOnMouseOver. More...
csString	showOnMouseOver_image
	Stores the bgimage name if showOnMouseOver is true. More...
bool	showResize
	If the resize widget should be drawn. More...
csString	subscribedVar
	The variable that this widget is subscribed to. More...
csString	subscription_format
csArray< pawsWidget * >	taborder
	Contains the children for tabbing. More...
pawsTitle *	titleBar
	reference to titleBar object, if any More...
csString	toolTip
	Tooltip to be displayed. More...
bool	visible
	Flag to determine visiblity. More...
csString	xmlbinding
	Used in the SelfPopulate functions to map to xml nodes for each widget. More...

Detailed Description

The main base widget that all other widgets should inherit from.

Definition at line 116 of file pawswidget.h.

Constructor & Destructor Documentation

pawsWidget::pawsWidget

(

)

pawsWidget::pawsWidget

(

const pawsWidget &

origin

)

virtual pawsWidget::~pawsWidget ( )

virtual

Member Function Documentation

void pawsWidget::AddChild

(

pawsWidget *

widget

)

Add a child widget to this widget.

This widget is then responsible for deleting this child.

Parameters

widget

The child to add.

void pawsWidget::AddChild	(	size_t	Index,
		pawsWidget *	widget
	)

Add a child widget to this widget at a specified position.

This widget is then responsible for deleting this child.

Parameters

widget

The child to add.

virtual void pawsWidget::BringToTop ( pawsWidget *  widget )

virtual

Move this widget up the z order to the top.

If the widget is alwaysOnTop, it will be placed in position 0. If the widget is not alwaysOnTop, it will be placed after the last alwaysOnTop widget. Will also recurse up through the parents to bring it up as well.

Parameters

widget

Widget to bring forward.

Reimplemented in pawsNpcDialogWindow.

int pawsWidget::CalcChildPosition ( pawsWidget *  child )

protected

Calculates the right position in array of children for a given child (depends on always-on-top state).

virtual double pawsWidget::CalcFunction ( MathEnvironment *  env, const char *  functionName, const double *  params  )

virtual

Implements iScriptableVar.

Reimplemented in pawsSketchWindow, and pawsMusicWindow.

virtual void pawsWidget::CenterTo ( int  x, int  y  )

virtual

Move this widget so that its center is at given location.

Parameters

x	Screen coordinate X.
y	Screen coordinage Y.

virtual void pawsWidget::CenterToMouse ( )

virtual

Move this widget so that its center is at mouse pointer, but it is fully on screen.

void pawsWidget::ChangeFontSize

(

float

newSize

)

Change font to new size and reload font to make it take effect.

Parameters

newSize

The font size to change to.

virtual bool pawsWidget::CheckButtonPressed ( int  button, int  modifiers, pawsWidget *  pressedWidget  )

virtual

Test button for activity.

Parameters

button	The button to test.
modifiers	Modifier to use.
pressedWidget	The widget with the event.

Returns

TRUE if pressed, FALSE otherwise

virtual bool pawsWidget::CheckButtonReleased ( int  button, int  modifiers, pawsWidget *  pressedWidget  )

virtual

Test button for activity.

Parameters

button	The button to test.
modifiers	Modifier to use.
pressedWidget	The widget with the event.

Returns

TRUE if pressed, FALSE otherwise

virtual bool pawsWidget::CheckKeyHandled ( int  )

inlinevirtual

Allow pawsButton to simulate button pushes based on keypresses.

Return true if key is handled.

Reimplemented in pawsDnDButton, and pawsButton.

Definition at line 499 of file pawswidget.h.

void pawsWidget::ClearBackgroundColor ( )

inline

Definition at line 1785 of file pawswidget.h.

void pawsWidget::ClearMaskingImage

(

)

Clears the masking image.

csRect pawsWidget::ClipRect ( )

inline

This returns the current clipping rectangle.

Returns

csRect clipRect

Definition at line 1560 of file pawswidget.h.

void pawsWidget::ClipToParent

(

bool

allowForBackgroundBorder

)

Determines clipping area to use.

If a widget is the top level it clips to the canvas. If it has a parent it calculates the intersection between either it's border or screenframe and parent clip. Updates clipRect for future drawing.

virtual void pawsWidget::Close ( )

inlinevirtual

Simply calls Hide() unless overidden.

Reimplemented in pawsSkillWindow, pawsTutorialWindow, pawsComboPromptWindow, pawsPetitionWindow, pawsInventoryWindow, pawsExchangeWindow, pawsNumberPromptWindow, WidgetConfigWindow, pawsActiveMagicWindow, pawsPetStatWindow, pawsGMSpawnWindow, pawsMerchantWindow, and pawsStorageWindow.

Definition at line 470 of file pawswidget.h.

virtual bool pawsWidget::Contains ( int  x, int  y  )

virtual

Determines if the coordinates are within this widget.

Typically the border or screenFrame.

Parameters

x	The x screen position.
y	The y screen position.

Returns

TRUE if yes otherwise FALSE

Reimplemented in pawsControlWindow.

bool pawsWidget::CreateContextMenu ( )

protected

Creates context menu from file ('contextMenuFile' attribute)

virtual void pawsWidget::CreateWidgetConfigWindow ( )

virtual

Creates a popup window that the user can use to adjust the settings of this window.

virtual void pawsWidget::DeleteChild ( pawsWidget *  widget )

virtual

Removes the widget from list of children and destructs it.

Parameters

widget

The child to delete.

Reimplemented in psMainWidget.

void pawsWidget::DeleteYourself ( )

inline

Removes and destructs itself.

Definition at line 531 of file pawswidget.h.

virtual void pawsWidget::DestroyWidgetConfigWindow ( )

virtual

Called by ApplyAlphaOnChildren to remove the config window to prevent weird stuff.

virtual void pawsWidget::Draw ( )

virtual

Draws the widget and all of it's children.

Remarks

Uses clipping rect of it's parent to define drawing area. If the drawing area defined is empty it returns.

Reimplemented in pawsMultiPageDocumentView, pawsDocumentView, pawsFadingTextBox, pawsMultilineEditTextBox, pawsSheetLine, pawsMultiPageTextBox, pawsMultiLineTextBox, pawsSeqTreeNode, pawsMenuSeparator, pawsEditTextBox, pawsMenuItem, pawsMessageTextBox, pawsTree, pawsSketchWindow, pawsSkillIndicator, pawsMenu, pawsScrollBar, psMainWidget, pawsNpcDialogWindow, pawsProgressBar, pawsTextBox, pawsObjectView, pawsSkillWindow, pawsConfigKeys, pawsTitle, pawsGenericView, pawsGameTile, pawsMoney, pawsButton, pawsDnDButton, pawsLoadWindow, pawsCraftWindow, pawsCharBirth, pawsCharacterPickerWindow, pawsInfoWindow, pawsLoginWindow, pawsPetStatWindow, pawsChildhoodWindow, pawsInteractWindow, pawsCharParents, pawsKeySelectBox, pawsSummaryWindow, pawsCraftCancelWindow, pawsLifeEventWindow, pawsSpellCancelWindow, pawsCreditsWindow, pawsSplashWindow, and pawsSlot.

virtual void pawsWidget::Draw3D ( iGraphics3D *  )

inlinevirtual

Reimplemented in pawsObjectView.

Definition at line 758 of file pawswidget.h.

virtual void pawsWidget::DrawBackground ( )

virtual

Draws the background with a color or an image.

Remarks

Uses focus status to apply appropriate fading.

Reimplemented in pawsNpcDialogWindow.

virtual void pawsWidget::DrawChildren ( )

virtual

Draws all children marked visible.

Reimplemented in psMainWidget.

void pawsWidget::DrawForeground

(

)

Does the second part of the drawing drawing the background of the window.

virtual void pawsWidget::DrawMask ( )

virtual

Draws the mask picture.

Remarks

Uses focus status to apply appropriate fading.

Reimplemented in pawsDnDButton.

virtual void pawsWidget::DrawToolTip ( int  x, int  y  )

virtual

This draws the tool tip if a widget is visible and a tool tip is available.

Parameters

x	The x screen position.
y	The y screen position.

void pawsWidget::DrawWidgetText	(	const char *	text,
		int	x,
		int	y,
		int	style = -1
	)

Draw text in the widget at specified location.

Parameters

text	The text to draw.
x	The x screen position.
y	The x screen position.
style	When set at -1 causes widget to call GetFontStyle().

Remarks

Font style selected by precedence, this, parent and DFFAULT_FONT_STYLE

bool pawsWidget::DrawWindow

(

)

Does the first part of the drawing.

It draws the background of the window.

Returns

TRUE if the widget can be drawn.

virtual void pawsWidget::Dump ( csString  tab = "" )

virtual

Prints the widget names for the widget and all it's children.

Parameters

tab	String to set tab format.

const char* pawsWidget::FindDefaultWidgetStyle

(

const char *

factoryName

)

pawsWidget* pawsWidget::FindWidget	(	const char *	name,
		bool	complain = true
	)

Find a child widget of this widget.

Recurses down through the children as well looking for widget.

Parameters

name	The name of the widget to look for.
complain	If true, print an error message if widget is not found.

Returns

A pointer to the widget if found. NULL otherwise.

pawsWidget* pawsWidget::FindWidget	(	int	id,
		bool	complain = true
	)

Find a child widget of this widget.

Recurses down through the children as well looking for widget.

Parameters

id	The id of the widget to look for.
complain	If true, print an error message if widget is not found.

Returns

A pointer to the widget if found. NULL otherwise.

pawsWidget* pawsWidget::FindWidgetXMLBinding

(

const char *

xmlbinding

)

Find a child widget of this widget with the given XML binding.

Recurses down through the children as well looking for widget.

Parameters

xmlbinding

The xmlbinding of the widget to look for.

Returns

A pointer to the widget if found. NULL otherwise.

void pawsWidget::FormatToolTip	(	const char *	fmt,
			...
	)

Changes the format of a tool tip.

Parameters

fmt	The format string.
...	These define the new format.

int pawsWidget::GetActualHeight ( int  myValue = -1 )

inline

Returns the actual Height assuming the passed value was in 800x600 resolution.

Definition at line 1412 of file pawswidget.h.

int pawsWidget::GetActualWidth ( int  myValue = -1 )

inline

Returns the actual width assuming the passed value was in 800x600 resolution.

Definition at line 1390 of file pawswidget.h.

int pawsWidget::GetAttachFlag ( const char *  flag )

protected

Convert from string flag to int flag.

csString pawsWidget::GetBackground

(

)

Retrieve the background image name.

Returns

csString resourceName or "" if not found.

virtual pawsBorder* pawsWidget::GetBorder ( )

inlinevirtual

This returns the border created by UseBorder().

Definition at line 1137 of file pawswidget.h.

virtual int pawsWidget::GetBorderColour ( int  which )

virtual

Get the color for this widgets border.

Parameters

which

The index value in borderColor to get.

Returns

It's own border color if it has one, if it doesn't have it's own then the parent's, or if no parent it returns the default for the window manager.

virtual int pawsWidget::GetBorderStyle ( )

inlinevirtual

This returns the BORDER_BUMP style.

Remarks

Other styles available include: BORDER_RAISED, BORDER_SUNKEN and BORDER_ETCHED.

Reimplemented in pawsMultilineEditTextBox, pawsEditTextBox, pawsMessageTextBox, pawsTextBox, and pawsKeySelectBox.

Definition at line 1148 of file pawswidget.h.

pawsWidget* pawsWidget::GetChild ( size_t  i )

inline

Used if you need to loop through the children of a widget.

Parameters

i	ID of the child

Definition at line 549 of file pawswidget.h.

size_t pawsWidget::GetChildrenCount ( )

inline

Used if you need to loop through the children of a widget.

Returns

Count of the children

Definition at line 559 of file pawswidget.h.

const char* pawsWidget::GetCloseName ( )

inline

Returns the closeName of this widget.

Definition at line 1059 of file pawswidget.h.

virtual csRect pawsWidget::GetDefaultFrame ( )

inlinevirtual

Returns the default csRect.

Returns

defaultFrame

Definition at line 416 of file pawswidget.h.

iWidgetData* pawsWidget::GetExtraData ( )

inline

Grabs extra data stored in the widget.

Returns

The extra data stored in this widget.

Definition at line 1822 of file pawswidget.h.

float pawsWidget::GetFadeSpeed ( )

inline

Gets the fading speed.

Definition at line 1706 of file pawswidget.h.

int pawsWidget::GetFadeVal ( )

inline

Gets the fade value of this widget.

Definition at line 1674 of file pawswidget.h.

const char* pawsWidget::GetFilename

(

)

Returns the filename.

virtual bool pawsWidget::GetFocusOverridesControls ( ) const

inlinevirtual

Test if the widget should intercept all key presses.

Remarks

False by default, should be true for text entry widgets

Reimplemented in pawsMultilineEditTextBox, pawsEditTextBox, pawsSketchWindow, pawsFingeringWindow, and pawsKeySelectBox.

Definition at line 1015 of file pawswidget.h.

iFont* pawsWidget::GetFont

(

bool

scaled = true

)

Gets the current font as an iFont.

Returns

It's own font if it has one, if not then the parent's, or if it doesn't have a parent it returns windowManager DEFAULT_FONT.

virtual int pawsWidget::GetFontColour ( )

virtual

Gets the current font color.

Returns

defaultFontColour if it is != -1, if it has a parent use parent->GetFontColour(), if it doesn't have a parent it returns windowManager GetDefaultFontColour().

Reimplemented in pawsTextBox.

int pawsWidget::GetFontShadowColour

(

)

Gets the current shadow color.

Returns

default if myFont, if not then the parent's, or if it doesn't have a parent it returns black.

float pawsWidget::GetFontSize

(

)

Gets the current font size.

Returns

It's own size if it has one, if not then the parent's, or if it doesn't have a parent it returns DEFAULT_FONT_SIZE

int pawsWidget::GetFontStyle

(

)

Gets the current font style.

Returns

fontStyle if myFont, if not then the parent's, or if it doesn't have a parent it returns DEFAULT_FONT_STYLE.

int pawsWidget::GetID ( )

inline

Gets the id of a widget.

Returns

id The widget id.

Definition at line 1265 of file pawswidget.h.

int pawsWidget::GetLogicalHeight ( int  myValue )

inline

Definition at line 1441 of file pawswidget.h.

int pawsWidget::GetLogicalWidth ( int  myValue )

inline

Definition at line 1430 of file pawswidget.h.

int pawsWidget::GetMaxAlpha ( )

inline

Gets the maximum alpha value of this widget.

Definition at line 1666 of file pawswidget.h.

int pawsWidget::GetMinAlpha ( )

inline

Gets the minimim alpha value of this widget.

Definition at line 1658 of file pawswidget.h.

void pawsWidget::GetMinSize ( int &  width, int &  height  )

inline

Definition at line 1508 of file pawswidget.h.

const char* pawsWidget::GetName ( )

inline

Get the name of this widget.

Definition at line 1041 of file pawswidget.h.

pawsWidget* pawsWidget::GetParent ( )

inline

Get this widget's parent.

Returns

parent

Definition at line 650 of file pawswidget.h.

csString pawsWidget::GetPathInWidgetTree

(

)

Returns textual description of path to our widget through the widget tree.

(direct and indirect parents)

virtual double pawsWidget::GetProperty ( MathEnvironment *  env, const char *  ptr  )

virtual

Implements iScriptableVar.

Reimplemented in pawsCheckBox.

virtual csRect pawsWidget::GetScreenFrame ( )

virtual

Returns the csRect that defines widget area.

Returns

screenFrame

csString& pawsWidget::GetToolTip ( )

inline

Gets the text from a tool tip.

Returns

csString The tool tip text.

Definition at line 1318 of file pawswidget.h.

const char* pawsWidget::GetType ( )

inline

Gets the current factory type.

Returns

factory The current factory type.

Definition at line 1381 of file pawswidget.h.

csRect pawsWidget::GetWidgetTextRect	(	const char *	text,
		int	x,
		int	y,
		int	style = -1
	)

Get the rectangle containing the text DrawWidgetText will produce.

Parameters

text	The text.
x	The x screen position.
y	The x screen position.
style	When set at -1 causes widget to call GetFontStyle().

Remarks

Font style selected by precedence, this, parent and DFFAULT_FONT_STYLE

virtual const csString& pawsWidget::GetXMLBinding ( )

inlinevirtual

Get the xml nodes of this widget.

Returns

xmlbinding

Definition at line 630 of file pawswidget.h.

virtual bool pawsWidget::HasFocus ( )

inlinevirtual

Test focus of the widget.

Returns

hasFocus Current status of the widget.

Definition at line 1005 of file pawswidget.h.

virtual void pawsWidget::Hide ( )

virtual

Makes widget invisible and removes focus if widget has current focus.

Sets visible FALSE, hides border if present and then if focused when called it calls SetCurrentFocusedWidget(NULL).

Reimplemented in pawsSketchWindow, pawsControlledWindow, pawsFingeringWindow, pawsListBoxRow, pawsMusicWindow, pawsGameBoard, pawsGlyphWindow, pawsSkillWindow, pawsNpcDialogWindow, pawsControlWindow, pawsGuildWindow, pawsActiveMagicWindow, pawsLoadWindow, pawsYesNoBox, pawsConfigSound, pawsPetStatWindow, pawsLoginWindow, pawsInteractWindow, and pawsCreditsWindow.

virtual void pawsWidget::Ignore ( bool  ig )

inlinevirtual

Definition at line 392 of file pawswidget.h.

bool pawsWidget::Includes

(

pawsWidget *

widget

)

Returns true if widget equals this, or widget is a child of this.

If widget is null, false is returned.

bool pawsWidget::IsAlwaysOnTop ( )

inline

Tests value of this widgets alwaysOnTop flag.

Returns

bool alwaysOnTop.

Definition at line 1275 of file pawswidget.h.

bool pawsWidget::IsChildOf

(

pawsWidget *

someParent

)

Returns true, if this widget is the child of 'someParent'.

Parameters

someParent

The parent to check for.

bool pawsWidget::IsConfigurable ( )

inline

Tests if widget settings (alpha, fade, etc) are configurable.

Returns

bool

Definition at line 1832 of file pawswidget.h.

bool pawsWidget::isFadeEnabled ( )

inline

Gets the fade status of this widget.

Definition at line 1698 of file pawswidget.h.

bool pawsWidget::IsIndirectChild

(

pawsWidget *

widget

)

Returns true, if 'widget' is child of our widget, even if it is indirect.

Parameters

widget

The widget to test.

bool pawsWidget::IsResizable ( )

inline

Test widget to see if it is resizable.

Returns

isResizable Flag to set a widget resizable.

Remarks

This is set by marking the resizable attribute yes or no in the widget's xml data.

Definition at line 794 of file pawswidget.h.

bool pawsWidget::isScalingFont ( )

inline

Returns whether or not font is being auto-scaled.

Definition at line 1722 of file pawswidget.h.

bool pawsWidget::IsVisible ( )

inline

Is the widget currently set visible?

Returns

bool

Definition at line 426 of file pawswidget.h.

virtual bool pawsWidget::Load ( iDocumentNode *  node )

virtual

Load a widget based on its <widget></widget> tag.

Parameters

node	The xml data for the widget.

Remarks

Recursivly loads all child widgets.

Reimplemented in pawsSimpleTreeNode, pawsSeqTreeNode, pawsWidgetTreeNode, pawsMenuItem, and pawsTreeNode.

virtual bool pawsWidget::LoadAttributes ( iDocumentNode *  node )

virtual

Load standard widget attributes based on its <widget></widget> tag.

Parameters

node	The xml data for the widget.

void pawsWidget::LoadBorderColours ( iDocumentNode *  node )

protected

Loads custom border color preferences.

virtual bool pawsWidget::LoadChildren ( iDocumentNode *  node )

virtual

Load widget children based on subtags of its <widget></widget> tag.

Parameters

node	The xml data for the widget.

Reimplemented in pawsTree.

virtual bool pawsWidget::LoadEventScripts ( iDocumentNode *  node )

virtual

Load event scripts for this widget.

Parameters

node	The xml node for the widget.

bool pawsWidget::LoadFromFile

(

const csString &

fileName

)

Parses XML file 'fileName', finds first widget tag and Load()s itself from this tag.

'fileName' is standard path of the XML file to load.

See also

psLocalization::FindLocalizedFile()

virtual csRect pawsWidget::LoadPositions ( )

virtual

Get the position of this widget that was stored in a cfg file.

Returns

A csrect that is the new position. Or return the position that is in the XML file.

virtual void pawsWidget::LoadSettings ( )

virtual

Loads current widget settings from an XML file.

void pawsWidget::MakeFullyVisible

(

)

If some part of the widget is not within the rectangle of its parent, then the widget is moved inside (if it is small enough).

virtual void pawsWidget::MouseOver ( bool  value )

virtual

Sets hasMouseFocus.

Parameters

value

TRUE causes widget to react to mouse focus.

Remarks

hasMouseFocus is used by DrawBackground() to fade the background in. Disabled by default.

Reimplemented in pawsDnDButton.

virtual void pawsWidget::MoveDelta ( int  dx, int  dy  )

virtual

Move a widget by a delta amount.

This will recurse through all the children calling MoveDelta on each.

Parameters

dx	Delta x
dy	Delta y

Reimplemented in pawsTitle.

virtual void pawsWidget::MoveTo ( int  x, int  y  )

virtual

Moves this widget and all of its children to a new screen location.

Parameters

x	new x
y	new y

Reimplemented in pawsTitle.

bool pawsWidget::NeedsRender ( ) const

inline

Whether we need to r2t.

Definition at line 1875 of file pawswidget.h.

virtual void pawsWidget::NewSubscription ( const char *  dataname )

inlinevirtual

Implements iPAWSSubscriber.

Definition at line 1838 of file pawswidget.h.

virtual bool pawsWidget::OnButtonPressed ( int  button, int  keyModifier, pawsWidget *  widget  )

inlinevirtual

Called whenever a button is pressed.

Parameters

button	The button pressed.
keyModifier	Modifier key in effect.
widget	The widget the button belongs to.

Returns

bool Parent's result or FALSE if no parent.

Reimplemented in pawsMenu, pawsChatWindow, pawsRadioButtonGroup, pawsMeterPromptWindow, pawsFingeringWindow, pawsMusicWindow, pawsColorPromptWindow, pawsGlyphWindow, pawsNpcDialogWindow, pawsRadioButton, pawsCheckBox, pawsSkillWindow, EEditErrorToolbox, EEditParticleListToolbox, pawsComboPromptWindow, pawsQuestListWindow, pawsScrollBar, EEditFPSToolbox, pawsConfigChatBubbles, pawsConfigKeys, pawsScriptHiredNPCWindow, pawsSelectorBox, pawsScrollMenu, pawsShortcutWindow, EEditShortcutsToolbox, pawsSpinBox, EEditEditEffectToolbox, EEditTargetToolbox, EEditPositionToolbox, pawsLootWindow, pawsInventoryWindow, pawsComboBox, pawsBookReadingWindow, pawsCreationMain, pawsExchangeWindow, EEditLoadEffectToolbox, pawsEEdit, pawsConfigTextPage, EEditLoadMapToolbox, pawsBartenderWindow, pawsConfigCamera, pawsGuildWindow, pawsConfigMouse, pawsGMActionWindow, pawsInfoWindow, EEditSelectList, pawsGMSpawnWindow, pawsNumberPromptWindow, EEditSelectEditAnchorKeyFrame, pawsTutorialNotifyWindow, pawsFileNavigation, EEditSelectEditAnchor, EEditSelectFloat, EEditSelectNewAnchor, EEditSelectString, EEditSelectVec3, pawsConfigShadows, EEditSelectNewAnchorKeyFrame, pawsConfigChatLogs, pawsConfigSpellChecker, EEditRenderToolbox, pawsCharParents, pawsConfigSound, pawsLoginWindow, WidgetConfigWindow, EEditSelectYesNo, pawsConfigAutoexec, pawsConfigChatTabCompletion, pawsConfigShortcut, pawsSpellBookWindow, EEditCameraToolbox, pawsConfigActiveMagic, pawsConfigTooltips, pawsOkBox, pawsAttackBookWindow, pawsCharBirth, pawsCraftCancelWindow, pawsPetStatWindow, pawsWritingWindow, peMenu, pawsChildhoodWindow, pawsIgnoreWindow, pawsMerchantWindow, peEditableWidget, peSkinSelector, pawsConfigDetails, pawsConfigEntityLabels, pawsDetailWindow, pawsStorageWindow, pawsTabWindow, pawsConfigChatFont, pawsContainerDescWindow, pawsSpellCancelWindow, pawsBankWindow, pawsInteractWindow, pawsCreditsWindow, pawsQuestRewardWindow, pawsCharacterPickerWindow, pawsItemDescriptionWindow, pawsQuitInfoBox, pawsLifeEventWindow, pawsLauncherWindow, and pawsCharDescription.

Definition at line 1190 of file pawswidget.h.

virtual bool pawsWidget::OnButtonReleased ( int  button, int  keyModifier, pawsWidget *  widget  )

inlinevirtual

Called whenever a button is released.

Parameters

button	The button released.
keyModifier	Modifier key in effect.
widget	The widget the button belongs to.

Returns

bool Parent's result or FALSE if no parent.

Reimplemented in pawsConfigWindow, EEditParticleListToolbox, pawsQuestListWindow, pawsScrollBar, pawsPetitionGMWindow, pawsPetitionWindow, pawsShortcutWindow, pawsScrollMenu, pawsGmGUIWindow, pawsSpinBox, pawsStringPromptWindow, pawsControlWindow, pawsGuildWindow, pawsBuddyWindow, pawsYesNoBox, pawsCharacterPickerWindow, pawsSummaryWindow, and pawsPathWindow.

Definition at line 1205 of file pawswidget.h.

virtual bool pawsWidget::OnChange ( pawsWidget *  widget )

virtual

Called whenever a widget is selected.

Parameters

widget

The widget acted upon.

Returns

Notify parent and return result FALSE if no parent.

Reimplemented in EEditParticleListToolbox, pawsStringPromptWindow, pawsScriptHiredNPCWindow, pawsConfigChatBubbles, pawsConfigDetails, pawsCreationMain, pawsConfigMouse, pawsGMActionWindow, pawsNumberPromptWindow, pawsConfigMarriage, pawsConfigTextPage, pawsFileNavigation, pawsConfigShadows, pawsLoginWindow, pawsConfigSpellChecker, pawsConfigChat, pawsConfigChatTabCompletion, pawsConfigAutoexec, pawsConfigPvP, and pawsConfigEntityLabels.

virtual bool pawsWidget::OnChildMouseEnter ( pawsWidget *  child )

virtual

Called when mouse enters a child widget.

If child wants to inform parent.

Parameters

child

The child widget.

Returns

true

Reimplemented in pawsChatWindow, and pawsControlWindow.

virtual bool pawsWidget::OnChildMouseExit ( pawsWidget *  child )

virtual

Called when a mouse exits a child widget.

If child wants to inform parent.

Parameters

child

The child widget.

Returns

bool Parent's result or TRUE if no parent.

Reimplemented in pawsChatWindow, and pawsControlWindow.

virtual bool pawsWidget::OnClipboard ( const csString &  content )

virtual

Process Clipboard content, as a response to RequestClipboardContent.

Parameters

content

The content of the clipboard

Returns

bool TRUE for success FALSE if no action.

Reimplemented in pawsMultilineEditTextBox, and pawsEditTextBox.

virtual bool pawsWidget::OnDoubleClick ( int  button, int  modifiers, int  x, int  y  )

virtual

Manage mouse double click event.

Returns

bool Parent's result or FALSE if no parent.

Remarks

Acts recursively on it's parents.

Reimplemented in pawsChatWindow, pawsListBoxRow, psMainWidget, pawsGameTile, pawsMainWidget, and pawsItemTree.

virtual bool pawsWidget::OnGainFocus ( bool  = true )

inlinevirtual

Changes hasFocus to TRUE and reports status to parent.

Returns

bool

Remarks

Acts recursively on it's parents. If the widget cannot be focused, this function needs be overridden.

Reimplemented in pawsMultiPageTextBox, pawsMultiLineTextBox, pawsTextBox, and pawsScrollBar.

Definition at line 823 of file pawswidget.h.

virtual bool pawsWidget::OnJoypadDown ( int  key, int  modifiers  )

virtual

Process joypadDown messages.

Parameters

key	The key pressed.
modifiers	Used to modify behavior.

Returns

bool TRUE for success FALSE if no action.

virtual bool pawsWidget::OnKeyDown ( utf32_char  keyCode, utf32_char  keyChar, int  modifiers  )

virtual

Process keydown messages.

Parameters

keyCode	The code for the pressed key.
keyChar	The key pressed.
modifiers	Used to modify tab behavior.

Returns

bool TRUE for success FALSE if no action.

Remarks

If you override this, be sure to also override GetFocusOverridesControls() as returning true

Reimplemented in pawsMultilineEditTextBox, pawsEditTextBox, pawsMessageTextBox, pawsListBox, pawsTree, pawsSketchWindow, pawsChatWindow, pawsFingeringWindow, pawsColorPromptWindow, pawsScrollMenu, pawsListBoxRow, pawsNpcDialogWindow, psMainWidget, pawsStringPromptWindow, pawsButton, pawsBookReadingWindow, pawsFileNavigation, pawsMainWidget, and pawsKeySelectBox.

virtual void pawsWidget::OnListAction ( pawsListBox *  selected, int  status  )

inlinevirtual

Called whenever an item in a child list box is selected.

Parameters

selected	The listbox that has the item selected.
status	From listbox when a row is selected.

Reimplemented in pawsSkillWindow, EEditParticleListToolbox, pawsConfigChatBubbles, pawsQuestListWindow, pawsPetitionGMWindow, pawsPetitionWindow, pawsSelectorBox, EEditShortcutsToolbox, pawsGmGUIWindow, pawsConfigTextPage, pawsComboBox, EEditLoadEffectToolbox, pawsConfigShadows, pawsNpcDialogWindow, pawsBuddyWindow, pawsConfigSpellChecker, EEditSelectList, pawsFileNavigation, pawsConfigAutoexec, pawsConfigChatTabCompletion, pawsLoginWindow, EEditRenderToolbox, pawsConfigSound, pawsConfigShortcut, pawsSpellBookWindow, pawsConfigActiveMagic, pawsAttackBookWindow, pawsConfigChatLogs, pawsPetStatWindow, pawsCharParents, pawsCharBirth, pawsConfigEntityInteraction, pawsIgnoreWindow, peSkinSelector, pawsChildhoodWindow, pawsConfigChatFont, pawsModsWindow, pawsMerchantWindow, pawsLifeEventWindow, and pawsStorageWindow.

Definition at line 1345 of file pawswidget.h.

virtual void pawsWidget::OnLostFocus ( )

inlinevirtual

Sets hasFocus false and notifys parent.

Reimplemented in pawsChatWindow, pawsSpinBox, and pawsThumb.

Definition at line 834 of file pawswidget.h.

virtual bool pawsWidget::OnMenuAction ( pawsWidget *  widget, const pawsMenuAction &  action  )

virtual

Called whenever a menu action occurs.

Parameters

widget	The widget acted upon.
action	The action to take.

Returns

TRUE on menu destroy and FALSE on configure

Reimplemented in pawsChatWindow, and pawsGroupWindow.

virtual bool pawsWidget::OnMouseDown ( int  button, int  modifiers, int  x, int  y  )

virtual

Manage mouse down event to test for and apply window changes.

Parameters

button	Type of button: 1 resizable or movable, 2 context menu or config window.
modifiers	Used with PAWS_CONSTRUCTION.
x	Used to test for resize.
y	Used to test for resize.

Returns

bool TRUE if movable or resizable.

Remarks

calls OnMouseDown on it's parent.

Reimplemented in pawsMultilineEditTextBox, pawsSheetLine, pawsMultiPageTextBox, pawsMultiLineTextBox, pawsEditTextBox, pawsMessageTextBox, pawsTree, pawsSketchWindow, pawsListBox, pawsMenu, pawsChatWindow, pawsFingeringWindow, pawsScrollMenu, pawsListBoxRow, pawsObjectView, pawsGlyphWindow, pawsNpcDialogWindow, psMainWidget, pawsConfigChatBubbles, pawsScrollBar, pawsShortcutWindow, pawsButton, pawsInventoryWindow, pawsBookReadingWindow, pawsGameTile, pawsMainWidget, pawsDnDButton, pawsInteractWindow, pawsSlot, and pawsInventoryDollView.

virtual bool pawsWidget::OnMouseEnter ( )

virtual

Called whenever the mouse enters this widget.

Returns

bool Parent's result or TRUE if no parent.

Remarks

Acts recursively on it's parents.

Reimplemented in pawsControlWindow, and pawsButton.

virtual bool pawsWidget::OnMouseExit ( )

virtual

Called whenever the mouse leaves this widget.

Returns

bool Parent's result or TRUE if no parent.

Reimplemented in pawsControlWindow, pawsScrollBar, pawsObjectView, and pawsButton.

virtual bool pawsWidget::OnMouseUp ( int  button, int  modifiers, int  x, int  y  )

virtual

Manage mouse up event.

Returns

bool Parent's result or FALSE if no parent.

Remarks

Acts recursively on it's parents.

Reimplemented in pawsMultilineEditTextBox, pawsSketchWindow, pawsObjectView, psMainWidget, pawsScrollBar, pawsButton, pawsMainWidget, pawsDnDButton, and pawsThumb.

virtual void pawsWidget::OnResize ( )

virtual

Sets the new position of the close button.

Reimplemented in pawsMultilineEditTextBox, pawsMessageTextBox, pawsScrollBar, pawsObjectView, pawsShortcutWindow, pawsScrollMenu, pawsBuddyWindow, and pawsActiveMagicWindow.

virtual bool pawsWidget::OnScroll ( int  scrollDirection, pawsScrollBar *  widget  )

inlinevirtual

Called whenever a window is scrolled.

Parameters

scrollDirection	The direction to move.
widget	The scrollbar widget being manipulated.

Returns

bool Parent's result or FALSE if no parent.

Reimplemented in pawsMultilineEditTextBox, pawsMultiPageTextBox, pawsMultiLineTextBox, pawsMessageTextBox, pawsTree, pawsListBox, pawsMusicWindow, pawsColorPromptWindow, EEditParticleListToolbox, pawsConfigChatBubbles, pawsShortcutWindow, pawsNumberPromptWindow, pawsInfoWindow, pawsConfigHPandMana, pawsConfigSound, WidgetConfigWindow, pawsConfigShortcut, pawsConfigActiveMagic, pawsConfigDetails, and pawsConfigChatFont.

Definition at line 1219 of file pawswidget.h.

virtual bool pawsWidget::OnSelected ( pawsWidget *  widget )

virtual

Called whenever a widget is selected.

Parameters

widget

The selected widget.

Returns

bool

Reimplemented in pawsConfigWindow, EEditEditEffectToolbox, pawsGMSpawnWindow, pawsCraftWindow, peWidgetTree, and pawsHelp.

virtual void pawsWidget::OnUpdateData ( const char *  , PAWSData &    )

inlinevirtual

Implements iPAWSSubscriber.

Reimplemented in pawsMultilineEditTextBox, pawsMultiPageTextBox, pawsMultiLineTextBox, pawsEditTextBox, pawsMessageTextBox, pawsDnDButton, pawsTextBox, pawsScrollBar, pawsProgressBar, pawsCheckBox, pawsSlot, EEditEditEffectToolbox, and pawsMoney.

Definition at line 1837 of file pawswidget.h.

virtual bool pawsWidget::ParentDraw ( ) const

inlinevirtual

Whether to draw via the parent-child draw tree.

Definition at line 782 of file pawswidget.h.

virtual void pawsWidget::PerformAction ( const char *  action )

virtual

Does an action based on this string.

Parameters

action

The action to perform.

Reimplemented in pawsChatWindow.

virtual bool pawsWidget::PostSetup ( )

inlinevirtual

This is called after the widget and all of it's children have been created.

Remarks

This can be useful for widgets that want to get pointers to some of it's children for quick access.

Reimplemented in pawsSheetLine, pawsMultiPageTextBox, pawsMultiLineTextBox, pawsMessageTextBox, pawsTree, pawsSketchWindow, pawsListBox, pawsMenu, pawsControlWindow, pawsChatWindow, pawsFingeringWindow, pawsMeterPromptWindow, pawsMusicWindow, pawsColorPromptWindow, pawsConfigWindow, pawsGameBoard, pawsGlyphWindow, EEditErrorToolbox, pawsSkillWindow, EEditParticleListToolbox, pawsTutorialWindow, pawsComboPromptWindow, pawsQuestListWindow, EEditFPSToolbox, pawsPetitionGMWindow, pawsPetitionWindow, pawsScrollBar, pawsShortcutWindow, pawsTitle, EEditShortcutsToolbox, pawsConfigChatBubbles, EEditEditEffectToolbox, EEditTargetToolbox, EEditPositionToolbox, pawsScrollMenu, pawsGmGUIWindow, pawsScriptHiredNPCWindow, pawsLootWindow, pawsInventoryWindow, pawsCreationMain, pawsComboBox, pawsExchangeWindow, EEditLoadEffectToolbox, pawsEEdit, EEditLoadMapToolbox, ComboWrapper, pawsGuildWindow, EEditSelectList, pawsConfigTooltips, pawsNpcDialogWindow, pawsNumberPromptWindow, pawsYesNoBox, EEditSelectEditAnchorKeyFrame, pawsBartenderWindow, pawsLoadWindow, pawsFileNavigation, EEditSelectEditAnchor, EEditSelectFloat, EEditSelectNewAnchor, EEditSelectString, EEditSelectVec3, pawsOkBox, pawsPromptWindow, EEditSelectNewAnchorKeyFrame, pawsActiveMagicWindow, pawsInfoWindow, pawsTutorialNotifyWindow, EEditRenderToolbox, pawsGMActionWindow, EEditSelectYesNo, pawsBuddyWindow, pawsCharBirth, pawsConfigHPandMana, pawsConfigMarriage, pawsConfigSound, pawsDetailWindow, pawsGMSpawnWindow, WidgetConfigWindow, EEditCameraToolbox, pawsConfigChat, pawsConfigChatFilter, pawsConfigPopup, pawsConfigShortcut, pawsWritingWindow, peSkinSelector, pawsCharParents, pawsConfigActiveMagic, pawsGroupWindow, pawsConfigDetails, pawsConfigEntityInteraction, pawsLoginWindow, pawsPetStatWindow, pawsSpellBookWindow, peMenu, pawsConfigPvP, pawsConfigTextPage, pawsLifeEventWindow, pawsMoney, pawsSmallInventoryWindow, EEditRequestCombo, peEditableWidget, peWidgetTree, pawsAttackBookWindow, pawsChildhoodWindow, pawsConfigChatTabs, pawsIgnoreWindow, pawsContainerDescWindow, pawsCraftWindow, pawsHelp, pawsTabWindow, pawsBankWindow, pawsConfigChatFont, pawsConfigChatLogs, pawsConfigShadows, pawsConfigSpellChecker, pawsSummaryWindow, pawsConfigAutoexec, pawsCraftCancelWindow, pawsMerchantWindow, pawsModsWindow, pawsConfigChatTabCompletion, pawsInteractWindow, pawsQuestRewardWindow, pawsStorageWindow, pawsBookReadingWindow, pawsCharacterPickerWindow, pawsQuitInfoBox, pawsSpellCancelWindow, pawsCharDescription, pawsCreditsWindow, pawsItemDescriptionWindow, pawsLauncherWindow, pawsActionLocationWindow, pawsPathWindow, and pawsSplashWindow.

Definition at line 709 of file pawswidget.h.

bool pawsWidget::ReadDefaultWidgetStyles ( iDocumentNode *  node )

protected

void pawsWidget::RecalcScreenPositions

(

)

This re-calculates a widget's on screen position to draw based on it's relative position and parent screen location.

void pawsWidget::ReloadWidget

(

)

Reloads widget from XML file.

void pawsWidget::RemoveChild

(

pawsWidget *

widget

)

Removes the widget from list of children but does NOT destruct it.

Parameters

widget

The widget to remove.

Remarks

Ownership goes to the caller.

void pawsWidget::RemoveTitle

(

)

virtual void pawsWidget::ResetToDefaultFrame ( )

inlinevirtual

Resets the position, width and height to the default position.

Definition at line 874 of file pawswidget.h.

virtual void pawsWidget::Resize ( int  flags )

virtual

Resize a widget based on the current mouse position.

This will recurse through all the children calling Resize() on each.

Parameters

flags

The resize direction.

virtual void pawsWidget::Resize ( int  dx, int  dy, int  flags  )

virtual

Resize a widget by a delta amount.

This will recurse through all the children calling Resize() on each.

Parameters

dx	Delta x
dy	Delta y
flags	The resize direction.

virtual void pawsWidget::Resize ( )

virtual

Resize a widget based on it's parent's size.

Reimplemented in pawsMultiPageDocumentView, pawsDocumentView, pawsMultiPageTextBox, pawsMultiLineTextBox, pawsMessageTextBox, pawsListBox, and pawsTitle.

int pawsWidget::ResizeFlags ( int  mouseX, int  mouseY  )

protected

This will check to see if the mouse is over the resize hot spot.

void pawsWidget::RunScriptEvent

(

PAWS_WIDGET_SCRIPT_EVENTS

event

)

Executes any pawsScript associated with the given event.

virtual void pawsWidget::SavePosition ( )

virtual

Saves the position of this widget to the config file.

This is done if the savedWindowPos is set to true, this can be done inside the xml file as savepositions="yes"

virtual void pawsWidget::SaveSettings ( )

virtual

Saves current widget settings to an XML file.

virtual bool pawsWidget::SelfPopulate ( iDocumentNode *  node )

virtual

This function allows a widget to fill in its own contents from an xml node supplied and calls the same function for all children.

Parameters

node	The xml data for the widget.

Returns

bool TRUE if no children, FALSE if there are problems with a node.

Remarks

User should overload this function to populate different types of widgets. Call this base class function to populate children. This is NOT the same as Setup(), which is defining height, width, styles, etc. This is data.

Reimplemented in pawsMultilineEditTextBox, pawsEditTextBox, pawsMessageTextBox, pawsListBox, pawsScrollMenu, pawsTextBox, pawsSlot, pawsCheckBox, pawsDnDButton, and pawsButton.

virtual bool pawsWidget::SelfPopulateXML ( const char *  xmlstr )

virtual

This function parses the xml string and calls SelfPopulate with the resulting DOM structure if valid.

Parameters

xmlstr

The xml string to process.

Remarks

This is NOT the same thing as Setup, which is defining the widget structure. This is for data.

virtual void pawsWidget::SendToBottom ( pawsWidget *  widget )

virtual

Move this widget down the z order to the bottom.

Parameters

widget

Widget to bring forward.

void pawsWidget::SetAlwaysOnTop ( bool  value )

inline

Sets value of this widgets alwaysOnTop flag.

Parameters

value

True to set always on top.

Remarks

Will cause the parent to bring this widget to the top.

Definition at line 1286 of file pawswidget.h.

virtual void pawsWidget::SetAttachFlags ( int  flags )

inlinevirtual

Modify attachFlags to control widget construction.

Parameters

flags

The new value for attachFlags.

Remarks

attachFlags is 0 by default.

Definition at line 903 of file pawswidget.h.

virtual void pawsWidget::SetBackground ( const char *  imageName )

virtual

Sets the background image, logs error if NULL.

Parameters

imageName

The new background image.

Remarks

Loads image description and gets initial alpha level.

virtual void pawsWidget::SetBackgroundAlpha ( int  alphaValue )

virtual

Sets the alpha level of the background.

Parameters

alphaValue

The new alpha level.

Remarks

Updates current alpha level sets alpha and alphaMin to alphaValue.

void pawsWidget::SetBackgroundColor	(	int	r,
		int	g,
		int	b
	)

Sets the background color.

Parameters

r	Red
g	Green
b	Blue

void pawsWidget::SetCloseButtonPos ( )

protected

Gets button from widget and sets it's location.

void pawsWidget::SetColour

(

int

newColour = -2

)

Set text color.

Parameters

newColour

The colour to use from now on for this widget. If it's -1 it will make the selection at runtime (by checking first the parent then the default colour) If it's -2 (default) it will make the choice upon this call by setting the default color.

void pawsWidget::SetContextMenu ( const csString &  fileName )

inline

Sets name of the PAWS xml-file that describes context menu of our widget.

Definition at line 1529 of file pawswidget.h.

void pawsWidget::SetDefaultToolTip ( )

inline

Sets the tool tip to the one defined in the XML.

Definition at line 1334 of file pawswidget.h.

void pawsWidget::SetExtraData ( iWidgetData *  data )

inline

Stores extra data into this widget.

Parameters

data	The extra data to store.

Remarks

The widget takes ownership of the data.

Definition at line 1811 of file pawswidget.h.

void pawsWidget::SetFactory ( const char *  myfactory )

inline

Sets the type of factory.

Parameters

myfactory

The new factory type.

Definition at line 1371 of file pawswidget.h.

void pawsWidget::SetFade

(

bool

value

)

Used to control the fading feature of the widget.

Parameters

value

True if fading feature should be on.

void pawsWidget::SetFadeSpeed ( float  speed )

inline

Sets the fading speed.

Definition at line 1714 of file pawswidget.h.

void pawsWidget::SetFilename

(

const char *

name

)

Changes filename to the name provided.

void pawsWidget::SetFont	(	const char *	fontName,
		int	Size = 0
	)

Set font to use programmatically.

void pawsWidget::SetFontScaling

(

bool

value

)

Used to control the font scaling of the widget.

Parameters

value

True if font scaling should be enabled.

void pawsWidget::SetFontStyle

(

int

style

)

Sets the current font style.

virtual void pawsWidget::SetForceSize ( int  newWidth, int  newHeight  )

virtual

Same as above, but does not resize children.

void pawsWidget::SetID ( int  newID )

inline

Change the id of a widget.

Parameters

newID

The id number to change to.

Definition at line 1255 of file pawswidget.h.

void pawsWidget::SetMaskingImage

(

const char *

image

)

Sets a masking image which will be drawn after the normal stuff.

Parameters

image

The image resource name.

void pawsWidget::SetMaxAlpha ( int  value )

inline

Sets the maximum alpha of this widget.

Definition at line 1690 of file pawswidget.h.

void pawsWidget::SetMaxSize ( int  width, int  height  )

inline

Set the max size for height and width.

Remarks

Default is screen height and width.

Definition at line 1519 of file pawswidget.h.

void pawsWidget::SetMinAlpha ( int  value )

inline

Sets the minimim alpha of this widget.

Definition at line 1682 of file pawswidget.h.

void pawsWidget::SetMinSize ( int  width, int  height  )

inline

Set the minimum height and width to protect the widget from negatives.

Definition at line 1502 of file pawswidget.h.

void pawsWidget::SetModalState

(

bool

isModal

)

Registers mode with the windowManager.

Parameters

isModal

set TRUE to make the widget modal.

void pawsWidget::SetMovable ( bool  value )

inline

Makes a widget movable.

Parameters

value

True if movable.

Definition at line 1298 of file pawswidget.h.

void pawsWidget::SetName ( const char *  newName )

inline

Set the name of this widget.

Definition at line 1049 of file pawswidget.h.

void pawsWidget::SetNeedsRender ( bool  needs )

inline

Marks that we need to r2t.

Definition at line 1864 of file pawswidget.h.

void pawsWidget::SetParent

(

pawsWidget *

widget

)

Set the owner of this widget.

Parameters

widget

The owner of this widget.

virtual void pawsWidget::SetProperty ( const char *  ptr, double  value  )

virtual

Reimplemented in pawsCheckBox.

virtual void pawsWidget::SetRelativeFrame ( int  x, int  y, int  width, int  height  )

virtual

Set the size of this widget and it's position relative to the parent.

Parameters

x	The offset from the parent's minimum x value.
y	The offset from the parent's minimum y value.
width	Value to be used for default width.
height	Value to be used for default height.

Reimplemented in pawsDnDButton.

virtual void pawsWidget::SetRelativeFramePos ( int  x, int  y  )

virtual

Set the position of this widget relative to the parent.

Parameters

x	The offset from the parent's minimum x value.
y	The offset from the parent's minimum y value.

Remarks

Recalculates the screen positions of all of it's children.

virtual void pawsWidget::SetRelativeFrameSize ( int  width, int  height  )

virtual

Sets defaultFrame and screenFrame size attributes.

Parameters

width	Value to be used for default width.
height	Value to be used for default height.

Remarks

Recalculates the screen positions of all of it's children.

void pawsWidget::SetResizeShow ( bool  v )

inline

Sets the showResize flag, controlling if the resize widget should be drawn.

Parameters

v

Value

Definition at line 804 of file pawswidget.h.

virtual void pawsWidget::SetSize ( int  newWidth, int  newHeight  )

virtual

Set the size of a particlar widget.

This will also call Resize() all of the children widgets to adjust to the new parent size.

Parameters

newWidth	The new width of this widget.
newHeight	The new height of this widget.

void pawsWidget::SetTitle

(

const char *

title

)

Sets the border title of this widget.

bool pawsWidget::SetTitle	(	const char *	text,
		const char *	image,
		const char *	align,
		const char *	close_button,
		const bool	shadowTitle = true
	)

Sets up the title bar for the widget.

Parameters

text	The name that should go in the title.
image	The name of the backround image for the title.
align	The alignment of the text.
close_button	"yes" means to add a close button to the title bar.
shadowTitle	True if title should have shadow.

Returns

true if all was successful.

void pawsWidget::SetToolTip ( const char *  text )

inline

Changes the text for a tool tip.

Parameters

text	The new text.

Definition at line 1308 of file pawswidget.h.

virtual bool pawsWidget::Setup ( iDocumentNode *  )

inlinevirtual

Setup this widget.

Reimplemented in pawsFadingTextBox, pawsMultilineEditTextBox, pawsMultiPageTextBox, pawsMultiLineTextBox, pawsSimpleTree, pawsEditTextBox, pawsMenuItem, pawsMessageTextBox, pawsTree, pawsListBox, pawsMenu, pawsRadioButtonGroup, pawsProgressBar, pawsScrollMenu, pawsTextBox, pawsRadioButton, pawsSelectorBox, pawsObjectView, pawsCheckBox, pawsScrollBar, pawsShortcutWindow, pawsTitle, pawsSpinBox, pawsComboBox, pawsGenericView, pawsDnDButton, pawsActiveMagicWindow, pawsButton, pawsMoney, pawsKeySelectBox, and pawsSlot.

Definition at line 697 of file pawswidget.h.

void pawsWidget::SetVisibility ( bool  visible )

inline

Make the widget visible or hides it.

Parameters

visible

TRUE calls Show(), FALSE calls Hide().

Definition at line 436 of file pawswidget.h.

virtual void pawsWidget::SetXMLBinding ( csString &  xmlbinding )

inlinevirtual

Sets the xml nodes of this widget.

Parameters

xmlbinding

Definition at line 640 of file pawswidget.h.

virtual void pawsWidget::Show ( )

virtual

Makes widget visible and brings it to the front.

Sets visible TRUE shows border if present then calls BringToTop() on itself.

Reimplemented in pawsControlledWindow, pawsChatWindow, pawsShortcutWindow, pawsGlyphWindow, pawsSkillWindow, EEditErrorToolbox, pawsNpcDialogWindow, pawsConfigChatBubbles, EEditShortcutsToolbox, pawsQuestListWindow, pawsControlWindow, pawsPetitionGMWindow, pawsGmGUIWindow, pawsCreationMain, pawsPetitionWindow, pawsInventoryWindow, pawsBuddyWindow, pawsFileNavigation, pawsActiveMagicWindow, pawsGuildWindow, pawsLoadWindow, pawsConfigChat, pawsConfigSound, pawsConfigTextPage, pawsSpellBookWindow, pawsGMActionWindow, pawsPetStatWindow, pawsAttackBookWindow, pawsCharBirth, pawsChildhoodWindow, pawsGMSpawnWindow, pawsCharParents, pawsConfigShadows, pawsInfoWindow, pawsLoginWindow, pawsModsWindow, pawsQuitInfoBox, pawsSmallInventoryWindow, pawsSummaryWindow, pawsCraftWindow, pawsCharDescription, pawsCharacterPickerWindow, pawsCreditsWindow, and pawsLifeEventWindow.

virtual void pawsWidget::ShowBehind ( )

virtual

Makes widget visible and brings it to the front but behind widget with current focus.

Sets visible TRUE shows border if present then calls Show() on widget that had focus when ShowBehind() was called.

virtual void pawsWidget::StopResize ( )

virtual

Called once the mouse up is done after resizing a widget.

const char* pawsWidget::ToString ( )

inlinevirtual

Implements iScriptableVar.

Definition at line 1918 of file pawswidget.h.

virtual void pawsWidget::UseBorder ( const char *  style = 0 )

virtual

Creates a new border and links it to the widget.

Parameters

style

The style of border to create.

virtual pawsWidget* pawsWidget::WidgetAt ( int  x, int  y  )

virtual

Locate a widget that is at these screen coordindates.

This will recurse through all the children as well looking for the lowest widget that contains these coordinates.

Parameters

x	The x screen position
y	The y screen position

Returns

NULL if this widget does not contain these coordinates. this if it contains these coordinates and none of it's children do.

Member Data Documentation

int pawsWidget::alpha

protected

The original background alpha.

Definition at line 254 of file pawswidget.h.

int pawsWidget::alphaMin

protected

The minimum background alpha.

Definition at line 257 of file pawswidget.h.

bool pawsWidget::alwaysOnTop

protected

Is this windows painted on top of other windows.

Definition at line 202 of file pawswidget.h.

int pawsWidget::attachFlags

protected

The attachpoints for when a resize takes place.

Definition at line 242 of file pawswidget.h.

int pawsWidget::bgColour

protected

Stores the bgColour for this widget.

Remarks

Set to -1 if no colour should be used.

Definition at line 230 of file pawswidget.h.

csRef<iPawsImage> pawsWidget::bgImage

protected

Background image.

Definition at line 233 of file pawswidget.h.

pawsBorder* pawsWidget::border

protected

border created by GetBorder().

Definition at line 236 of file pawswidget.h.

int pawsWidget::borderColours[5]

protected

Custom border colors for this window.

Definition at line 281 of file pawswidget.h.

bool pawsWidget::borderTitleShadow

protected

whether the title in the border should be shadow font

Definition at line 239 of file pawswidget.h.

csArray<pawsWidget*> pawsWidget::children

protected

The child widgets.

Widgets are drawn from the end of this array to the beginning. Children with alwaysOnTop=true are positioned before all other children in this array.

Definition at line 160 of file pawswidget.h.

csRect pawsWidget::clipRect

protected

Current clipping rectangle.

Definition at line 142 of file pawswidget.h.

pawsButton* pawsWidget::close_widget

protected

Used in SetTitle() for the new close button.

Definition at line 151 of file pawswidget.h.

csString pawsWidget::closeName

protected

Old name of the widget with "_close" appended by SetName().

Definition at line 220 of file pawswidget.h.

bool pawsWidget::configurable

protected

Determines if the settings (alpha, fade, etc) of this widget are configurable.

Definition at line 181 of file pawswidget.h.

pawsMenu* pawsWidget::contextMenu

protected

Existing context menu of the widget.

Remarks

NULL if there is no menu created at the moment.

Definition at line 278 of file pawswidget.h.

csString pawsWidget::contextMenuFile

protected

Path to the file that describes context menu of our widget (invoked by mouse right-click).

Remarks

If blank, then there is no context menu for our widget.

Definition at line 271 of file pawswidget.h.

int pawsWidget::defaultFontColour

protected

Optional color to use when drawing text with this widget.

Definition at line 290 of file pawswidget.h.

int pawsWidget::defaultFontShadowColour

protected

Optional color to use when doing text dropshadows.

Definition at line 293 of file pawswidget.h.

float pawsWidget::defaultFontSize

protected

Default font size.

Definition at line 296 of file pawswidget.h.

csRect pawsWidget::defaultFrame

protected

The default frame for the widget.

Definition at line 136 of file pawswidget.h.

csString pawsWidget::defaultToolTip

protected

Default tool tip string for the widget.

Definition at line 320 of file pawswidget.h.

csHash<csString,csString> pawsWidget::defaultWidgetStyles

protected

Definition at line 360 of file pawswidget.h.

iWidgetData* pawsWidget::extraData

protected

Holds any extra data the widget may need.

Definition at line 336 of file pawswidget.h.

csString pawsWidget::factory

protected

factory name

Definition at line 124 of file pawswidget.h.

bool pawsWidget::fade

protected

Set to false to disable fading.

Definition at line 260 of file pawswidget.h.

float pawsWidget::fadeSpeed

protected

The speed of the fading process.

Definition at line 263 of file pawswidget.h.

float pawsWidget::fadeVal

protected

The direction and percentage of current fade in progress.

Definition at line 251 of file pawswidget.h.

csString pawsWidget::filename

protected

filename to load from or save to.

Definition at line 148 of file pawswidget.h.

csString pawsWidget::fontName

protected

Name of currently selected font.

Definition at line 305 of file pawswidget.h.

float pawsWidget::fontSize

protected

Current font size.

Definition at line 299 of file pawswidget.h.

int pawsWidget::fontStyle

protected

Current font style.

Definition at line 308 of file pawswidget.h.

csRef<iGraphics2D> pawsWidget::graphics2D

protected

The 2D graphics interface.

Definition at line 133 of file pawswidget.h.

bool pawsWidget::hasBorderColours

protected

Flag to indicate using custom border colors.

Definition at line 284 of file pawswidget.h.

bool pawsWidget::hasFocus

protected

Flag for widget focus.

Definition at line 245 of file pawswidget.h.

bool pawsWidget::hasMouseFocus

protected

Flag for mouse over behavior.

Definition at line 248 of file pawswidget.h.

int pawsWidget::id

protected

The id of the widget.

Definition at line 127 of file pawswidget.h.

bool pawsWidget::ignore

protected

Flag determines if WidgetAT() ignores this widget.

Remarks

Default is FALSE. Set during LoadAttributes().

Definition at line 330 of file pawswidget.h.

bool pawsWidget::isResizable

protected

Determines if this widget can be resized by user.

Definition at line 187 of file pawswidget.h.

bool pawsWidget::keepaspect

protected

Enforce keeping the default aspect ratio when resizing.

Definition at line 199 of file pawswidget.h.

int pawsWidget::margin

protected

Stores margin value. Used in LoadAttributes().

Definition at line 333 of file pawswidget.h.

csRef<iPawsImage> pawsWidget::maskImage

protected

Masking image, used for nice-looking stuff.

Definition at line 323 of file pawswidget.h.

int pawsWidget::max_height

protected

Defines the maximum height that the widget can be.

Definition at line 214 of file pawswidget.h.

int pawsWidget::max_width

protected

Defines the maximum width that the widget can be.

Definition at line 211 of file pawswidget.h.

int pawsWidget::min_height

protected

Defines the minimum height that the widget can be.

Definition at line 208 of file pawswidget.h.

int pawsWidget::min_width

protected

Defines the minimum width that the widget can be.

Definition at line 205 of file pawswidget.h.

bool pawsWidget::movable

protected

Determines if this widget is movable.

Definition at line 184 of file pawswidget.h.

csRef<iFont> pawsWidget::myFont

protected

Optional font to use when drawing this widget.

Definition at line 287 of file pawswidget.h.

csString pawsWidget::name

protected

The name of this widget.

Definition at line 217 of file pawswidget.h.

bool pawsWidget::needsRender

protected

Whether we need to do a r2t update.

Definition at line 339 of file pawswidget.h.

pawsWidget* pawsWidget::onEnter

protected

Widget to call if enter is pressed.

Definition at line 166 of file pawswidget.h.

bool pawsWidget::overwrite_subscription

protected

Flag of whether OnUpdateData should overwrite the previous value or add to it.

Used by Multi-line edit currently.

Remarks

TRUE by default because everything else should overwrite.

Definition at line 354 of file pawswidget.h.

pawsWidget* pawsWidget::parent

protected

This widget's parent.

Definition at line 130 of file pawswidget.h.

bool pawsWidget::parentDraw

protected

Whether to draw this widget (different from visible, used to decide if Draw() is called via parent-child tree).

Definition at line 345 of file pawswidget.h.

csArray<csString> pawsWidget::publishList

Definition at line 1926 of file pawswidget.h.

bool pawsWidget::resizeToScreen

protected

Determines if this widget should be auto resized with screen resolution.

Definition at line 196 of file pawswidget.h.

bool pawsWidget::saveWidgetPositions

protected

Determines if this widget should write/load it's position from a config file.

Definition at line 175 of file pawswidget.h.

bool pawsWidget::scaleFont

protected

Determines whether or not to scale font when a widget it resized.

Definition at line 302 of file pawswidget.h.

csRect pawsWidget::screenFrame

protected

The screen area of the widget.

Definition at line 139 of file pawswidget.h.

pawsScript* pawsWidget::scriptEvents[PW_SCRIPT_EVENT_COUNT]

protected

Definition at line 358 of file pawswidget.h.

bool pawsWidget::showOnMouseOver

protected

Stores status of showOnMouseOver.

Definition at line 365 of file pawswidget.h.

csString pawsWidget::showOnMouseOver_image

protected

Stores the bgimage name if showOnMouseOver is true.

Definition at line 368 of file pawswidget.h.

bool pawsWidget::showResize

protected

If the resize widget should be drawn.

Definition at line 190 of file pawswidget.h.

csString pawsWidget::subscribedVar

protected

The variable that this widget is subscribed to.

Definition at line 223 of file pawswidget.h.

csString pawsWidget::subscription_format

protected

Definition at line 356 of file pawswidget.h.

csArray<pawsWidget*> pawsWidget::taborder

protected

Contains the children for tabbing.

Definition at line 163 of file pawswidget.h.

pawsTitle* pawsWidget::titleBar

protected

reference to titleBar object, if any

Definition at line 145 of file pawswidget.h.

csString pawsWidget::toolTip

protected

Tooltip to be displayed.

Definition at line 317 of file pawswidget.h.

bool pawsWidget::visible

protected

Flag to determine visiblity.

Definition at line 169 of file pawswidget.h.

csString pawsWidget::xmlbinding

protected

Used in the SelfPopulate functions to map to xml nodes for each widget.

Definition at line 314 of file pawswidget.h.

---

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

• common/paws/pawswidget.h