-#ifndef __DALI_TOOLKIT_INTERNAL_TABLE_VIEW_H__
-#define __DALI_TOOLKIT_INTERNAL_TABLE_VIEW_H__
+#ifndef DALI_TOOLKIT_INTERNAL_TABLE_VIEW_H
+#define DALI_TOOLKIT_INTERNAL_TABLE_VIEW_H
/*
- * Copyright (c) 2014 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2021 Samsung Electronics Co., Ltd.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
*
*/
+// EXTERNAL INCLUDES
+#include <dali/public-api/object/weak-handle.h>
+
// INTERNAL INCLUDES
+#include <dali-toolkit/devel-api/controls/table-view/table-view.h>
#include <dali-toolkit/public-api/controls/control-impl.h>
-#include <dali-toolkit/public-api/controls/table-view/table-view.h>
#include "array-2d.h"
namespace Dali
{
-
namespace Toolkit
{
-
namespace Internal
{
-
/**
* TableView is a custom control for laying out actors in a table layout
* @see Dali::Toolkit:TableView for more details
class TableView : public Control
{
public:
-
- /**
- * Structure for the layout data
- */
- struct CellData
- {
- // data members
- Actor actor;
- Toolkit::TableView::CellPosition position;
- };
-
/**
* Create a new TableView.
* @return A smart-pointer to the newly allocated TableView.
*/
- static Toolkit::TableView New( unsigned int initialRows, unsigned int initialColumns );
+ static Toolkit::TableView New(unsigned int initialRows, unsigned int initialColumns);
/**
* @copydoc Toolkit::TableView::AddChild
*/
- bool AddChild( Actor child, Toolkit::TableView::CellPosition position );
+ bool AddChild(Actor& child, const Toolkit::TableView::CellPosition& position);
/**
* @copydoc Toolkit::TableView::GetChildAt
*/
- Actor GetChildAt( Toolkit::TableView::CellPosition position );
+ Actor GetChildAt(const Toolkit::TableView::CellPosition& position);
/**
* @copydoc Toolkit::TableView::RemoveChildAt
*/
- Actor RemoveChildAt( Toolkit::TableView::CellPosition position );
+ Actor RemoveChildAt(const Toolkit::TableView::CellPosition& position);
/**
* @copydoc Toolkit::TableView::FindChildPosition
*/
- bool FindChildPosition( Actor child, Toolkit::TableView::CellPosition& position );
+ bool FindChildPosition(const Actor& child, Toolkit::TableView::CellPosition& positionOut);
/**
* @copydoc Toolkit::TableView::InsertRow
*/
- void InsertRow( unsigned int rowIndex );
+ void InsertRow(unsigned int rowIndex);
/**
* @copydoc Toolkit::TableView::DeleteRow( unsigned int rowIndex )
*/
- void DeleteRow( unsigned int rowIndex );
+ void DeleteRow(unsigned int rowIndex);
/**
* @copydoc Toolkit::TableView::DeleteRow( unsigned int rowIndex, std::vector<Actor>& removed )
*/
- void DeleteRow( unsigned int rowIndex, std::vector<Actor>& removed );
+ void DeleteRow(unsigned int rowIndex, std::vector<Actor>& removed);
/**
* @copydoc Toolkit::TableView::InsertColumn
*/
- void InsertColumn( unsigned int columnIndex );
+ void InsertColumn(unsigned int columnIndex);
/**
* @copydoc Toolkit::TableView::DeleteColumn( unsigned int columnIndex )
*/
- void DeleteColumn( unsigned int columnIndex );
+ void DeleteColumn(unsigned int columnIndex);
/**
* @copydoc Toolkit::TableView::DeleteColumn( unsigned int columnIndex, std::vector<Actor>& removed )
*/
- void DeleteColumn( unsigned int columnIndex, std::vector<Actor>& removed );
+ void DeleteColumn(unsigned int columnIndex, std::vector<Actor>& removed);
/**
* @copydoc Toolkit::TableView::Resize( unsigned int rows, unsigned int columns )
*/
- void Resize( unsigned int rows, unsigned int columns );
+ void Resize(unsigned int rows, unsigned int columns);
/**
* @copydoc Toolkit::TableView::Resize( unsigned int rows, unsigned int columns, std::vector<Actor>& removed )
*/
- void Resize( unsigned int rows, unsigned int columns, std::vector<Actor>& removed );
+ void Resize(unsigned int rows, unsigned int columns, std::vector<Actor>& removed);
/**
* @copydoc Toolkit::TableView::SetCellPadding
*/
- void SetCellPadding( Size padding );
+ void SetCellPadding(Size padding);
/**
* @copydoc Toolkit::TableView::GetCellPadding
Size GetCellPadding();
/**
- * @copydoc Toolkit::TableView::SetFixedHeight
+ * @copydoc Toolkit::TableView::SetFitHeight
*/
- void SetFixedHeight( unsigned int rowIndex, float height );
+ void SetFitHeight(unsigned int rowIndex);
/**
- * @copydoc Toolkit::TableView::GetFixedHeight
+ * @copydoc Toolkit::TableView::IsFitHeight
*/
- float GetFixedHeight( unsigned int rowIndex ) const;
+ bool IsFitHeight(unsigned int rowIndex) const;
/**
- * @copydoc Toolkit::TableView::SetRelativeHeight
+ * @copydoc Toolkit::TableView::SetFitWidth
*/
- void SetRelativeHeight( unsigned int rowIndex, float heightPercentage );
+ void SetFitWidth(unsigned int columnIndex);
/**
- * @copydoc Toolkit::TableView::GetRelativeHeight
+ * @copydoc Toolkit::TableView::IsFitWidth
*/
- float GetRelativeHeight( unsigned int rowIndex ) const;
+ bool IsFitWidth(unsigned int columnIndex) const;
/**
* @copydoc Toolkit::TableView::SetFixedWidth
*/
- void SetFixedWidth( unsigned int columnIndex, float width );
+ void SetFixedWidth(unsigned int columnIndex, float width);
/**
* @copydoc Toolkit::TableView::GetFixedWidth
*/
- float GetFixedWidth( unsigned int columnIndex ) const;
+ float GetFixedWidth(unsigned int columnIndex) const;
+
+ /**
+ * @copydoc Toolkit::TableView::SetFixedHeight
+ */
+ void SetFixedHeight(unsigned int rowIndex, float height);
+
+ /**
+ * @copydoc Toolkit::TableView::GetFixedHeight
+ */
+ float GetFixedHeight(unsigned int rowIndex) const;
+
+ /**
+ * @copydoc Toolkit::TableView::SetRelativeHeight
+ */
+ void SetRelativeHeight(unsigned int rowIndex, float heightPercentage);
+
+ /**
+ * @copydoc Toolkit::TableView::GetRelativeHeight
+ */
+ float GetRelativeHeight(unsigned int rowIndex) const;
/**
* @copydoc Toolkit::TableView::SetRelativeWidth
*/
- void SetRelativeWidth( unsigned int columnIndex, float widthPercentage );
+ void SetRelativeWidth(unsigned int columnIndex, float widthPercentage);
/**
* @copydoc Toolkit::TableView::GetRelativeWidth
*/
- float GetRelativeWidth( unsigned int columnIndex ) const;
+ float GetRelativeWidth(unsigned int columnIndex) const;
/**
* @copydoc Toolkit::TableView::GetRows
*/
unsigned int GetColumns();
+ /**
+ * @copydoc Toolkit::TableView::SetCellAlignment
+ */
+ void SetCellAlignment(Toolkit::TableView::CellPosition position, HorizontalAlignment::Type horizontal, VerticalAlignment::Type vertical);
+
// Properties
/**
* @param[in] index The property index.
* @param[in] value The new property value.
*/
- static void SetProperty( BaseObject* object, Property::Index index, const Property::Value& value );
+ static void SetProperty(BaseObject* object, Property::Index index, const Property::Value& value);
/**
* Called to retrieve a property of an object of this type.
* @param[in] index The property index.
* @return The current value of the property.
*/
- static Property::Value GetProperty( BaseObject* object, Property::Index index );
+ static Property::Value GetProperty(BaseObject* object, Property::Index index);
private: // From Control
-
/**
- * @copydoc Control::OnControlChildAdd(Actor& child)
+ * @copydoc Control::OnChildAdd(Actor& child)
*/
- virtual void OnControlChildAdd(Actor& child);
+ void OnChildAdd(Actor& child) override;
/**
- * @copydoc Control::OnControlChildRemove(Actor& child)
+ * @copydoc Control::OnChildRemove(Actor& child)
*/
- virtual void OnControlChildRemove(Actor& child);
+ void OnChildRemove(Actor& child) override;
/**
* @copydoc Control::OnRelayout
*/
- virtual void OnRelayout( const Vector2& size, ActorSizeContainer& container );
+ void OnRelayout(const Vector2& size, RelayoutContainer& container) override;
+
+ /**
+ * @copydoc Control::CalculateChildSize
+ */
+ float CalculateChildSize(const Actor& child, Dimension::Type dimension) override;
/**
* @copydoc Control::OnInitialize()
*/
- virtual void OnInitialize();
+ void OnInitialize() override;
/**
* @copydoc Control::GetNextKeyboardFocusableActor
*/
- virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
+ Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled) override;
+
+ /**
+ * @copydoc Control::GetNaturalSize()
+ */
+ Vector3 GetNaturalSize() override;
+
+ /**
+ * @copydoc Control::RelayoutDependentOnChildren()
+ */
+ bool RelayoutDependentOnChildren(Dimension::Type dimension = Dimension::ALL_DIMENSIONS) override;
+
+ /**
+ * @copydoc Control::OnCalculateRelayoutSize
+ */
+ void OnCalculateRelayoutSize(Dimension::Type dimension) override;
+
+ /**
+ * @copydoc Control::OnLayoutNegotiated
+ */
+ void OnLayoutNegotiated(float size, Dimension::Type dimension) override;
+
+ /**
+ * @copydoc CustomActorImpl::OnSizeSet( const Vector3& size )
+ */
+ void OnSizeSet(const Vector3& size) override;
private: // Implementation
+ /**
+ * Struct to hold data for rows and columns
+ *
+ * If sizePolicy is FIXED then size is the absolute size to use.
+ * If sizePolicy is FIT, RELATIVE or FILL then size is the calculated value of size.
+ */
+ struct RowColumnData
+ {
+ /**
+ * Default constructor
+ */
+ RowColumnData()
+ : size(0.0f),
+ fillRatio(0.0f),
+ position(0.0f),
+ sizePolicy(Toolkit::TableView::FILL)
+ {
+ }
+
+ /**
+ * Constructor
+ *
+ * @param[in] newSize The size to set for this data
+ * @param[in] newSizePolicy The policy used to interpret the size value
+ */
+ RowColumnData(float newSize, float newFillRatio, Toolkit::TableView::LayoutPolicy newSizePolicy)
+ : size(newSize),
+ fillRatio(newFillRatio),
+ position(0.0f),
+ sizePolicy(newSizePolicy)
+ {
+ }
+
+ float size; ///< Set or calculated size
+ float fillRatio; ///< Ratio to fill remaining space, only valid with RELATIVE or FILL policy
+ float position; ///< Position of the row/column, this value is updated during every Relayout round
+ Toolkit::TableView::LayoutPolicy sizePolicy; ///< The size policy used to interpret the size value
+ };
+
+ typedef Dali::Vector<RowColumnData> RowColumnArray;
+public:
+ /**
+ * Structure for the layout data
+ */
+ struct CellData
+ {
+ CellData()
+ : horizontalAlignment(HorizontalAlignment::LEFT),
+ verticalAlignment(VerticalAlignment::TOP)
+ {
+ }
+
+ // data members
+ Dali::Actor actor;
+ Toolkit::TableView::CellPosition position;
+ HorizontalAlignment::Type horizontalAlignment;
+ VerticalAlignment::Type verticalAlignment;
+ };
+
+private:
/**
* Construct a new TableView.
*/
- TableView( unsigned int initialRows, unsigned int initialColumns );
+ TableView(unsigned int initialRows, unsigned int initialColumns);
/**
* Resizes the data containers to match the new size
* @param [in] rows in the table
* @param [in] columns in the table
*/
- void ResizeContainers( unsigned int rows, unsigned int columns );
+ void ResizeContainers(unsigned int rows, unsigned int columns);
/**
* Resizes the data containers to match the new size
* @param [in] columns in the table
* @param [out] removed celldata
*/
- void ResizeContainers( unsigned int rows, unsigned int columns, std::vector<CellData>& removed );
+ void ResizeContainers(unsigned int rows, unsigned int columns, std::vector<CellData>& removed);
/**
* Helper to get the list of lost actors in the case when table looses cells.
* @param rowsRemoved from table
* @param columnsRemoved from table
*/
- void RemoveAndGetLostActors( const std::vector<CellData>& lost, std::vector<Actor>& removed,
- unsigned int rowsRemoved, unsigned int columnsRemoved );
+ void RemoveAndGetLostActors(const std::vector<CellData>& lost, std::vector<Actor>& removed, unsigned int rowsRemoved, unsigned int columnsRemoved);
/**
* Helper to remove all instances of the actor
* @param child actor to remove
* @return true if the actor was found
*/
- bool RemoveAllInstances( Actor child );
+ bool RemoveAllInstances(const Actor& child);
+
+ /**
+ * @brief Calculate the ratio of FILL rows/columns
+ *
+ * @param[in] data The RowColumn data to compute the relative sizes for
+ */
+ void CalculateFillSizes(RowColumnArray& data);
/**
- * Helper to update relative sizes
- * @param fixedHeightsTotal sum of the fixed height rows
- * @param fixedWidthsTotal sum of the fixed width columns
+ * @brief Calculate the total fixed sizes for a row or column
+ *
+ * @param[in] data The row or column data to process
*/
- void UpdateRelativeSizes( float& fixedHeightsTotal, float& fixedWidthsTotal );
+ float CalculateTotalFixedSize(const RowColumnArray& data);
+
+ /**
+ * @brief Calculate the sizes of FIT rows/columns
+ *
+ * @param[in] data The row or column data to process
+ * @param[in] dimension The dimension being calculated: row == Dimension::HEIGHT, column == Dimension::WIDTH
+ */
+ void CalculateFitSizes(RowColumnArray& data, Dimension::Type dimension);
+
+ /**
+ * @brief Search for a FIT cell in the array
+ *
+ * @param[in] data The row or column data to process
+ * @return Return if a FIT cell was found or not
+ */
+ bool FindFit(const RowColumnArray& data);
+
+ /**
+ * @brief Return the cell padding for a given dimension
+ *
+ * @param[in] dimension The dimension to return the padding for
+ * @return Return the padding (x = low, y = high)
+ */
+ Vector2 GetCellPadding(Dimension::Type dimension);
/**
* A reference counted object may only be deleted by calling Unreference()
virtual ~TableView();
private: // scripting support
-
/**
* Called to set the heights/widths property.
* @param[in] tableViewImpl The object whose property is set.
- * @param[in] funcFixed The set function to call, it can be SetFixedHeight or SetFixedWidths.
- * @param[in] funcRelative The set function to call, it can be SetRelativeHeight or SetRelativeWidths.
+ * @param[in] funcFixed The set function to call, it can be SetFixedHeight or SetFixedWidth.
+ * @param[in] funcRelative The set function to call, it can be SetRelativeHeight or SetRelativeWidth.
+ * @param[in] funcFit The set function to call, it can be SetFitHeight or SetFiltWidth.
* @param[in] value The new property value.
*/
- static void SetHeightOrWidthProperty( TableView& tableViewImpl,
- void(TableView::*funcFixed)(unsigned int, float),
- void(TableView::*funcRelative)(unsigned int, float),
- const Property::Value& map );
+ static void SetHeightOrWidthProperty(TableView& tableViewImpl,
+ void (TableView::*funcFixed)(unsigned int, float),
+ void (TableView::*funcRelative)(unsigned int, float),
+ void (TableView::*funcFit)(unsigned int),
+ const Property::Value& map);
/**
* Called to retrieve the property value of row heights.
/**
* Generate the map type property value from the size vectors.
- * @param[in] fixedSize The vector of fixed heights or widths.
- * @param[in] relativeSize The vector of relative heights or widths.
+ * @param[in] data The array of row or column data
* @param[out] map The property value.
*/
- void GetMapPropertyValue( const std::vector<float>& fixedSize, const std::vector<float>& relativeSize, Property::Map& map );
-
+ void GetMapPropertyValue(const RowColumnArray& data, Property::Map& map);
/**
* Helper class to prevent child adds and removes from causing relayout
class RelayoutingLock
{
public: // API
-
/**
* Constructor, sets the lock boolean
*/
- RelayoutingLock( TableView& parent )
- : mLock( parent.mLayoutingChild )
+ RelayoutingLock(TableView& parent)
+ : mLock(parent.mLayoutingChild)
{
mLock = true;
}
};
private:
-
// Undefined copy constructor and assignment operators
TableView(const TableView&);
TableView& operator=(const TableView& rhs);
-private: // Data
+private: // Data
+ Array2d<CellData> mCellData; ///< Data for each cell: Actor, alignment settings etc
+
+ RowColumnArray mRowData; ///< Data for each row
+ RowColumnArray mColumnData; ///< Data for each column
+ Size mFixedTotals; ///< Accumulated totals for fixed width and height
- Array2d<CellData> mCellData;
- Array2d<Size> mRelativeSizes;
- std::vector<float> mFixedHeights;
- std::vector<float> mRelativeHeights;
- std::vector<float> mFixedWidths;
- std::vector<float> mRelativeWidths;
- Size mPadding;
- bool mLayoutingChild;
+ Size mPadding; ///< Padding to apply to each cell
+ WeakHandle<Actor> mPreviousFocusedActor; ///< Perviously focused actor
+ bool mLayoutingChild; ///< Can't be a bitfield due to Relayouting lock
+ bool mRowDirty : 1; ///< Flag to indicate the row data is dirty
+ bool mColumnDirty : 1; ///< Flag to indicate the column data is dirty
};
} // namespace Internal
// Helpers for public-api forwarding methods
-inline Toolkit::Internal::TableView& GetImpl( Toolkit::TableView& tableView )
+inline Toolkit::Internal::TableView& GetImpl(Toolkit::TableView& tableView)
{
DALI_ASSERT_ALWAYS(tableView);
return static_cast<Toolkit::Internal::TableView&>(handle);
}
-inline const Toolkit::Internal::TableView& GetImpl( const Toolkit::TableView& tableView )
+inline const Toolkit::Internal::TableView& GetImpl(const Toolkit::TableView& tableView)
{
DALI_ASSERT_ALWAYS(tableView);
} // namespace Dali
-#endif // __DALI_TOOLKIT_INTERNAL_TABLE_VIEW_H__
+#endif // DALI_TOOLKIT_INTERNAL_TABLE_VIEW_H
projects / platform / core / uifw / dali-toolkit.git / blobdiff