ui_comment_field Class Reference

A comment field control. More...

#include <comment.h>

Inheritance diagram for ui_comment_field:

Collaboration diagram for ui_comment_field:

Public Member Functions
	ui_comment_field (QString title, QString explanation, QWidget *parent=Q_NULLPTR)
	ui_comment_field (QString title, QString explanation, BlamCommentType comment_type, QWidget *parent=Q_NULLPTR)
	ui_comment_field (BlamTagField *_field, BlamEditorDocument_Tag *_document, QWidget *parent=Q_NULLPTR)
	ui_comment_field (BlamPluginField_Comment *_template, BlamEditorDocument_Tag *_document, QWidget *parent=Q_NULLPTR)
	~ui_comment_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...
void	SetDesignExplanationEditState (bool edit_state, bool save_changes=true)
void	SetupUI () override
	Configures the UI for the current field. More...
Public Member Functions inherited from BlamEditorTagFieldControl
	BlamEditorTagFieldControl (QWidget *parent=Q_NULLPTR)

Additional Inherited Members
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...

Detailed Description

A comment field control.

Comments are used to display useful information within a tag layout.

Constructor & Destructor Documentation

ui_comment_field() [1/4]

ui_comment_field::ui_comment_field	(	QString	title,
		QString	explanation,
		QWidget *	parent = Q_NULLPTR
	)

Here is the call graph for this function:

ui_comment_field() [2/4]

ui_comment_field::ui_comment_field	(	QString	title,
		QString	explanation,
		BlamCommentType	comment_type,
		QWidget *	parent = Q_NULLPTR
	)

Here is the call graph for this function:

ui_comment_field() [3/4]

ui_comment_field::ui_comment_field	(	BlamTagField *	_field,
		BlamEditorDocument_Tag *	_document,
		QWidget *	parent = Q_NULLPTR
	)

Here is the call graph for this function:

ui_comment_field() [4/4]

ui_comment_field::ui_comment_field	(	BlamPluginField_Comment *	_template,
		BlamEditorDocument_Tag *	_document,
		QWidget *	parent = Q_NULLPTR
	)

Here is the call graph for this function:

~ui_comment_field()

ui_comment_field::~ui_comment_field

(

)

Member Function Documentation

eventFilter()

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

Here is the call graph for this function:

SetDesignExplanationEditState()

void ui_comment_field::SetDesignExplanationEditState	(	bool	edit_state,
		bool	save_changes = true
	)

Here is the call graph for this function:

Here is the caller graph for this function:

SetDesignModeActive()

void ui_comment_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_comment_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 call graph for this function:

Here is the caller graph for this function:

SetupUI()

void ui_comment_field::SetupUI ( )

overridevirtual

Configures the UI for the current field.

This will rebuild the control from its original data, identical to what happens when a control is first created. This is ideal in cases where the original field has been updated externally and needs to have its changes reflected in the UI, such as the tag designer.

Parameters

resetting

- Whether or not the widget is resetting after being initialized. If true, some additional operations may be performed to clear any existing data.

Reimplemented from BlamEditorTagFieldControl.

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• keystone/components/ui/shared/controls/tag_fields/comment/comment.h
• keystone/components/ui/shared/controls/tag_fields/comment/comment.cpp