Dali 3D User Interface Engine
List of all members | Public Member Functions | Static Public Member Functions
anonymous_namespace{utc-Dali-ItemLayout.cpp}::TestItemLayout Class Reference
Inheritance diagram for anonymous_namespace{utc-Dali-ItemLayout.cpp}::TestItemLayout:
Inheritance graph
[legend]
Collaboration diagram for anonymous_namespace{utc-Dali-ItemLayout.cpp}::TestItemLayout:
Collaboration graph
[legend]

Public Member Functions

 TestItemLayout ()
 Constructor. More...
 
virtual ~TestItemLayout ()
 Virtual destructor. More...
 
virtual float GetMinimumLayoutPosition (unsigned int numberOfItems, Vector3 layoutSize) const
 Query the minimum valid layout position; this is a negative value. More...
 
virtual float GetClosestAnchorPosition (float layoutPosition) const
 Query the closest anchor position for the given layout position. More...
 
virtual float GetItemScrollToPosition (unsigned int itemId) const
 Query the layout position for the first item in the layout to move to when the layout needs to scroll to a particular item. More...
 
virtual ItemRange GetItemsWithinArea (float firstItemPosition, Vector3 layoutSize) const
 Query the items within a given layout-area. More...
 
virtual unsigned int GetReserveItemCount (Vector3 layoutSize) const
 Query the number of items that should be reserved, for scrolling purposes. More...
 
virtual void GetDefaultItemSize (unsigned int itemId, const Vector3 &layoutSize, Vector3 &itemSize) const
 Retrieve the default size of an item in the layout. More...
 
virtual Degree GetScrollDirection () const
 Query the scroll direction of the layout. More...
 
virtual float GetScrollSpeedFactor () const
 Query the scroll speed factor of the layout while dragging. More...
 
virtual float GetMaximumSwipeSpeed () const
 Query the maximum swipe speed in pixels per second. More...
 
virtual float GetItemFlickAnimationDuration () const
 Get the duration of the flick animation in second. More...
 
virtual void ApplyConstraints (Actor &actor, const int itemId, const Vector3 &layoutSize, const Actor &itemViewActor)
 
virtual Vector3 GetItemPosition (int itemID, float currentLayoutPosition, const Vector3 &layoutSize) const
 Gets the position of a given item. More...
 
- Public Member Functions inherited from Dali::Toolkit::ItemLayout
virtual DALI_IMPORT_API ~ItemLayout ()
 Forward declare future extension interface. More...
 
DALI_IMPORT_API void SetOrientation (ControlOrientation::Type orientation)
 Set the orientation of the layout. More...
 
DALI_IMPORT_API
ControlOrientation::Type 
GetOrientation () const
 Query the orientation of the layout. More...
 
DALI_IMPORT_API void GetItemSize (unsigned int itemId, const Vector3 &layoutSize, Vector3 &itemSize) const
 Retrieve the target size of an item in the layout. More...
 
DALI_IMPORT_API void SetItemSize (const Vector3 &itemSize)
 Overrides the default size for the layout. More...
 
virtual DALI_IMPORT_API float GetClosestOnScreenLayoutPosition (int itemID, float currentLayoutPosition, const Vector3 &layoutSize)
 Get the closest layout position to bring an item onto the screen. More...
 
virtual DALI_IMPORT_API int GetNextFocusItemID (int itemID, int maxItems, Dali::Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled)
 Gets the id of the next item for KeyboardFocusManager to focus on depending on the inputted item ID. More...
 
virtual DALI_IMPORT_API float GetFlickSpeedFactor () const
 Query the flick speed factor of the layout while swipping. More...
 
virtual Extension * GetExtension ()
 Retrieve the extension for this layout. More...
 
- Public Member Functions inherited from Dali::RefObject
void Reference ()
 Increment the object's reference count. More...
 
void Unreference ()
 Decrement the object's reference count. More...
 
int ReferenceCount ()
 Retrieve the object's reference count. More...
 

Static Public Member Functions

static TestItemLayoutPtr New ()
 Create a new grid layout. More...
 

Additional Inherited Members

- Protected Member Functions inherited from Dali::Toolkit::ItemLayout
DALI_IMPORT_API ItemLayout ()
 Create a new ItemLayout; Only derived versions are instantiatable. More...
 
- Protected Attributes inherited from Dali::Toolkit::ItemLayout
ImplmImpl
 

Detailed Description

Definition at line 88 of file utc-Dali-ItemLayout.cpp.

Constructor & Destructor Documentation

anonymous_namespace{utc-Dali-ItemLayout.cpp}::TestItemLayout::TestItemLayout ( )
inline

Constructor.

Definition at line 95 of file utc-Dali-ItemLayout.cpp.

virtual anonymous_namespace{utc-Dali-ItemLayout.cpp}::TestItemLayout::~TestItemLayout ( )
inlinevirtual

Virtual destructor.

Definition at line 102 of file utc-Dali-ItemLayout.cpp.

Member Function Documentation

virtual void anonymous_namespace{utc-Dali-ItemLayout.cpp}::TestItemLayout::ApplyConstraints ( Actor actor,
const int  itemId,
const Vector3 layoutSize,
const Actor itemViewActor 
)
inlinevirtual

Implements Dali::Toolkit::ItemLayout.

Definition at line 232 of file utc-Dali-ItemLayout.cpp.

virtual float anonymous_namespace{utc-Dali-ItemLayout.cpp}::TestItemLayout::GetClosestAnchorPosition ( float  layoutPosition) const
inlinevirtual

