LinkBoxGui Class Reference

#include <customgui_linkbox.h>

Inheritance diagram for LinkBoxGui:

Detailed Description

Link box custom GUI (CUSTOMGUI_LINKBOX) for the BaseLink data.
Here are the settings: LINKBOX_CUSTOMGUISETTINGS
The following is sent with the MSG_DESCRIPTION_CHECKDRAGANDDROP parent message: (Normally packed into a DescriptionCheckDragAndDrop structure.)
LINKBOX_ACCEPT_MESSAGE

Public Member Functions
BaseList2D *	GetLink (const BaseDocument *doc)
Bool	SetLink (const BaseList2D *obj)
BaseList2D *	GetLink (const BaseDocument *doc, Int32 instance)
Public Member Functions inherited from BaseCustomGui< 1009415 >
Int32	GetWidth ()
Int32	GetHeight ()
void	Redraw ()
Bool	LayoutChanged ()
Bool	Activate ()
Bool	SetDefaultForResEdit ()
Bool	SetData (const TriState< GeData > &tristate)
TriState< GeData >	GetData ()
void	SetLayoutMode (Int32 mode)
Int32	GetLayoutMode ()
Bool	SupportLayoutSwitch ()
Public Member Functions inherited from _BaseCustomGui
Int32	GetWidth (Int32 plugid)
Int32	GetHeight (Int32 plugid)
void	Redraw (Int32 plugid)
Bool	LayoutChanged (Int32 plugid)
Bool	Activate (Int32 plugid)
Bool	SetDefaultForResEdit (Int32 plugid)
Bool	SetData (Int32 plugid, const TriState< GeData > &tristate)
TriState< GeData >	GetData (Int32 plugid)
void	SetLayoutMode (Int32 plugid, Int32 mode)
Int32	GetLayoutMode (Int32 plugid)
Bool	SupportLayoutSwitch (Int32 plugid)

Private Member Functions
	LinkBoxGui ()
	~LinkBoxGui ()

Additional Inherited Members
Static Public Attributes inherited from BaseCustomGui< 1009415 >
static constexpr Int32	VALUE

Constructor & Destructor Documentation

LinkBoxGui()

LinkBoxGui ( )

private

~LinkBoxGui()

~LinkBoxGui ( )

private

Member Function Documentation

GetLink() [1/2]

BaseList2D* GetLink

(

const BaseDocument *

doc

)

Evaluates the link in the specified document.

Parameters

[in]

doc

The document to evaluate the link in. The caller owns the pointed document.

Returns

The linked object, or nullptr if the link is broken. The document owns the pointed object.

SetLink()

Bool SetLink

(

const BaseList2D *

obj

)

Sets the link to point to obj.

Parameters

[in]

obj

The object to link to. The caller owns the pointed object.

Returns

true if successful, otherwise false.

GetLink() [2/2]

BaseList2D* GetLink	(	const BaseDocument *	doc,
		Int32	instance
	)

Evaluates the link in doc, returning nullptr if the linked object is not an instance of instance.

Parameters

[in]	doc	The document to evaluate the link in. The caller owns the pointed document.
[in]	instance	The type to check.

Returns

The linked object, or nullptr if the link is broken or of the wrong type. The document owns the pointed object.