cocos2d-x  3.5
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
LayoutParameter Class Reference

Base class for various LayoutParameter. More...

#include <UILayoutParameter.h>

Inheritance diagram for LayoutParameter:
Ref LinearLayoutParameter RelativeLayoutParameter

Public Types

enum  Type { NONE = 0, LINEAR, RELATIVE }
 Layout parameter type. More...
 

Public Member Functions

 LayoutParameter ()
 Default constructor. More...
 
virtual ~LayoutParameter ()
 Default destructor. More...
 
void setMargin (const Margin &margin)
 Set margin parameter for LayoutParameter. More...
 
const MargingetMargin () const
 Gets margin parameter of LayoutParameter. More...
 
Type getLayoutType () const
 Gets LayoutParameterType of LayoutParameter. More...
 
LayoutParameterclone ()
 Create a copy of original LayoutParameter. More...
 
virtual LayoutParametercreateCloneInstance ()
 Create a cloned instance of LayoutParameter. More...
 
virtual void copyProperties (LayoutParameter *model)
 Copy all the member field from argument LayoutParameter to self. More...
 
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Refautorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()
 Destructor. More...
 

Static Public Member Functions

static LayoutParametercreate ()
 Create a empty LayoutParameter. More...
 

Protected Attributes

Margin _margin
Type _layoutParameterType
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 
local _referenceCount
 count of references More...
 

Additional Inherited Members

- Protected Member Functions inherited from Ref
 Ref ()
 Constructor. More...
 
 Ref ()
 Constructor. More...
 

Detailed Description

Base class for various LayoutParameter.

Constructor & Destructor Documentation

LayoutParameter ( )
inline

Default constructor.

virtual ~LayoutParameter ( )
inlinevirtual

Default destructor.

Member Function Documentation

LayoutParameter* clone ( )

Create a copy of original LayoutParameter.

Returns
A LayoutParameter pointer.
virtual void copyProperties ( LayoutParameter model)
virtual

Copy all the member field from argument LayoutParameter to self.

Parameters
modelA LayoutParameter instance.

Reimplemented in RelativeLayoutParameter, and LinearLayoutParameter.

static LayoutParameter* create ( )
static

Create a empty LayoutParameter.

Returns
A autorelease LayoutParameter instance.
virtual LayoutParameter*
createCloneInstance
( )
virtual

Create a cloned instance of LayoutParameter.

Returns
A LayoutParameter pointer.

Reimplemented in RelativeLayoutParameter, and LinearLayoutParameter.

Type getLayoutType ( ) const

Gets LayoutParameterType of LayoutParameter.

See also
LayoutParameterType.
Returns
LayoutParameterType
const Margin& getMargin ( ) const

Gets margin parameter of LayoutParameter.

See also
Margin
Returns
Margin of layout parameter.
void setMargin ( const Margin margin)

Set margin parameter for LayoutParameter.

See also
Margin
Parameters
margin

Member Data Documentation

Type _layoutParameterType
protected
Margin _margin
protected

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