sf::LayoutData Class Reference

#include <LayoutData.h>

Inheritance diagram for sf::LayoutData:

Collaboration diagram for sf::LayoutData:

Public Member Functions
	LayoutData (QObject *parent=nullptr)
	Constructor as QWidget.
virtual void	openPropertyEditor (QObject *target)
	Opens a property editor dialog for the given target in a derived class. The returned pointer can be used to execute the dialog in modal mode.
virtual void	popupContextMenu (QObject *target, const QPoint &pos)
	Executes a popup from .
void	setReadOnly (bool)
	Property 'converted' set method.
bool	getReadOnly () const
	Property 'converted' get method.
virtual QDir	getDirectory () const
	Gets the directory of the loaded layout file.
void	setDirectory (const QDir &directory)
	Gets the directory of the loaded layout file. Only has effect when getDirectory() is not overridden.
gii::IdType	getIdOffset () const
	Gets the id offset for all Gii widgets. Only applied when a layout is loaded.
void	setIdOffset (gii::IdType idOffset) const
	Sets id offset for all Gii widgets. Only applied when a layout is loaded.

Static Public Member Functions
static LayoutData *	from (QObject *target)
	Gets the layout widget instance for the passed target if any.
static bool	hasMenuModifiers (Qt::KeyboardModifiers modifiers)
	Returns true when the modifier are met for the context menu to popup.
static QString	getFileSuffix ()
	Gets suffix used for layout files.

Detailed Description

Base class for loading Widgets from an ui-file when used in an editor for example.

Constructor & Destructor Documentation

LayoutData()

sf::LayoutData::LayoutData ( QObject *  parent = nullptr )

explicit

Constructor as QWidget.

Member Function Documentation

from()

static LayoutData * sf::LayoutData::from ( QObject *  target )

static

Gets the layout widget instance for the passed target if any.

Parameters

target

Target object in the layout.

Returns

On not found it returns a nullptr.

getDirectory()

virtual QDir sf::LayoutData::getDirectory ( ) const

virtual

Gets the directory of the loaded layout file.

getFileSuffix()

static QString sf::LayoutData::getFileSuffix ( )

static

Gets suffix used for layout files.

getIdOffset()

gii::IdType sf::LayoutData::getIdOffset

(

)

const

Gets the id offset for all Gii widgets. Only applied when a layout is loaded.

getReadOnly()

bool sf::LayoutData::getReadOnly

(

)

const

Property 'converted' get method.

hasMenuModifiers()

static bool sf::LayoutData::hasMenuModifiers ( Qt::KeyboardModifiers  modifiers )

static

Returns true when the modifier are met for the context menu to popup.

openPropertyEditor()

virtual void sf::LayoutData::openPropertyEditor ( QObject *  target )

virtual

Opens a property editor dialog for the given target in a derived class. The returned pointer can be used to execute the dialog in modal mode.

Parameters

target

Object targeted in the editor.

popupContextMenu()

virtual void sf::LayoutData::popupContextMenu ( QObject *  target, const QPoint &  pos  )

virtual

Executes a popup from .

Parameters

target	Object targeted in the editor.
pos	Global position to pop up the menu.

setDirectory()

void sf::LayoutData::setDirectory

(

const QDir &

directory

)

Gets the directory of the loaded layout file. Only has effect when getDirectory() is not overridden.

setIdOffset()

void sf::LayoutData::setIdOffset

(

gii::IdType

idOffset

)

const

Sets id offset for all Gii widgets. Only applied when a layout is loaded.

setReadOnly()

void sf::LayoutData::setReadOnly

(

bool

)

Property 'converted' set method.

---

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

• LayoutData.h