ui_ascii_field Class Reference

An ascii input field. More...

#include <ascii.h>

Inheritance diagram for ui_ascii_field:

Collaboration diagram for ui_ascii_field:

Public Member Functions
	ui_ascii_field (BlamTagField_Ascii *_field, BlamEditorDocument_Tag *_document)
	Initializes a new Ascii field. More...
	ui_ascii_field (BlamPluginField *_template, BlamEditorDocument_Tag *_document)
	Initializes a new Ascii field template. More...
	~ui_ascii_field ()
void	SetupUI () override
	Configures the UI for the current field. More...
Public Member Functions inherited from ui_generic_field
	ui_generic_field (BlamTagField *_field, BlamEditorDocument_Tag *_document, QWidget *parent=Q_NULLPTR)
	ui_generic_field (BlamPluginField *_template, BlamEditorDocument_Tag *_document)
	~ui_generic_field ()
bool	eventFilter (QObject *object, QEvent *event) override
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	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 ui_generic_field
BlamTagField *	field = nullptr
	The field associated with this control. More...
BlamPluginField *	template_field = nullptr
	The plugin field associated with this control. More...
bool	is_template = false
	Whether or not this field is displaying as a template. 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...
Protected Attributes inherited from ui_generic_field
Ui::basic_tag_field	ui

Detailed Description

An ascii input field.

Ascii fields contain a string of text directly within a tag. When referencing strings within the game engine string table or from a unic tag, a StringId field should be used instead.

Todo:

Make UI more in-line with H2Guerilla.

Constructor & Destructor Documentation

ui_ascii_field() [1/2]

ui_ascii_field::ui_ascii_field	(	BlamTagField_Ascii *	_field,
		BlamEditorDocument_Tag *	_document
	)

Initializes a new Ascii field.

Parameters

_field

- The ascii tag field this UI is to be associated with.

Here is the call graph for this function:

ui_ascii_field() [2/2]

ui_ascii_field::ui_ascii_field	(	BlamPluginField *	_template,
		BlamEditorDocument_Tag *	_document
	)

Initializes a new Ascii field template.

Parameters

_template

- The plugin field that this UI is representing.

Here is the call graph for this function:

~ui_ascii_field()

ui_ascii_field::~ui_ascii_field

(

)

Member Function Documentation

SetupUI()

void ui_ascii_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 caller graph for this function:

---

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

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