Query the closest anchor position for the given layout position.

This anchor position is the position where all the items in the layout are aligned to their rounded layout positions in integer.

Parameters
[in]layoutPositionThe layout position.
Returns
The closest anchor position for the given layout position.

Implements Dali::Toolkit::ItemLayout.

Definition at line 137 of file utc-Dali-ItemLayout.cpp.

virtual void anonymous_namespace{utc-Dali-ItemLayout.cpp}::TestItemLayout::GetDefaultItemSize ( unsigned int  itemId,
const Vector3 layoutSize,
Vector3 itemSize 
) const
inlinevirtual

Retrieve the default size of an item in the layout.

Parameters
[in]itemIdThe ID of an item in the layout.
[in]layoutSizeThe layout size
[out]itemSizeThe target size of an item.

Implements Dali::Toolkit::ItemLayout.

Definition at line 184 of file utc-Dali-ItemLayout.cpp.

virtual float anonymous_namespace{utc-Dali-ItemLayout.cpp}::TestItemLayout::GetItemFlickAnimationDuration ( ) const
inlinevirtual

Get the duration of the flick animation in second.

Returns
The duration of the flick animation.

Implements Dali::Toolkit::ItemLayout.

Definition at line 219 of file utc-Dali-ItemLayout.cpp.

virtual Vector3 anonymous_namespace{utc-Dali-ItemLayout.cpp}::TestItemLayout::GetItemPosition ( int  itemID,
float  currentLayoutPosition,
const Vector3 layoutSize 
) const
inlinevirtual

Gets the position of a given item.

Parameters
[in]itemIDid of the item we want to get its position
[in]currentLayoutPositionthe current layout position of the item view instance
[in]layoutSizethe current size of the item view instance
Returns
The item position (x,y,z)

Implements Dali::Toolkit::ItemLayout.

Definition at line 244 of file utc-Dali-ItemLayout.cpp.

References Dali::Vector3::ZERO.

virtual float anonymous_namespace{utc-Dali-ItemLayout.cpp}::TestItemLayout::GetItemScrollToPosition ( unsigned int  itemId) const
inlinevirtual

Query the layout position for the first item in the layout to move to when the layout needs to scroll to a particular item.

Parameters
[in]itemIdThe ID of an item in the layout.
Returns
The layout position for the first item in the layout to move to.

Implements Dali::Toolkit::ItemLayout.

Definition at line 149 of file utc-Dali-ItemLayout.cpp.

virtual ItemRange anonymous_namespace{utc-Dali-ItemLayout.cpp}::TestItemLayout::GetItemsWithinArea ( float  firstItemPosition,
Vector3  layoutSize 
) const
inlinevirtual

Query the items within a given layout-area.

Parameters
[in]firstItemPositionThe layout-position of the first item in the layout.
[in]layoutSizeThe size of the layout area.
Returns
The ID of the first & last visible item.

Implements Dali::Toolkit::ItemLayout.

Definition at line 161 of file utc-Dali-ItemLayout.cpp.

virtual float anonymous_namespace{utc-Dali-ItemLayout.cpp}::TestItemLayout::GetMaximumSwipeSpeed ( ) const
inlinevirtual

Query the maximum swipe speed in pixels per second.

Returns
speed The maximum swipe speed.

Implements Dali::Toolkit::ItemLayout.

Definition at line 210 of file utc-Dali-ItemLayout.cpp.

virtual float anonymous_namespace{utc-Dali-ItemLayout.cpp}::TestItemLayout::GetMinimumLayoutPosition ( unsigned int  numberOfItems,
Vector3  layoutSize 
) const
inlinevirtual

Query the minimum valid layout position; this is a negative value.

When scrolling, the first item will move within the range 0 to GetMinimumLayoutPosition().

Parameters
[in]numberOfItemsThe current number of items in the layout.
[in]layoutSizeThe size of the layout area.
Returns
The minimum layout position.

Implements Dali::Toolkit::ItemLayout.

Definition at line 124 of file utc-Dali-ItemLayout.cpp.

virtual unsigned int anonymous_namespace{utc-Dali-ItemLayout.cpp}::TestItemLayout::GetReserveItemCount ( Vector3  layoutSize) const
inlinevirtual

Query the number of items that should be reserved, for scrolling purposes.

Parameters
[in]layoutSizeThe size of the layout area.
Returns
The number of extra items.

Implements Dali::Toolkit::ItemLayout.

Definition at line 172 of file utc-Dali-ItemLayout.cpp.

virtual Degree anonymous_namespace{utc-Dali-ItemLayout.cpp}::TestItemLayout::GetScrollDirection ( ) const
inlinevirtual

Query the scroll direction of the layout.

Returns
The scroll direction in degrees.

Implements Dali::Toolkit::ItemLayout.

Definition at line 192 of file utc-Dali-ItemLayout.cpp.

virtual float anonymous_namespace{utc-Dali-ItemLayout.cpp}::TestItemLayout::GetScrollSpeedFactor ( ) const
inlinevirtual

Query the scroll speed factor of the layout while dragging.

Returns
The scroll speed factor of the layout.

Implements Dali::Toolkit::ItemLayout.

Definition at line 201 of file utc-Dali-ItemLayout.cpp.

static TestItemLayoutPtr anonymous_namespace{utc-Dali-ItemLayout.cpp}::TestItemLayout::New ( void  )
inlinestatic

Create a new grid layout.

Definition at line 109 of file utc-Dali-ItemLayout.cpp.


The documentation for this class was generated from the following file:
Dali Docs Home
Read more about Dali