JawsMako::ILayoutFrame Class Reference

#include <jawsmako/layout.h>

Inheritance diagram for JawsMako::ILayoutFrame:

Public Types
enum	eVerticalAlignment { eVATop , eVACenter , eVABottom }
	Vertical alignment for this frame. More...

Public Member Functions
virtual	~ILayoutFrame ()
virtual ILayoutFramePtr	clone () const =0
	Clone the frame.
virtual const FRect &	getBounds () const =0
	Get the bounds of this frame.
virtual eVerticalAlignment	getVerticalAlignment () const =0
	Get the vertical alignment of the content of this frame.
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static JAWSMAKO_API ILayoutFramePtr	create (const FRect &bounds, eVerticalAlignment verticalAlignment=eVATop)
	Create a frame.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Member Enumeration Documentation

eVerticalAlignment

enum JawsMako::ILayoutFrame::eVerticalAlignment

Vertical alignment for this frame.

Enumerator
eVATop	Align vertically to the top of the frame.
eVACenter	Align vertically centered.
eVABottom	Align vertically to the bottom of the frame.

Constructor & Destructor Documentation

~ILayoutFrame()

virtual JawsMako::ILayoutFrame::~ILayoutFrame ( )

inlinevirtual

Member Function Documentation

clone()

virtual ILayoutFramePtr JawsMako::ILayoutFrame::clone ( ) const

pure virtual

Clone the frame.

Returns

ILayoutFramePtr A smart pointer to the cloned ILayoutFramePtr object.

create()

JAWSMAKO_API ILayoutFramePtr JawsMako::ILayoutFrame::create ( const FRect & bounds, eVerticalAlignment verticalAlignment = eVATop )

static

Create a frame.

Parameters

bounds	The bounds of this frame.
verticalAlignment	The vertical alignment for this frame.

Returns

ILayoutFramePtr The newly created frame.

getBounds()

virtual const FRect & JawsMako::ILayoutFrame::getBounds ( ) const

pure virtual

Get the bounds of this frame.

Returns

FRect The bounds.

getVerticalAlignment()

virtual eVerticalAlignment JawsMako::ILayoutFrame::getVerticalAlignment ( ) const

pure virtual

Get the vertical alignment of the content of this frame.

Returns

eVerticalAlignment The vertical alignment.

---

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

• jawsmako/layout.h