HPL3/SOMA/Scripting/cWidgetMenuItem

Have some helpful descriptions to add to this class? Edit this page and add your insight to the Wiki!

Fields

cWidgetMenuItem has no public fields.

Functions

Return Type	Function Name	Parameters	Description
cWidgetMenuItem@	AddMenuItem	const tWString &in asText, const tWString &in asIconFilename = _W
void	AddSeparator
cGuiGlobalShortcut@	AddShortcut	int alKeyModifiers, eKey aKey, eGuiMessage aMsg = eGuiMessage_ButtonPressed, const cGuiMessageData &in aData = cGuiMessageData, bool abBypassVisibility = true, bool abBypassEnabled = true
void	AttachChild	iWidget@ apChild
void	CenterGlobalPositionInSet
void	ClearMenuItems
bool	ClipsGraphics
bool	GetCallbacksDisabled
iWidgetMenu@	GetChildMenu
const cVector3f&	GetChildrenOffset
bool	GetClipActive
const cColor&	GetColorMul
const cColor&	GetDefaultFontColor
const cVector2f&	GetDefaultFontSize
iFontData@	GetDefaultFontType
iWidget@	GetFocusNavigation	eUIArrow aDir
const cVector3f&	GetGlobalPosition
const cVector3f&	GetLocalPosition
bool	GetMouseIsOver
const tString&	GetName
iWidget@	GetParent
iWidgetMenu@	GetParentMenu
cGuiGfxElement@	GetPointerGfx
const cVector3f&	GetScrollAmount
cGuiSet@	GetSet
const tWString&	GetShortcutText
const cVector2f&	GetSize
const tWString&	GetText
float	GetTextLength
const tWString&	GetToolTip
iWidget@	GetToolTipWidget
eWidgetType	GetType
int	GetUserValue
bool	HasFocus
bool	HasFocusNavigation
void	Init
bool	IsChecked
bool	IsConnectedTo	iWidget@ apWidget, bool abIsStartWidget = true
bool	IsConnectedToChildren
bool	IsDefault
bool	IsEnabled
bool	IsGlobalKeyPressListener
bool	IsGlobalUIInputListener
bool	IsMenuOpen
bool	IsParent
bool	IsRightUnderMouse
bool	IsSeparator
bool	IsVisible
bool	PointIsInside	const cVector2f &in avPoint, bool abOnlyClipped
bool	ProcessMessage	eGuiMessage aMessage, const cGuiMessageData &in aData, bool abSkipVisCheck = false, bool abSkipEnabledCheck = false
void	RemoveChild	iWidget@ apChild
void	SetAffectedByScroll	bool abX
void	SetCallbacksDisabled	bool abX
void	SetChecked	bool abX
void	SetChildrenOffset	const cVector3f &in
void	SetClipActive	bool abX
void	SetColorMul	const cColor &in aColor
void	SetConnectedToChildren	bool abX
void	SetDefault	bool abX
void	SetDefaultFontColor	const cColor &in aColor
void	SetDefaultFontSize	const cVector2f &in avSize
void	SetDefaultFontType	iFontData@ apFont
void	SetEnabled	bool abX
void	SetFocusNavigation	eUIArrow aDir, iWidget@ apWidget
void	SetGlobalKeyPressListener	bool abX
void	SetGlobalPosition	const cVector3f &in avPos
void	SetGlobalUIInputListener	bool abX
void	SetName	const tString &in asName
void	SetPosition	const cVector3f &in avPos
void	SetScrollAmount	const cVector3f &in avX
void	SetSize	const cVector2f &in avSize
void	SetText	const tWString &in asText
void	SetToolTip	const tWString &in asToolTip
void	SetToolTipEnabled	bool abX
void	SetUserValue	int alX
void	SetVisible	bool abX
void	Update	float afTimeStep

References

• HPL3/SOMA/Scripting/cGuiSet ‎ (← links)
• HPL3/SOMA/Scripting/cWidgetContextMenu ‎ (← links)
• HPL3/SOMA/Scripting/cWidgetMainMenu ‎ (← links)
• HPL3/SOMA/Scripting/iWidgetMenu ‎ (← links)

See all references...