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

#include <UILayoutParameter.h>

Inheritance diagram for RelativeLayoutParameter:
LayoutParameter Ref

Public Types

enum  RelativeAlign {
  NONE, PARENT_TOP_LEFT, PARENT_TOP_CENTER_HORIZONTAL, PARENT_TOP_RIGHT,
  PARENT_LEFT_CENTER_VERTICAL, CENTER_IN_PARENT, PARENT_RIGHT_CENTER_VERTICAL, PARENT_LEFT_BOTTOM,
  PARENT_BOTTOM_CENTER_HORIZONTAL, PARENT_RIGHT_BOTTOM, LOCATION_ABOVE_LEFTALIGN, LOCATION_ABOVE_CENTER,
  LOCATION_ABOVE_RIGHTALIGN, LOCATION_LEFT_OF_TOPALIGN, LOCATION_LEFT_OF_CENTER, LOCATION_LEFT_OF_BOTTOMALIGN,
  LOCATION_RIGHT_OF_TOPALIGN, LOCATION_RIGHT_OF_CENTER, LOCATION_RIGHT_OF_BOTTOMALIGN, LOCATION_BELOW_LEFTALIGN,
  LOCATION_BELOW_CENTER, LOCATION_BELOW_RIGHTALIGN
}
 
- Public Types inherited from LayoutParameter
enum  Type { NONE = 0, LINEAR, RELATIVE }
 

Public Member Functions

 RelativeLayoutParameter ()
 Default constructor. More...
 
virtual ~RelativeLayoutParameter ()
 Default destructor. More...
 
void setAlign (RelativeAlign align)
 Sets RelativeAlign parameter for LayoutParameter. More...
 
RelativeAlign getAlign () const
 Gets RelativeAlign parameter for LayoutParameter. More...
 
void setRelativeToWidgetName (const std::string &name)
 Sets a key for LayoutParameter. More...
 
const std::string & getRelativeToWidgetName () const
 Gets the key of LayoutParameter. More...
 
void setRelativeName (const std::string &name)
 Sets a name in Relative Layout for LayoutParameter. More...
 
const std::string & getRelativeName () const
 Gets a name in Relative Layout of LayoutParameter. More...
 
virtual LayoutParameter * createCloneInstance () override
virtual void copyProperties (LayoutParameter *model) override
- Public Member Functions inherited from LayoutParameter
 LayoutParameter ()
 Default constructor. More...
 
virtual ~LayoutParameter ()
 Default destructor. More...
 
void setMargin (const Margin &margin)
 Sets Margin parameter for LayoutParameter. More...
 
const Margin & getMargin () const
 Gets Margin parameter of LayoutParameter. More...
 
Type getLayoutType () const
 Gets LayoutParameterType of LayoutParameter. More...
 
LayoutParameter * clone ()
- Public Member Functions inherited from Ref
void retain ()
 Retains the ownership. More...
 
void release ()
 Releases the ownership immediately. More...
 
Ref * autorelease ()
 Releases the ownership sometime soon automatically. More...
 
unsigned int getReferenceCount () const
 Returns the Ref's current reference count. More...
 
virtual ~Ref ()

Static Public Member Functions

static RelativeLayoutParameter * create ()
 Allocates and initializes. More...
 
- Static Public Member Functions inherited from LayoutParameter
static LayoutParameter * create ()
 Allocates and initializes. More...
 

Protected Attributes

RelativeAlign _relativeAlign
std::string _relativeWidgetName
std::string _relativeLayoutName
bool _put
- Protected Attributes inherited from LayoutParameter
Margin _margin
Type _layoutParameterType
- Protected Attributes inherited from Ref
unsigned int _referenceCount
 count of references More...
 
var _referenceCount
 count of references More...
 
local _referenceCount
 count of references More...
 

Friends

class RelativeLayoutManager

Additional Inherited Members

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

Member Enumeration Documentation

enum RelativeAlign
strong
Enumerator
NONE 
PARENT_TOP_LEFT 
PARENT_TOP_CENTER_HORIZONTAL 
PARENT_TOP_RIGHT 
PARENT_LEFT_CENTER_VERTICAL 
CENTER_IN_PARENT 
PARENT_RIGHT_CENTER_VERTICAL 
PARENT_LEFT_BOTTOM 
PARENT_BOTTOM_CENTER_HORIZONTAL 
PARENT_RIGHT_BOTTOM 
LOCATION_ABOVE_LEFTALIGN 
LOCATION_ABOVE_CENTER 
LOCATION_ABOVE_RIGHTALIGN 
LOCATION_LEFT_OF_TOPALIGN 
LOCATION_LEFT_OF_CENTER 
LOCATION_LEFT_OF_BOTTOMALIGN 
LOCATION_RIGHT_OF_TOPALIGN 
LOCATION_RIGHT_OF_CENTER 
LOCATION_RIGHT_OF_BOTTOMALIGN 
LOCATION_BELOW_LEFTALIGN 
LOCATION_BELOW_CENTER 
LOCATION_BELOW_RIGHTALIGN 

Constructor & Destructor Documentation

Default constructor.

virtual ~RelativeLayoutParameter ( )
inlinevirtual

Default destructor.

Member Function Documentation

virtual void copyProperties ( LayoutParameter *  model)
overridevirtual

Reimplemented from LayoutParameter.

static RelativeLayoutParameter*
create
( )
static

Allocates and initializes.

Returns
A initialized LayoutParameter which is marked as "autorelease".
virtual LayoutParameter*
createCloneInstance
( )
overridevirtual

Reimplemented from LayoutParameter.

RelativeAlign getAlign ( ) const

Gets RelativeAlign parameter for LayoutParameter.

See also
RelativeAlign
Returns
RelativeAlign
const std::string& getRelativeName ( ) const

Gets a name in Relative Layout of LayoutParameter.

Returns
name
const std::string&
getRelativeToWidgetName
( ) const

Gets the key of LayoutParameter.

Witch widget named this is relative to.

Returns
name
void setAlign ( RelativeAlign  align)

Sets RelativeAlign parameter for LayoutParameter.

See also
RelativeAlign
Parameters
RelativeAlign
void setRelativeName ( const std::string &  name)

Sets a name in Relative Layout for LayoutParameter.

Parameters
name
void setRelativeToWidgetName ( const std::string &  name)

Sets a key for LayoutParameter.

Witch widget named this is relative to.

Parameters
name

Friends And Related Function Documentation

friend class RelativeLayoutManager
friend

Member Data Documentation

bool _put
protected
RelativeAlign _relativeAlign
protected
std::string _relativeLayoutName
protected
std::string _relativeWidgetName
protected

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