-#ifndef __DALI_TOOLKIT_INTERNAL_TABLE_VIEW_H__
-#define __DALI_TOOLKIT_INTERNAL_TABLE_VIEW_H__
-
-//
-// Copyright (c) 2014 Samsung Electronics Co., Ltd.
-//
-// Licensed under the Flora License, Version 1.0 (the License);
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-// http://floralicense.org/license/
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an AS IS BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
-//
+#ifndef DALI_TOOLKIT_INTERNAL_TABLE_VIEW_H
+#define DALI_TOOLKIT_INTERNAL_TABLE_VIEW_H
+
+/*
+ * Copyright (c) 2019 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.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+// EXTERNAL INCLUDES
+#include <dali/public-api/object/weak-handle.h>
// INTERNAL INCLUDES
#include <dali-toolkit/public-api/controls/control-impl.h>
* TableView is a custom control for laying out actors in a table layout
* @see Dali::Toolkit:TableView for more details
*/
-class TableView : public ControlImpl
+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.
*/
/**
* @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
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
float GetFixedWidth( unsigned int columnIndex ) const;
/**
- * @copydoc Toolkit::TableView::SetRelativeWidth
+ * @copydoc Toolkit::TableView::SetFixedHeight
*/
- void SetRelativeWidth( unsigned int columnIndex, float widthPercentage );
+ void SetFixedHeight( unsigned int rowIndex, float height );
/**
- * @copydoc Toolkit::TableView::GetRelativeWidth
+ * @copydoc Toolkit::TableView::GetFixedHeight
*/
- float GetRelativeWidth( unsigned int columnIndex ) const;
+ float GetFixedHeight( unsigned int rowIndex ) const;
+
+ /**
+ * @copydoc Toolkit::TableView::SetRelativeHeight
+ */
+ void SetRelativeHeight( unsigned int rowIndex, float heightPercentage );
/**
- * @copydoc Toolkit::TableView::SetLayoutAnimationDuration
+ * @copydoc Toolkit::TableView::GetRelativeHeight
*/
- void SetLayoutAnimationDuration( float duration );
+ float GetRelativeHeight( unsigned int rowIndex ) const;
/**
- * @copydoc Toolkit::TableView::GetLayoutAnimationDuration
+ * @copydoc Toolkit::TableView::SetRelativeWidth
*/
- float GetLayoutAnimationDuration();
+ void SetRelativeWidth( unsigned int columnIndex, float widthPercentage );
+ /**
+ * @copydoc Toolkit::TableView::GetRelativeWidth
+ */
+ float GetRelativeWidth( unsigned int columnIndex ) const;
/**
* @copydoc Toolkit::TableView::GetRows
*/
unsigned int GetColumns();
-private: // From ControlImpl
+ /**
+ * @copydoc Toolkit::TableView::SetCellAlignment
+ */
+ void SetCellAlignment( Toolkit::TableView::CellPosition position, HorizontalAlignment::Type horizontal, VerticalAlignment::Type vertical );
+
+ // Properties
+
+ /**
+ * Called when a property of an object of this type is set.
+ * @param[in] object The object whose property is set.
+ * @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 );
+
+ /**
+ * Called to retrieve a property of an object of this type.
+ * @param[in] object The object whose property is to be retrieved.
+ * @param[in] index The property index.
+ * @return The current value of the property.
+ */
+ static Property::Value GetProperty( BaseObject* object, Property::Index index );
+
+private: // From Control
+
+ /**
+ * @copydoc Control::OnChildAdd(Actor& child)
+ */
+ virtual void OnChildAdd( Actor& child );
/**
- * @copydoc Toolkit::ControlImpl::OnControlChildAdd(Actor& child)
+ * @copydoc Control::OnChildRemove(Actor& child)
*/
- virtual void OnControlChildAdd(Actor& child);
+ virtual void OnChildRemove( Actor& child );
/**
- * @copydoc Toolkit::ControlImpl::OnControlChildRemove(Actor& child)
+ * @copydoc Control::OnRelayout
*/
- virtual void OnControlChildRemove(Actor& child);
+ virtual void OnRelayout( const Vector2& size, RelayoutContainer& container );
/**
- * @copydoc Toolkit::ControlImpl::OnRelaidOut
+ * @copydoc Control::CalculateChildSize
*/
- virtual void OnRelaidOut( Vector2 size, ActorSizeContainer& container );
+ virtual float CalculateChildSize( const Actor& child, Dimension::Type dimension );
/**
- * @copydoc Toolkit::ControlImpl::OnInitialize()
+ * @copydoc Control::OnInitialize()
*/
virtual void OnInitialize();
/**
- * @copydoc Toolkit::ControlImpl::GetNextKeyboardFocusableActor
+ * @copydoc Control::GetNextKeyboardFocusableActor
+ */
+ virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocus::Direction direction, bool loopEnabled );
+
+ /**
+ * @copydoc Control::GetNaturalSize()
+ */
+ virtual Vector3 GetNaturalSize();
+
+ /**
+ * @copydoc Control::RelayoutDependentOnChildren()
+ */
+ virtual bool RelayoutDependentOnChildren( Dimension::Type dimension = Dimension::ALL_DIMENSIONS );
+
+ /**
+ * @copydoc Control::OnCalculateRelayoutSize
+ */
+ virtual void OnCalculateRelayoutSize( Dimension::Type dimension );
+
+ /**
+ * @copydoc Control::OnLayoutNegotiated
+ */
+ virtual void OnLayoutNegotiated( float size, Dimension::Type dimension );
+
+ /**
+ * @copydoc CustomActorImpl::OnSizeSet( const Vector3& size )
*/
- virtual Actor GetNextKeyboardFocusableActor(Actor currentFocusedActor, Control::KeyboardFocusNavigationDirection direction, bool loopEnabled);
+ virtual void OnSizeSet( const Vector3& size );
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 );
* @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 );
+
+ /**
+ * @brief Calculate the total fixed sizes for a row or column
+ *
+ * @param[in] data The row or column data to process
+ */
+ 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 );
/**
- * Helper to update relative sizes
- * @param fixedHeightsTotal sum of the fixed height rows
- * @param fixedWidthsTotal sum of the fixed width columns
+ * @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)
*/
- void UpdateRelativeSizes( float& fixedHeightsTotal, float& fixedWidthsTotal );
+ 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 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),
+ void(TableView::*funcFit)(unsigned int),
+ const Property::Value& map );
+
+ /**
+ * Called to retrieve the property value of row heights.
+ * @return The property value of row heights.
+ */
+ Property::Value GetRowHeightsPropertyValue();
+
+ /**
+ * Called to retrieve the property value of column widths.
+ * @return The fixed-widths property value.
+ */
+ Property::Value GetColumnWidthsPropertyValue();
+
+ /**
+ * Generate the map type property value from the size vectors.
+ * @param[in] data The array of row or column data
+ * @param[out] map The property value.
+ */
+ void GetMapPropertyValue( const RowColumnArray& data, Property::Map& map );
+
+
/**
* Helper class to prevent child adds and removes from causing relayout
* when we're already anyways going to do one in the end
private: // Data
- 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;
- float mConstraintDuration;
+ 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
+
+ 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
} // namespace Dali
-#endif // __DALI_TOOLKIT_INTERNAL_TABLE_VIEW_H__
+#endif // DALI_TOOLKIT_INTERNAL_TABLE_VIEW_H
projects / platform / core / uifw / dali-toolkit.git / blobdiff