Menu Item. More...

#include <fbcontrols.h>

Inheritance diagram for FBMenuItem:

[legend]

Public Member Functions
	FBMenuItem ()
	Constructor. More...

void	Set (FBMenuItemType pType, const char pExtension, const char pLabel, const char *pDescription)
	Initialization function. More...

bool	IsActive ()
	Is menu item active? More...

void	Activate (bool pState=true)
	Activate menu item. More...

virtual void	OnItemSelectEvent (HIRegister pSender, HKEvent pEvent)
	Internal callback function for activated menu item. More...

virtual bool	Execute (const char *pFilename=NULL)=0
	The callback function for when the menu item is selected. More...

Public Member Functions inherited from FBVisualComponent
	FBVisualComponent (HIObject pObject)
	Constructor. More...

	IObject_Declare (override)

	ICallback_Declare (override)

virtual HIKtView	GetKtView ()
	Get internal toolkit object. More...

QWidget *	GetQWidgetAddress ()
	Get internal QWidget. More...

virtual bool	AddChild (FBVisualComponent *pChild, int pId=0)
	Add a child component. More...

virtual FBVisualComponent *	GetChild (int pId=0)
	Get a child component. More...

virtual void	Refresh (bool pNow=false)
	Refresh component. More...

virtual void	ViewExpose ()
	Exposed view callback function. More...

virtual void	ViewInput (int pMouseX, int pMouseY, FBInputType pAction, int pButtonKey, int pModifier)
	Input callback function. More...

virtual bool	IsView ()
	Is component a view? More...

Public Member Functions inherited from FBComponent
	FBComponent (HIObject pObject)
	Constructor. More...

virtual	~FBComponent ()
	Destructor. More...

virtual bool	FBCreate ()
	Open Reality Creation function. More...

virtual void	FBDestroy ()
	Open Reality destruction function. More...

virtual void	FBDelete () override
	Open Reality deletion function. More...

virtual bool	SetHIObject (HIObject pObject, bool pSDKComponent) override
	Assign component to an internal pointer. More...

virtual int	PropertyAdd (FBProperty *pProperty)
	Add a property to the component's property manager. More...

bool	PropertyAddReferenceProperty (FBProperty *pReferenceProperty)
	Add a reference property to the component's property manager. More...

void	PropertyRemove (FBProperty *pProperty)
	Remove a Property from the component's Property manager. More...

void	PropertyGetModifiedList (FBArrayTemplate< FBProperty * > &pPropList, FBPlugModificationFlag pModificationFlags)
	Get list of properties which have been modified since last loading. More...

FBProperty *	PropertyCreate (const char pName, FBPropertyType pType, const char pDataType, bool pAnimatable, bool pIsUser=false, FBProperty *pReferenceSource=NULL)
	Create user or dynamic property. More...

FBObjectFlag	GetObjectFlags ()
	Get all Object Flags (concatenated). More...

void	SetObjectFlags (FBObjectFlag pFlags)
	SetObjectFlags. More...

bool	HasObjectFlags (FBObjectFlag pFlags)
	Check whether a specific object flag is enabled. More...

void	EnableObjectFlags (FBObjectFlag pFlags)
	Enable a specific Object Flags. More...

void	DisableObjectFlags (FBObjectFlag pFlags)
	Disable a specific Object Flags. More...

void	SetObjectStatus (FBObjectStatus pStatus, bool pValue)
	Enable/Disable a specific Object Status. More...

bool	GetObjectStatus (FBObjectStatus pStatus)
	Check to see if an object status is enabled. More...

