CYIScrollingView::Magnets Struct Reference

Detailed Description

A container class for a magnet configuration.

#include <view/YiScrollingView.h>

Static Public Member Functions
static Magnets	CreateNone ()
static Magnets	CreateCenter (float fCenterOffset)
static Magnets	CreateBegin (float fBeginningOffset)
static Magnets	CreateEnd (float fEndOffset)
static Magnets	CreateEdges (float fBeginningOffset, float fEndOffset)

Public Attributes
const MAGNETS_TYPE	eType
	The magnets type. More...
const float	fBeginningOffset
	The beginning offset. Applicable only when eType is MAGNETS_TYPE::MAGNETS_EDGES or MAGNETS_TYPE::MAGNETS_BEGIN. More...
const float	fCenterOffset
	The center offset. Applicable only when eType is MAGNETS_TYPE::CENTER. More...
const float	fEndOffset
	The end offset. Applicable only when eType is MAGNETS_TYPE::MAGNETS_EDGES or MAGNETS_TYPE::MAGNETS_END. More...

Member Function Documentation

static Magnets CYIScrollingView::Magnets::CreateBegin ( float  fBeginningOffset )

static

Creates a magnet object represeting MAGNETS_TYPE::MAGNETS_BEGIN.

fBeginningOffset is an offset, in pixels, from the beginning of the view (i.e. the top or left edge). A positive value moves the magnet towards the center of the view, and a negative value moves the magnet away from the center of the view.

static Magnets CYIScrollingView::Magnets::CreateCenter ( float  fCenterOffset )

static

Creates a magnet object representing MAGNETS_TYPE::MAGNETS_CENTER.

fCenterOffset is an offset from the center of the view, in pixels. A positive value moves the magnet towards the end of the view (i.e. bottom or right edge), and a negative value moves the manget towards the beginning of the view (i.e. top or left edge).

static Magnets CYIScrollingView::Magnets::CreateEdges ( float  fBeginningOffset, float  fEndOffset  )

static

Creates a magnet object represeting MAGNETS_TYPE::MAGNETS_EDGES.

fBeginningOffset is an offset, in pixels, from the beginning of the view (i.e. the top or left edge). A positive value moves the magnet towards the center of the view, and a negative value moves the magnet away from the center of the view.

fEndOffset is an offset, in pixels, from the end of the view (i.e. the bottom or right edge). A positive value moves the magnet towards the center of the view, and a negative value moves the magnet away from the center of the view.

static Magnets CYIScrollingView::Magnets::CreateEnd ( float  fEndOffset )

static

Creates a magnet object represeting MAGNETS_TYPE::MAGNETS_END.

fEndOffset is an offset, in pixels, from the end of the view (i.e. the bottom or right edge). A positive value moves the magnet towards the center of the view, and a negative value moves the magnet away from the center of the view.

static Magnets CYIScrollingView::Magnets::CreateNone ( )

static

Creates a magnet object representing MAGNETS_TYPE::MAGNETS_NONE.

Member Data Documentation

const MAGNETS_TYPE CYIScrollingView::Magnets::eType

The magnets type.

const float CYIScrollingView::Magnets::fBeginningOffset

The beginning offset. Applicable only when eType is MAGNETS_TYPE::MAGNETS_EDGES or MAGNETS_TYPE::MAGNETS_BEGIN.

const float CYIScrollingView::Magnets::fCenterOffset

The center offset. Applicable only when eType is MAGNETS_TYPE::CENTER.

const float CYIScrollingView::Magnets::fEndOffset

The end offset. Applicable only when eType is MAGNETS_TYPE::MAGNETS_EDGES or MAGNETS_TYPE::MAGNETS_END.

---

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

• view/YiScrollingView.h