1 #ifndef __DALI_TOOLKIT_TABLE_VIEW_H__
2 #define __DALI_TOOLKIT_TABLE_VIEW_H__
5 * Copyright (c) 2015 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_IMPORT_API TableView : public Control
91 * @brief 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 An enumeration 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 An enumeration 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 An enumeration of child properties belonging to the TableView class.
153 * @brief An enumeration 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 Describes how the size of a row / column 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 Create a TableView handle; this can be initialised with TableView::New()
206 * Calling member functions with an uninitialised handle is not allowed.
212 * @brief Copy constructor. Creates another handle that points to the same real object
214 * @param[in] 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 Create 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 Downcast a handle to TableView handle.
246 * If handle points to a TableView the
247 * downcast produces valid handle. 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 to add
259 * @param[in] position for the child
260 * @return true if the addition succeeded, 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 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 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 childs layout position
287 * @param[in] child to search for
288 * @param[out] position for the child
289 * @return true if the child was included in this TableView
291 bool FindChildPosition( Actor child, CellPosition& position );
294 * @brief Insert a new row to given index
296 * @param [in] rowIndex of the new row
298 void InsertRow( unsigned int rowIndex );
301 * @brief Delete a row from given index
302 * Removed elements are deleted
304 * @param [in] rowIndex of the row to delete
306 void DeleteRow( unsigned int rowIndex );
309 * @brief Delete a row from given index
311 * @param [in] rowIndex of the row to delete
312 * @param [out] removed elements
314 void DeleteRow( unsigned int rowIndex, std::vector<Actor>& removed );
317 * @brief Insert a new column to given index
319 * @param [in] columnIndex of the new column
321 void InsertColumn( unsigned int columnIndex );
324 * @brief Delete a column from given index.
325 * Removed elements are deleted
327 * @param [in] columnIndex of the column to delete
329 void DeleteColumn( unsigned int columnIndex );
332 * @brief Delete a column from given index
334 * @param [in] columnIndex of the column to delete
335 * @param [out] removed elements
337 void DeleteColumn( unsigned int columnIndex, std::vector<Actor>& removed );
340 * @brief Resize the TableView.
342 * @param[in] rows for the table
343 * @param[in] 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 Resize the TableView.
354 * @param[in] rows for the table
355 * @param[in] columns for the table
356 * @param[out] removed actor handles
357 * @note If the new size is smaller than old,
358 * superfluous actors get removed.
359 * If an actor spans to a removed row or column it gets removed from the table.
361 void Resize( unsigned int rows, unsigned int columns, std::vector<Actor>& removed );
364 * @brief Set horizontal and vertical padding between cells
366 * @param[in] padding width and height
368 void SetCellPadding( Size padding );
371 * @brief Get the current padding as width and height.
373 * @return the current padding as width and height
375 Size GetCellPadding();
378 * @brief Specify this row as fitting its height to its children
381 * @param[in] rowIndex The row to set
383 void SetFitHeight( unsigned int rowIndex );
386 * @brief Is the row a fit row
389 * @param[in] rowIndex The row to check
390 * @return Return true if the row is fit
392 bool IsFitHeight( unsigned int rowIndex ) const;
395 * @brief Specify this column as fitting its width to its children
398 * @param[in] columnIndex The column to set
400 void SetFitWidth( unsigned int columnIndex );
403 * @brief Is the column a fit column
406 * @param[in] columnIndex The column to check
407 * @return Return true if the column is fit
409 bool IsFitWidth( unsigned int columnIndex ) const;
412 * @brief Sets a row to have fixed height
413 * Setting a fixed height of 0 has no effect
415 * @param rowIndex for row with fixed height
416 * @param height in world coordinate units
417 * @pre The row rowIndex must exist.
419 void SetFixedHeight( unsigned int rowIndex, float height );
422 * @brief Gets a row's fixed height.
424 * @param[in] rowIndex The row index with fixed height
425 * @return height in world coordinate units.
426 * @pre The row rowIndex must exist.
427 * @note The returned value is valid if it has been set before.
429 float GetFixedHeight( unsigned int rowIndex ) const;
432 * @brief Sets a row to have relative height. Relative height means percentage of
433 * the remainder of the table height after subtracting Padding and Fixed height rows
434 * Setting a relative height of 0 has no effect
436 * @param rowIndex for row with relative height
437 * @param heightPercentage between 0.0f and 1.0f
438 * @pre The row rowIndex must exist.
440 void SetRelativeHeight( unsigned int rowIndex, float heightPercentage );
443 * @brief Gets a row's relative height.
445 * @param[in] rowIndex The row index with relative height
446 * @return height in percentage units, between 0.0f and 1.0f.
447 * @pre The row rowIndex must exist.
448 * @note The returned value is valid if it has been set before.
450 float GetRelativeHeight( unsigned int rowIndex ) const;
453 * @brief Sets a column to have fixed width
454 * Setting a fixed width of 0 has no effect
456 * @param columnIndex for column with fixed width
457 * @param width in world coordinate units
458 * @pre The column columnIndex must exist.
460 void SetFixedWidth( unsigned int columnIndex, float width );
463 * @brief Gets a column's fixed width.
465 * @param[in] columnIndex The column index with fixed width
466 * @return width in world coordinate units.
467 * @pre The column columnIndex must exist.
468 * @note The returned value is valid if it has been set before.
470 float GetFixedWidth( unsigned int columnIndex ) const;
473 * @brief Sets a column to have relative width. Relative width means percentage of
474 * the remainder of table width after subtracting Padding and Fixed width columns
475 * Setting a relative width of 0 has no effect
477 * @param columnIndex for column with fixed width
478 * @param widthPercentage between 0.0f and 1.0f
479 * @pre The column columnIndex must exist.
481 void SetRelativeWidth( unsigned int columnIndex, float widthPercentage );
484 * @brief Gets a column's relative width.
486 * @param[in] columnIndex The column index with relative width
487 * @return width in percentage units, between 0.0f and 1.0f.
488 * @pre The column columnIndex must exist.
489 * @note The returned value is valid if it has been set before.
491 float GetRelativeWidth( unsigned int columnIndex ) const;
494 * @brief Gets the amount of rows in the table.
496 * @return the amount of rows in the table
498 unsigned int GetRows();
501 * @brief Gets the amount of columns in the table.
503 * @return the amount of columns in the table
505 unsigned int GetColumns();
508 * @brief Set the alignment on a cell.
510 * Cells without calling this function have the default values of LEFT and TOP respectively.
513 * @param[in] position The cell to set alignment on.
514 * @param[in] horizontal The horizontal alignment.
515 * @param[in] vertical The vertical alignment.
517 void SetCellAlignment( CellPosition position, HorizontalAlignment::Type horizontal, VerticalAlignment::Type vertical );
519 public: // Not intended for application developers
523 * @brief Creates a handle using the Toolkit::Internal implementation.
525 * @param[in] implementation The Control implementation.
527 DALI_INTERNAL TableView(Internal::TableView& implementation);
530 * @brief Allows the creation of this Control from an Internal::CustomActor pointer.
532 * @param[in] internal A pointer to the internal CustomActor.
534 explicit DALI_INTERNAL TableView( Dali::Internal::CustomActor* internal );
541 } // namespace Toolkit
545 #endif // __DALI_TOOLKIT_TABLE_VIEW_H__