bool	ProcessNamespaceHierarchy (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessNamespaceHierarchy. More...

bool	ProcessObjectNamespace (FBNamespaceAction pNamespaceAction, const char pNamespaceName, const char pReplaceTo=NULL, bool pAddRight=true)
	ProcessObjectNamespace. More...

virtual const char *	ClassName () override
	Get the class name. More...

virtual bool	UseCustomPropertyViewSet () const
	Use the custom property viewSet or not. More...

const char *	GetFullName (void)
	Get the full name. More...

void	SetOwnerNamespace (FBNamespace *pOwnerNSObj)
	Set the owner Namespace object. More...

FBNamespace *	GetOwnerNamespace (void)
	Get the owner Namespace object. More...

FBFileReference *	GetOwnerFileReference (void)
	Get the owner FileReference object. More...

void	HardSelect ()
	HardSelect. More...

virtual bool	Is (int pTypeId) override
	Returns true if object is of type TypeId. More...

virtual int	GetTypeId () override
	GetTypeId( int pTypeId ) More...

Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject. More...

void	AddWrapper (FBScriptWrapper *)

void	RemoveWrapper (FBScriptWrapper *)

Public Attributes
FBPropertyComponent	Component
	Read Write Property: Component handle. More...

FBPropertyString	Extension
	Read Write Property: Default extension. More...

FBPropertyString	Label
	Read Write Property: Label of the menu item. More...

FBPropertyString	Description
	Read Write Property: Description of the menu item. More...

FBPropertyMenuItemType	Type
	Read Write Property: Type of menu item. More...

FBPropertyString	Path
	Read Write Property: Default path to open file dialog to. More...

Public Attributes inherited from FBVisualComponent
struct FBVisualComponent::__Region	Region

struct K_DLLEXPORT FBVisualComponent::__Border	Border

FBPropertyString	Caption
	Property: Widget caption. More...

FBPropertyBool	Visible
	Read Write Property: Is visual component visible? More...

FBPropertyBool	ReadOnly
	Read Write Property: Is visual component read only? More...

FBPropertyBool	Enabled
	Read Write Property: Is visual enabled? More...

FBPropertyString	Hint
	Read Write Property: Hint to show. More...

FBPropertyInt	Left
	Read Write Property: Left coordinate. More...

FBPropertyInt	Top
	Read Write Property: Top coordinate. More...

FBPropertyInt	Width
	Read Write Property: Width. More...

FBPropertyInt	Height
	Read Write Property: Height. More...

FBPropertyEvent	OnEnter
	Event: On mouse enter. More...

FBPropertyEvent	OnExit
	Event: On mouse exit. More...

Public Attributes inherited from FBComponent
FBPropertyManager	PropertyList
	Read Only Property: Manages all of the properties for the component. More...

FBPropertyListComponent	Components
	List: List of components. More...

FBPropertyListComponent	Parents
	List: Parents. More...

FBPropertyBool	Selected
	Read Write Property: Selected property. More...

FBPropertyString	Name
	Read Write Property: Unique name of object. More...

FBPropertyString	LongName
	Read Write Property: Name and namespace for object. More...

FBPropertyFolder	Folder
	Read Write Property: The folder that contain this component. More...

Additional Inherited Members
Static Public Member Functions inherited from FBComponent
static int	GetInternalClassId ()

static void	FBComponentSetName (FBComponent pObject, const char pName)

static const char *	FBComponentGetName (FBComponent *pObject)

static void	FBComponentSetLongName (FBComponent pObject, const char pName)

static const char *	FBComponentGetLongName (FBComponent *pObject)

Static Public Attributes inherited from FBComponent
static int	TypeInfo
	Contains the Type information of the object. More...

Protected Member Functions inherited from FBVisualComponent
virtual HIKtObject	GetHIKtObject ()
	Get internal toolkit object. More...

Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component. More...

bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...

bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...

bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection. More...

bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection. More...

void	DisconnectAllSrc ()
	Remove all source connections. More...

void	DisconnectAllDst ()
	Remove all destination connections. More...

bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index. More...

bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index. More...

bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index. More...

bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index. More...

bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B. More...

bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex. More...

bool	MoveSrcAt (FBPlug pSrc, FBPlug pAtSrc)
	Move source connection pSrc to the position of pAtSrc. More...

int	GetSrcCount ()
	Get source connection count. More...

FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index. More...

FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index. More...

int	GetDstCount ()
	Get destination connection count. More...

FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index. More...

FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index. More...

bool	BeginChange ()
	Begins a change on multiple plugs. More...

void	EndChange ()
	Ends a change on multiple plugs. More...

void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag. More...

bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed. More...

void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag. More...

bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed. More...

int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List. More...

bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status. More...

void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag. More...

bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed. More...

FBPlug *	GetOwner ()
	Get the owner of this plug. More...

FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index. More...

int	GetOwnedCount ()
	Get the owned plug count. More...

virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...

virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug pThis, void pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...

virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug pThis, int pIndex, FBPlug pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...

Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id. More...

Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component. More...

HIObject	mObject
	Handle on the Plug. More...

bool	mSDKComponent
	bool Plug is an SDK component. More...

Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object. More...

static int	TypeInfo
	TypeInfo. More...

static int	mGlobalTypeInfo
	Represente the Type Index. More...

Detailed Description

Menu Item.

Definition at line 696 of file fbcontrols.h.

Constructor & Destructor Documentation

◆ FBMenuItem()

FBMenuItem ( )

Constructor.

Member Function Documentation

◆ Activate()

void Activate ( bool pState = true )

Activate menu item.

This will register the callback functions for the menu item, as well as make the item itself appear in the menu. Once activated, you have no more control over the menu item, seeing as it will be registered and cannot be activated twice. This function should be the last one you call when activating the menu item.

Parameters

pState Activate if true (default = true).

◆ Execute()

virtual bool Execute ( const char * pFilename = NULL )

pure virtual

The callback function for when the menu item is selected.

In order to use this class correctly, you must create a class that inherits directly from this class, overloading this virtual function. This function will then be called when the menu item is selected.

Parameters

pFilename Filename from popup (default = NULL).

Returns: Operation was successful (true or false).

◆ IsActive()

bool IsActive ( )

Is menu item active?

Returns: true if menu item has been registered (activated).

◆ OnItemSelectEvent()

virtual void OnItemSelectEvent	(	HIRegister	pSender,
		HKEvent	pEvent
	)

virtual

Internal callback function for activated menu item.

Registers internally the menu item.

Parameters

pSender	Sending register.
pEvent	Event being sent.

◆ Set()

void Set	(	FBMenuItemType	pType,
		const char *	pExtension,
		const char *	pLabel,
		const char *	pDescription
	)

Initialization function.

Parameters

pType	Type of menu item to be set.
pExtension	File extension to use as filter for popup.
pLabel	Short description of file format (usually one word identifier)
pDescription	Long description of file format

Member Data Documentation

◆ Component

FBPropertyComponent Component

Read Write Property: Component handle.

Definition at line 734 of file fbcontrols.h.

◆ Description

FBPropertyString Description

Read Write Property: Description of the menu item.

Definition at line 737 of file fbcontrols.h.

◆ Extension

FBPropertyString Extension

Read Write Property: Default extension.

Definition at line 735 of file fbcontrols.h.

◆ Label

FBPropertyString Label

Read Write Property: Label of the menu item.

Definition at line 736 of file fbcontrols.h.

◆ Path

FBPropertyString Path

Read Write Property: Default path to open file dialog to.

Definition at line 740 of file fbcontrols.h.

◆ Type

FBPropertyMenuItemType Type

Read Write Property: Type of menu item.

Definition at line 738 of file fbcontrols.h.

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

fbcontrols.h

Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FBMenuItem()

Member Function Documentation

◆ Activate()

◆ Execute()

◆ IsActive()

◆ OnItemSelectEvent()

◆ Set()

Member Data Documentation

◆ Component

◆ Description

◆ Extension

◆ Label

◆ Path

◆ Type