#include <tagref.h>

Inheritance diagram for ui_tagref_field:

Collaboration diagram for ui_tagref_field:

Public Member Functions
BlamTagTreeNode *	GetReferencedTagNode ()

BlamPlugin *	GetSelectedClass ()

	ui_tagref_field (BlamTagField_Tagref _field, BlamEditorDocument_Tag _document, QWidget *parent=Q_NULLPTR)

	ui_tagref_field (BlamPluginField_Tagref _template, BlamEditorDocument_Tag _document)

	~ui_tagref_field ()

bool	eventFilter (QObject object, QEvent event)

void	SetDesignModeActive (drag_list _drag_list, tag_designer _designer) override
	Instructs the field to be editable as a designer field. More...

void	SetDesignNameEditState (bool edit_state, bool save_changes=true) override
	Enables or disables the label edit field for the current field. More...

Public Member Functions inherited from BlamEditorTagFieldControl
	BlamEditorTagFieldControl (QWidget *parent=Q_NULLPTR)

virtual void	SetupUI ()
	Configures the UI for the current field. More...

Public Attributes
BlamTagField_Tagref *	field = nullptr
	The field associated with this control. More...

Public Attributes inherited from BlamEditorTagFieldControl
BlamTagField *	field = nullptr
	The field associated with this control. More...

BlamEditorDocument_Tag *	document = nullptr
	The document this field belongs to. More...

bool	design_mode = false
	Whether or not this field is currently in design mode. More...

drag_list *	drag_drop_list = nullptr
	The active drag list that owns this control. Only used when `design_mode` is enabled. More...

tag_designer *	designer = nullptr
	The active tag designer that owns this control. Only used when `design_mode` is enabled. More...

Constructor & Destructor Documentation

◆ ui_tagref_field() [1/2]

ui_tagref_field::ui_tagref_field	(	BlamTagField_Tagref *	_field,
		BlamEditorDocument_Tag *	_document,
		QWidget *	parent = `Q_NULLPTR`
	)

◆ ui_tagref_field() [2/2]

ui_tagref_field::ui_tagref_field	(	BlamPluginField_Tagref *	_template,
		BlamEditorDocument_Tag *	_document
	)

◆ ~ui_tagref_field()

ui_tagref_field::~ui_tagref_field ( )

Member Function Documentation

◆ eventFilter()

bool ui_tagref_field::eventFilter	(	QObject *	object,
		QEvent *	event
	)

Here is the call graph for this function:

◆ GetReferencedTagNode()

BlamTagTreeNode * ui_tagref_field::GetReferencedTagNode ( )

◆ GetSelectedClass()

BlamPlugin * ui_tagref_field::GetSelectedClass ( )

Here is the caller graph for this function:

◆ SetDesignModeActive()

void ui_tagref_field::SetDesignModeActive	(	drag_list *	_drag_list,
		tag_designer *	_designer
	)

overridevirtual

Instructs the field to be editable as a designer field.

This slightly tweaks how the field is displayed, and provides additional functionality to allow the field to be altered within the Tag Designer.

Once design mode is activated, it cannot be deactivated.

Reimplemented from BlamEditorTagFieldControl.

◆ SetDesignNameEditState()

void ui_tagref_field::SetDesignNameEditState	(	bool	edit_state,
		bool	save_changes = `true`
	)

overridevirtual

Enables or disables the label edit field for the current field.

When enabled, this will replace the field display label with a text input, allowing the user to rename the field. When disabled, this will hide the edit field and optionally save any changes made.

This only has any effect when design mode is enabled.

Parameters

edit_state	- Whether or not the edit field should be enabled.
save_changes	- Whether or not any changes from the text input should be saved. Defaults to `true`.

Reimplemented from BlamEditorTagFieldControl.

Here is the caller graph for this function:

Member Data Documentation

◆ field

BlamTagField_Tagref* ui_tagref_field::field = nullptr

The field associated with this control.

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

keystone/components/ui/shared/controls/tag_fields/tagref/tagref.h
keystone/components/ui/shared/controls/tag_fields/tagref/tagref.cpp

Public Member Functions

Public Attributes