Ocular Engine
Ocular::Editor::FileProperty Class Reference

#include <FileProperty.hpp>

Inheritance diagram for Ocular::Editor::FileProperty:
Ocular::Editor::PropertyWidget

Public Member Functions

 FileProperty (QWidget *parent=nullptr)
 
virtual bool updateProperties () override
 
virtual void setValue (void *value, uint32_t size=0) override
 
virtual std::string getValue () const override
 
- Public Member Functions inherited from Ocular::Editor::PropertyWidget
 PropertyWidget (std::string const &type, QWidget *parent=nullptr)
 
virtual QSize sizeHint () const override
 
std::string getType () const
 
void setVariable (Core::ExposedVariable &variable)
 
void setDisplayName (std::string const &name)
 
std::string const & getDisplayName () const
 
std::string const & getVariableName () const
 
void addWidgetLeftSide (QWidget *widget)
 
void addWidgetRightSide (QWidget *widget)
 

Additional Inherited Members

- Protected Attributes inherited from Ocular::Editor::PropertyWidget
QHBoxLayout * m_LayoutRight
 Layout for the right-side frame.
 
Core::ExposedVariable m_Variable
 The variable this widget is responsible for displaying and modifying.
 

Detailed Description

Pre-built property display for Core::File variables.

Member Function Documentation

std::string Ocular::Editor::FileProperty::getValue ( ) const
overridevirtual
Returns
Value as a std::string

Reimplemented from Ocular::Editor::PropertyWidget.

void Ocular::Editor::FileProperty::setValue ( void *  value,
uint32_t  size = 0 
)
overridevirtual
Parameters
[in]valueExpects a std::string with the file path.
[in]sizeUnused in this implementation

Reimplemented from Ocular::Editor::PropertyWidget.

bool Ocular::Editor::FileProperty::updateProperties ( )
overridevirtual

Update method that is called up to once a frame so that changes to the tracked variable may be checked for, and displayed.

Returns
Should return TRUE if a property was modified by the user; otherwise return FALSE.

Reimplemented from Ocular::Editor::PropertyWidget.


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