RelativeLayoutParameter Class Reference

Relative layout parameter. More...

#include <UILayoutParameter.h>

Inherits LayoutParameter.

Public Types
enum class	RelativeAlign
	Relative Alignment type.
Public Types inherited from LayoutParameter
enum class	Type
	Layout parameter type. More...

Public Member Functions
	RelativeLayoutParameter ()
	Default constructor.
virtual	~RelativeLayoutParameter ()
	Default destructor.
void	setAlign (RelativeAlign align)
	Sets RelativeAlign parameter for LayoutParameter.
RelativeAlign	getAlign () const
	Get RelativeAlign parameter for LayoutParameter.
void	setRelativeToWidgetName (std::string_view name)
	Set widget name your widget want to relative to.
std::string_view	getRelativeToWidgetName () const
	Get the relative widget name.
void	setRelativeName (std::string_view name)
	Set a name for LayoutParameter in Relative Layout.
std::string_view	getRelativeName () const
	Get a name of LayoutParameter in Relative Layout.
virtual LayoutParameter *	createCloneInstance () override
	Create a cloned instance of LayoutParameter.
virtual void	copyProperties (LayoutParameter *model) override
	Copy all the member field from argument LayoutParameter to self.
Public Member Functions inherited from LayoutParameter
	LayoutParameter ()
	Default constructor.
virtual	~LayoutParameter ()
	Default destructor.
void	setMargin (const Margin &margin)
	Set margin parameter for LayoutParameter.
const Margin &	getMargin () const
	Gets margin parameter of LayoutParameter.
Type	getLayoutType () const
	Gets LayoutParameterType of LayoutParameter.
LayoutParameter *	clone ()
	Create a copy of original LayoutParameter.
Public Member Functions inherited from Object
void	retain ()
	Retains the ownership.
void	release ()
	Releases the ownership immediately.
Object *	autorelease ()
	Releases the ownership sometime soon automatically.
unsigned int	getReferenceCount () const
	Returns the Object's current reference count.
virtual	~Object ()
	Destructor.

Static Public Member Functions
static RelativeLayoutParameter *	create ()
	Create a RelativeLayoutParameter instance.
Static Public Member Functions inherited from LayoutParameter
static LayoutParameter *	create ()
	Create a empty LayoutParameter.

Additional Inherited Members
Public Attributes inherited from Object
unsigned int	_ID
	object id, ScriptSupport need public _ID
int	_luaID
	Lua reference id.

Detailed Description

Relative layout parameter.

It is mainly used by RelativeLayoutManager.

Constructor & Destructor Documentation

RelativeLayoutParameter()

RelativeLayoutParameter ( )

inline

Default constructor.

@lua new

~RelativeLayoutParameter()

virtual ~RelativeLayoutParameter ( )

inlinevirtual

Default destructor.

@lua NA

Member Function Documentation

create()

static RelativeLayoutParameter * create ( )

static

Create a RelativeLayoutParameter instance.

Returns

A initialized LayoutParameter which is marked as "autorelease".

setAlign()

void setAlign

(

RelativeAlign

align

)

Sets RelativeAlign parameter for LayoutParameter.

See also

RelativeAlign

Parameters

align

Relative align in RelativeAlign.

getAlign()

RelativeAlign getAlign

(

)

const

Get RelativeAlign parameter for LayoutParameter.

See also

RelativeAlign

Returns

A RelativeAlign variable.

setRelativeToWidgetName()

void setRelativeToWidgetName

(

std::string_view

name

)

Set widget name your widget want to relative to.

Parameters

name	Relative widget name.

getRelativeToWidgetName()

std::string_view getRelativeToWidgetName

(

)

const

Get the relative widget name.

Returns

name A relative widget name in string.

setRelativeName()

void setRelativeName

(

std::string_view

name

)

Set a name for LayoutParameter in Relative Layout.

Parameters

name	A string name.

getRelativeName()

std::string_view getRelativeName

(

)

const

Get a name of LayoutParameter in Relative Layout.

Returns

name Relative name in string.

createCloneInstance()

virtual LayoutParameter * createCloneInstance ( )

overridevirtual

Create a cloned instance of LayoutParameter.

Returns

A LayoutParameter pointer.

Reimplemented from LayoutParameter.

copyProperties()

virtual void copyProperties ( LayoutParameter * model )

overridevirtual

Copy all the member field from argument LayoutParameter to self.

Parameters

model

A LayoutParameter instance.

Reimplemented from LayoutParameter.

---

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

• UILayoutParameter.h