1 #ifndef DALI_TOOLKIT_TABLE_VIEW_H
2 #define DALI_TOOLKIT_TABLE_VIEW_H
5 * Copyright (c) 2019 Samsung Electronics Co., Ltd.
7 * Licensed under the Apache License, Version 2.0 (the "License");
8 * you may not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
11 * http://www.apache.org/licenses/LICENSE-2.0
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS,
15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
22 #include <dali/public-api/common/vector-wrapper.h>
23 #include <dali/public-api/actors/actor-enumerations.h>
26 #include <dali-toolkit/public-api/controls/control.h>
34 namespace Internal DALI_INTERNAL
39 * @addtogroup dali_toolkit_controls_table_view
44 * @brief TableView is a layout container for aligning child actors in a grid like layout.
46 * TableView constrains the x and y position and width and height of the child actors.
47 * z position and depth are left intact so that 3D model actors can also be laid out
48 * in a grid without loosing their depth scaling.
51 * <h3>Per-child Custom properties for script supporting:</h3>
53 * When an actor is add to the tableView through Actor::Add() instead of TableView::AddChild,
54 * the following custom properties of the actor are checked to decide the actor position inside the table.
56 * These properties are registered dynamically to the child and is non-animatable.
58 * | %Property Name | Type |
59 * |-------------------------|-------------|
60 * | cellIndex | Vector2 |
62 * | columnSpan | float |
63 * | cellHorizontalAlignment | string |
64 * | cellVerticalAlignment | string |
66 * The rowSpan or columnSpan has integer value, but its type is float here due to the limitation of the builder's ability to differentiate integer and float from Json string.
67 * The available values for cellHorizontalAlignment are: left, center, right.
68 * The available values for cellVerticalAlignment are: top, center, bottom.
74 * "url": "{DALI_IMAGE_DIR}gallery-small-1.jpg"
77 * "cellIndex":[1,1], // Property to specify the top-left cell this child occupies, if not set, the first available cell is used
78 * "rowSpan":3, // Property to specify how many rows this child occupies, if not set, default value is 1
79 * "columnSpan": 2, // Property to specify how many columns this child occupies, if nor set, default value is 1
80 * "cellHorizontalAlignment": "left", // Property to specify how to align horizontally inside the cells, if not set, default value is 'left'
81 * "cellVerticalAlignment": "center" // Property to specify how to align vertically inside the cells, if not set, default value is 'top'
86 class DALI_TOOLKIT_API TableView : public Control
91 * @brief Enumeration for the start and end property ranges for this control.
96 PROPERTY_START_INDEX = Control::CONTROL_PROPERTY_END_INDEX + 1, ///< @SINCE_1_0.0
97 PROPERTY_END_INDEX = PROPERTY_START_INDEX + 1000, ///< Reserve property indices @SINCE_1_0.0
99 CHILD_PROPERTY_START_INDEX = CHILD_PROPERTY_REGISTRATION_START_INDEX, ///< @SINCE_1_1.36
100 CHILD_PROPERTY_END_INDEX = CHILD_PROPERTY_REGISTRATION_START_INDEX + 1000 ///< Reserve child property indices @SINCE_1_1.36
104 * @brief Enumeration for the instance of properties belonging to the TableView class.
106 * LayoutRows: set the height of the rows.
107 * It has the format as follows in script:
111 * "0": { "policy": "fixed", "value": 40 }, //@see SetFixedHight
112 * "2": { "policy": "relative", "value": 0.33 }, //@see SetRelativeHeight
113 * "3": { "policy": "fit", "value":0.0 } //@see SetFitHeight, the value is not used, its height is decided by the children in this row
117 * LayoutColumns: set the width of the columns.
118 * It has the format as follows in script:
122 * "0": { "policy": "fixed", "value": 40 }, //@see SetFixedWidth
123 * "1": { "policy": "fit", "value":0.0 } //@see SetFitHeight, the value is not used, its width is decided by the children in this column
124 * "2": { "policy": "relative", "value": 0.33 } //@see SetRelativeWidth
132 * @brief Enumeration for the instance of properties belonging to the TableView class.
138 ROWS = PROPERTY_START_INDEX, ///< name "rows", type unsigned int @SINCE_1_0.0
139 COLUMNS, ///< name "columns", type unsigned int @SINCE_1_0.0
140 CELL_PADDING, ///< name "cellPadding", type Vector2 @SINCE_1_0.0
141 LAYOUT_ROWS, ///< name "layoutRows", type Map @SINCE_1_0.0
142 LAYOUT_COLUMNS, ///< name "layoutColumns", type Map @SINCE_1_0.0
147 * @brief Enumeration for the instance of child properties belonging to the TableView class.
153 * @brief Enumeration for the instance of child properties belonging to the TableView class.
158 CELL_INDEX = CHILD_PROPERTY_START_INDEX, ///< name "cellIndex", The top-left cell this child occupies, if not set, the first available cell is used, type VECTOR2 @SINCE_1_1.36
159 ROW_SPAN, ///< name "rowSpan", The number of rows this child occupies, if not set, default value is 1, type FLOAT @SINCE_1_1.36
160 COLUMN_SPAN, ///< name "columnSpan", The number of columns this child occupies, if not set, default value is 1, type FLOAT @SINCE_1_1.36
161 CELL_HORIZONTAL_ALIGNMENT, ///< name "cellHorizontalAlignment", The horizontal alignment of this child inside the cells, if not set, default value is 'left', type STRING @SINCE_1_1.36
162 CELL_VERTICAL_ALIGNMENT ///< name "cellVerticalAlignment", The vertical alignment of this child inside the cells, if not set, default value is 'top', type STRING @SINCE_1_1.36
167 * @brief Enumeration for describing how the size of a row / column has been set.
172 FIXED, ///< Fixed with the given value. @SINCE_1_0.0
173 RELATIVE, ///< Calculated as percentage of the remainder after subtracting Padding and Fixed height/width @SINCE_1_0.0
174 FILL, ///< Default policy, get the remainder of the 100% (after subtracting Fixed, Fit and Relative height/ width) divided evenly between 'fill' rows/columns @SINCE_1_0.0
175 FIT ///< Fit around its children. @SINCE_1_0.0
179 * @brief Structure to specify layout position for child actor.
185 * @brief Constructor to initialise values to defaults for convenience.
187 * @param[in] rowIndex The row index initialized
188 * @param[in] columnIndex The column index initialized
189 * @param[in] rowSpan The row span initialized
190 * @param[in] columnSpan The column span initialized
192 CellPosition( unsigned int rowIndex = 0, unsigned int columnIndex = 0,
193 unsigned int rowSpan = 1, unsigned int columnSpan = 1 )
194 : rowIndex( rowIndex ), columnIndex( columnIndex ),
195 rowSpan( rowSpan ), columnSpan( columnSpan )
198 unsigned int rowIndex;
199 unsigned int columnIndex;
200 unsigned int rowSpan;
201 unsigned int columnSpan;
205 * @brief Creates a TableView handle; this can be initialized with TableView::New().
206 * Calling member functions with an uninitialized handle is not allowed.
212 * @brief Copy constructor. Creates another handle that points to the same real object.
214 * @param[in] handle Handle to copy from
216 TableView( const TableView& handle );
219 * @brief Assignment operator. Changes this handle to point to another real object.
221 * @param[in] handle Handle to an object
222 * @return A reference to this
224 TableView& operator=( const TableView& handle );
229 * This is non-virtual since derived Handle types must not contain data or virtual methods.
235 * @brief Creates the TableView control.
237 * @param[in] initialRows for the table
238 * @param[in] initialColumns for the table
239 * @return A handle to the TableView control
241 static TableView New( unsigned int initialRows, unsigned int initialColumns );
244 * @brief Downcasts a handle to TableView handle.
246 * If handle points to a TableView, the downcast produces valid handle.
247 * If not, the returned handle is left uninitialized.
249 * @param[in] handle Handle to an object
250 * @return Handle to a TableView or an uninitialized handle
252 static TableView DownCast( BaseHandle handle );
255 * @brief Adds a child to the table.
256 * If the row or column index is outside the table, the table gets resized bigger.
258 * @param[in] child The child to add
259 * @param[in] position The position for the child
260 * @return @c true if the addition succeeded, @c false if the cell is already occupied
261 * @pre The child actor has been initialized.
263 bool AddChild( Actor child, CellPosition position );
266 * @brief Returns a child from the given layout position.
268 * @param[in] position The position in the table
269 * @return Child that was in the cell or an uninitialized handle
270 * @note If there is no child in this position this method returns an uninitialized.
273 Actor GetChildAt( CellPosition position );
276 * @brief Removes a child from the given layout position.
278 * @param[in] position The position for the child to remove
279 * @return Child that was removed or an uninitialized handle
280 * @note If there is no child in this position, this method does nothing.
282 Actor RemoveChildAt( CellPosition position );
285 * @brief Finds the child's layout position.
287 * @param[in] child The child to search for
288 * @param[out] position The position for the child
289 * @return true if the child was included in this TableView
291 bool FindChildPosition( Actor child, CellPosition& position );
294 * @brief Inserts a new row to given index.
296 * @param[in] rowIndex The rowIndex of the new row
298 void InsertRow( unsigned int rowIndex );
301 * @brief Deletes a row from the given index.
302 * Removed elements are deleted.
304 * @param[in] rowIndex The rowIndex of the row to delete
306 void DeleteRow( unsigned int rowIndex );
309 * @brief Deletes a row from the given index.
311 * @param[in] rowIndex The rowIndex of the row to delete
312 * @param[out] removed The removed elements
314 void DeleteRow( unsigned int rowIndex, std::vector<Actor>& removed );
317 * @brief Inserts a new column to the given index.
319 * @param[in] columnIndex The columnIndex of the new column
321 void InsertColumn( unsigned int columnIndex );
324 * @brief Deletes a column from the given index.
325 * Removed elements are deleted.
327 * @param[in] columnIndex The columnIndex of the column to delete
329 void DeleteColumn( unsigned int columnIndex );
332 * @brief Deletes a column from the given index.
334 * @param[in] columnIndex The columnIndex of the column to delete
335 * @param[out] removed The removed elements
337 void DeleteColumn( unsigned int columnIndex, std::vector<Actor>& removed );
340 * @brief Resizes the TableView.
342 * @param[in] rows The rows for the table
343 * @param[in] columns The columns for the table
344 * @note If the new size is smaller than old,
345 * superfluous actors get removed. If you want to relayout removed children,
346 * use the variant that returns the removed Actors and reinsert them into the table.
347 * If an actor spans to a removed row or column, it gets removed from the table.
349 void Resize( unsigned int rows, unsigned int columns );
352 * @brief Resizes the TableView.
354 * @param[in] rows The rows for the table
355 * @param[in] columns The columns for the table
356 * @param[out] removed The removed actor handles
357 * @note If the new size is smaller than old, superfluous actors get removed.
358 * If an actor spans to a removed row or column it gets removed from the table.
360 void Resize( unsigned int rows, unsigned int columns, std::vector<Actor>& removed );
363 * @brief Sets horizontal and vertical padding between cells.
365 * @param[in] padding Width and height
367 void SetCellPadding( Size padding );
370 * @brief Gets the current padding as width and height.
372 * @return The current padding as width and height
374 Size GetCellPadding();
377 * @brief Specifies this row as fitting its height to its children.
380 * @param[in] rowIndex The row to set
382 void SetFitHeight( unsigned int rowIndex );
385 * @brief Checks if the row is a fit row.
388 * @param[in] rowIndex The row to check
389 * @return Return true if the row is fit
391 bool IsFitHeight( unsigned int rowIndex ) const;
394 * @brief Specifies this column as fitting its width to its children.
397 * @param[in] columnIndex The column to set
399 void SetFitWidth( unsigned int columnIndex );
402 * @brief Checks if the column is a fit column.
405 * @param[in] columnIndex The column to check
406 * @return Return true if the column is fit
408 bool IsFitWidth( unsigned int columnIndex ) const;
411 * @brief Sets a row to have fixed height.
412 * Setting a fixed height of 0 has no effect.
414 * @param rowIndex The rowIndex for row with fixed height
415 * @param height The height in world coordinate units
416 * @pre The row rowIndex must exist.
418 void SetFixedHeight( unsigned int rowIndex, float height );
421 * @brief Gets a row's fixed height.
423 * @param[in] rowIndex The row index with fixed height
424 * @return height The height in world coordinate units
425 * @pre The row rowIndex must exist.
426 * @note The returned value is valid if it has been set before.
428 float GetFixedHeight( unsigned int rowIndex ) const;
431 * @brief Sets a row to have relative height. Relative height means percentage of
432 * the remainder of the table height after subtracting Padding and Fixed height rows.
433 * Setting a relative height of 0 has no effect.
435 * @param rowIndex The rowIndex for row with relative height
436 * @param heightPercentage between 0.0f and 1.0f
437 * @pre The row rowIndex must exist.
439 void SetRelativeHeight( unsigned int rowIndex, float heightPercentage );
442 * @brief Gets a row's relative height.
444 * @param[in] rowIndex The row index with relative height
445 * @return Height in percentage units, between 0.0f and 1.0f
446 * @pre The row rowIndex must exist.
447 * @note The returned value is valid if it has been set before.
449 float GetRelativeHeight( unsigned int rowIndex ) const;
452 * @brief Sets a column to have fixed width.
453 * Setting a fixed width of 0 has no effect.
455 * @param columnIndex The columnIndex for column with fixed width
456 * @param width The width in world coordinate units
457 * @pre The column columnIndex must exist.
459 void SetFixedWidth( unsigned int columnIndex, float width );
462 * @brief Gets a column's fixed width.
464 * @param[in] columnIndex The column index with fixed width
465 * @return Width in world coordinate units
466 * @pre The column columnIndex must exist.
467 * @note The returned value is valid if it has been set before.
469 float GetFixedWidth( unsigned int columnIndex ) const;
472 * @brief Sets a column to have relative width. Relative width means percentage of
473 * the remainder of table width after subtracting Padding and Fixed width columns.
474 * Setting a relative width of 0 has no effect.
476 * @param columnIndex The columnIndex for column with fixed width
477 * @param widthPercentage The widthPercentage between 0.0f and 1.0f
478 * @pre The column columnIndex must exist.
480 void SetRelativeWidth( unsigned int columnIndex, float widthPercentage );
483 * @brief Gets a column's relative width.
485 * @param[in] columnIndex The column index with relative width
486 * @return Width in percentage units, between 0.0f and 1.0f
487 * @pre The column columnIndex must exist.
488 * @note The returned value is valid if it has been set before.
490 float GetRelativeWidth( unsigned int columnIndex ) const;
493 * @brief Gets the amount of rows in the table.
495 * @return The amount of rows in the table
497 unsigned int GetRows();
500 * @brief Gets the amount of columns in the table.
502 * @return The amount of columns in the table
504 unsigned int GetColumns();
507 * @brief Sets the alignment on a cell.
509 * Cells without calling this function have the default values of LEFT and TOP respectively.
512 * @param[in] position The cell to set alignment on
513 * @param[in] horizontal The horizontal alignment
514 * @param[in] vertical The vertical alignment
516 void SetCellAlignment( CellPosition position, HorizontalAlignment::Type horizontal, VerticalAlignment::Type vertical );
518 public: // Not intended for application developers
522 * @brief Creates a handle using the Toolkit::Internal implementation.
524 * @param[in] implementation The Control implementation
526 DALI_INTERNAL TableView(Internal::TableView& implementation);
529 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
531 * @param[in] internal A pointer to the internal CustomActor
533 explicit DALI_INTERNAL TableView( Dali::Internal::CustomActor* internal );
540 } // namespace Toolkit
544 #endif // DALI_TOOLKIT_TABLE_VIEW_H