X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=dali-toolkit%2Finternal%2Fcontrols%2Ftable-view%2Ftable-view-impl.h;h=be41e47cdf516d6b06777cf0a0cc4fc3166215ec;hb=005f449f3648e36e0cc997735b58b0ebb7a6390b;hp=5f7a5d1d5845ddd41d41c90ce8fa178bd5b66693;hpb=e2eda444afbe82e9591fe198eef339227f90a616;p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git diff --git a/dali-toolkit/internal/controls/table-view/table-view-impl.h b/dali-toolkit/internal/controls/table-view/table-view-impl.h index 5f7a5d1..be41e47 100644 --- a/dali-toolkit/internal/controls/table-view/table-view-impl.h +++ b/dali-toolkit/internal/controls/table-view/table-view-impl.h @@ -1,21 +1,22 @@ #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. -// +/* + * Copyright (c) 2014 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. + * + */ // INTERNAL INCLUDES #include @@ -35,18 +36,18 @@ 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 ControlImpl +class TableView : public Control { public: /** - * Structure for the layout data + * Enum for the size policies of rows and columns */ - struct CellData + enum CellSizePolicy { - // data members - Actor actor; - Toolkit::TableView::CellPosition position; + FILL, ///< Fill up available space, may have a ratio associated with it + FIXED, ///< A specific fixed width or height + FIT ///< Fit around actors in the row or column }; /** @@ -58,22 +59,22 @@ public: /** * @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 @@ -126,24 +127,36 @@ public: Size GetCellPadding(); /** - * @copydoc Toolkit::TableView::SetFixedHeight + * @brief Set a row policy + * + * @param[in] rowIndex The row to set the policy for + * @param[in] policy The policy to set */ - void SetFixedHeight( unsigned int rowIndex, float height ); + void SetRowPolicy( unsigned int rowIndex, CellSizePolicy policy ); /** - * @copydoc Toolkit::TableView::GetFixedHeight + * @brief Querry a row policy + * + * @param[in] rowIndex The row to querry + * @return Return the policy */ - float GetFixedHeight( unsigned int rowIndex ) const; + CellSizePolicy GetRowPolicy( unsigned int rowIndex ) const; /** - * @copydoc Toolkit::TableView::SetRelativeHeight + * @brief Set a column policy + * + * @param[in] columnIndex The column to set the policy for + * @param[in] policy The policy to set */ - void SetRelativeHeight( unsigned int rowIndex, float heightPercentage ); + void SetColumnPolicy( unsigned int columnIndex, CellSizePolicy policy ); /** - * @copydoc Toolkit::TableView::GetRelativeHeight + * @brief Querry a column policy + * + * @param[in] columnIndex The column to querry + * @return Return the policy */ - float GetRelativeHeight( unsigned int rowIndex ) const; + CellSizePolicy GetColumnPolicy( unsigned int columnIndex ) const; /** * @copydoc Toolkit::TableView::SetFixedWidth @@ -156,25 +169,34 @@ public: 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::SetLayoutAnimationDuration + * @copydoc Toolkit::TableView::SetRelativeHeight */ - void SetLayoutAnimationDuration( float duration ); + void SetRelativeHeight( unsigned int rowIndex, float heightPercentage ); /** - * @copydoc Toolkit::TableView::GetLayoutAnimationDuration + * @copydoc Toolkit::TableView::GetRelativeHeight */ - float GetLayoutAnimationDuration(); + float GetRelativeHeight( unsigned int rowIndex ) const; + /** + * @copydoc Toolkit::TableView::SetRelativeWidth + */ + void SetRelativeWidth( unsigned int columnIndex, float widthPercentage ); + + /** + * @copydoc Toolkit::TableView::GetRelativeWidth + */ + float GetRelativeWidth( unsigned int columnIndex ) const; /** * @copydoc Toolkit::TableView::GetRows @@ -186,36 +208,147 @@ public: */ 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::OnControlChildAdd(Actor& child) + */ + virtual void OnControlChildAdd( Actor& child ); /** - * @copydoc Toolkit::ControlImpl::OnControlChildAdd(Actor& child) + * @copydoc Control::OnControlChildRemove(Actor& child) */ - virtual void OnControlChildAdd(Actor& child); + virtual void OnControlChildRemove( 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, Control::KeyboardFocusNavigationDirection direction, bool loopEnabled); + virtual Actor GetNextKeyboardFocusableActor( Actor currentFocusedActor, Toolkit::Control::KeyboardFocusNavigationDirection 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 ); 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 or FILL then size is the calculated value of size. + */ + struct RowColumnData + { + /** + * Default constructor + */ + RowColumnData() + : size( 0.0f ), + fillRatio( 0.0f ), + sizePolicy( FILL ), + userFillRatio( false ) + { + } + + /** + * 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, CellSizePolicy newSizePolicy, bool newUserFillRatio ) + : size( newSize ), + fillRatio( newFillRatio ), + sizePolicy( newSizePolicy ), + userFillRatio( newUserFillRatio ) + { + } + + float size; ///< Set or calculated size + float fillRatio; ///< Ratio to fill remaining space + CellSizePolicy sizePolicy; ///< The size policy used to interpret the size value + bool userFillRatio : 1; ///< FillRatio was set by user + }; + + typedef Dali::Vector 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 ); @@ -251,20 +384,98 @@ private: // Implementation * @param child actor to remove * @return true if the actor was found */ - bool RemoveAllInstances( Actor child ); + bool RemoveAllInstances( const Actor& child ); + + /** + * @brief Compute relative sizes for an array + * + * @param[in] data The RowColumn data to compute the relative sizes for + */ + void ComputeRelativeSizes( 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 fixed sizes for a row or column + * + * @param[in] data The row or column data to process + * @param[in] dimension The dimension being calculated: row == Dimension::HEIGHT, column == Dimension::WIDTH + */ + void CalculateFixedSizes( RowColumnArray& data, Dimension::Type dimension ); + + /** + * @brief Calculate the value of the relative sizes + * + * @param[in] data The row or column data to process + * @param[in] size The size of the table view in that dimension + */ + void CalculateRelativeSizes( RowColumnArray& data, float size ); + + /** + * @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 Calculate row and column data when it is dirty + */ + void CalculateRowColumnData(); /** - * 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 SetFixedWidths. + * @param[in] funcRelative The set function to call, it can be SetRelativeHeight or SetRelativeWidths. + * @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 ); + + /** + * 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 @@ -307,16 +518,15 @@ private: private: // Data - Array2d mCellData; - Array2d mRelativeSizes; - std::vector mFixedHeights; - std::vector mRelativeHeights; - std::vector mFixedWidths; - std::vector mRelativeWidths; - Size mPadding; - bool mLayoutingChild; - float mConstraintDuration; + Array2d 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 + bool mLayoutingChild; ///< Can't be a bitfield due to Relayouting lock + bool mRowColumnDirty : 1; ///< Flag to indicate the row column data is dirty }; } // namespace Internal