Elaztek Developer Hub
Blamite Game Engine - Keystone  00390.07.02.23.1947.blamite
A library that enables the use of Qt in Blamite's editing tools.
PluginFieldPropertiesDialog Class Reference

Dialog allowing the user to edit specific properties of a plugin field directly within the tag designer. More...

#include <PluginFieldPropertiesDialog.h>

+ Inheritance diagram for PluginFieldPropertiesDialog:
+ Collaboration diagram for PluginFieldPropertiesDialog:

Public Member Functions

 PluginFieldPropertiesDialog (BlamPluginField *_field, QWidget *parent=Q_NULLPTR)
 
 ~PluginFieldPropertiesDialog ()
 
bool IsCancelled ()
 Checks whether the dialog was cancelled. More...
 

Detailed Description

Dialog allowing the user to edit specific properties of a plugin field directly within the tag designer.

This dialog also allows the user to edit advanced properties of a field that are not present within the visual editor by default, such as visibility, ID, and description.

Constructor & Destructor Documentation

◆ PluginFieldPropertiesDialog()

PluginFieldPropertiesDialog::PluginFieldPropertiesDialog ( BlamPluginField *  _field,
QWidget *  parent = Q_NULLPTR 
)

◆ ~PluginFieldPropertiesDialog()

PluginFieldPropertiesDialog::~PluginFieldPropertiesDialog ( )

Member Function Documentation

◆ IsCancelled()

bool PluginFieldPropertiesDialog::IsCancelled ( )

Checks whether the dialog was cancelled.

If the user closes the dialog using the Cancel button, no modifications will be made to the plugin field. This dialog directly modifies the field, and so this data does not need to be modified externally. This generally will indicate whether the UI within the designer needs to be updated or not - as if the field was changed, then the designer UI should update to reflect that.

Returns
true if the edit action(s) were cancelled, otherwise returns false. If this returns false, then any UI update actions required should be performed - as the field. will have been modified.

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