1 /** Copyright (c) 2017 Samsung Electronics Co., Ltd.
3 * Licensed under the Apache License, Version 2.0 (the "License");
4 * you may not use this file except in compliance with the License.
5 * You may obtain a copy of the License at
7 * http://www.apache.org/licenses/LICENSE-2.0
9 * Unless required by applicable law or agreed to in writing, software
10 * distributed under the License is distributed on an "AS IS" BASIS,
11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 * See the License for the specific language governing permissions and
13 * limitations under the License.
16 // This File has been auto-generated by SWIG and then modified using DALi Ruby Scripts
17 //------------------------------------------------------------------------------
20 // This file was automatically generated by SWIG (http://www.swig.org).
23 // Do not make changes to this file unless you know what you are doing--modify
24 // the SWIG interface file instead.
25 //------------------------------------------------------------------------------
27 using Tizen.NUI.BaseComponents;
31 using Tizen.NUI.BaseComponents;
33 /// TableView is a layout container for aligning child actors in a grid like layout.<br>
34 /// TableView constrains the x and y position and width and height of the child actors.<br>
35 /// z position and depth are left intact so that 3D model actors can also be laid out
36 /// in a grid without loosing their depth scaling.<br>
38 public class TableView : View
40 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
42 internal TableView(global::System.IntPtr cPtr, bool cMemoryOwn) : base(NDalicPINVOKE.TableView_SWIGUpcast(cPtr), cMemoryOwn)
44 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
47 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(TableView obj)
49 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
52 protected override void Dispose(DisposeTypes type)
59 if(type == DisposeTypes.Explicit)
62 //Release your own managed resources here.
63 //You should release all of your own disposable objects here.
66 //Release your own unmanaged resources here.
67 //You should not access any managed member here except static instance.
68 //because the execution order of Finalizes is non-deterministic.
70 if (swigCPtr.Handle != global::System.IntPtr.Zero)
75 NDalicPINVOKE.delete_TableView(swigCPtr);
77 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
84 internal class Property
86 internal static readonly int ROWS = NDalicPINVOKE.TableView_Property_ROWS_get();
87 internal static readonly int COLUMNS = NDalicPINVOKE.TableView_Property_COLUMNS_get();
88 internal static readonly int CELL_PADDING = NDalicPINVOKE.TableView_Property_CELL_PADDING_get();
89 internal static readonly int LAYOUT_ROWS = NDalicPINVOKE.TableView_Property_LAYOUT_ROWS_get();
90 internal static readonly int LAYOUT_COLUMNS = NDalicPINVOKE.TableView_Property_LAYOUT_COLUMNS_get();
93 internal class ChildProperty
95 internal static readonly int CELL_INDEX = NDalicPINVOKE.TableView_ChildProperty_CELL_INDEX_get();
96 internal static readonly int ROW_SPAN = NDalicPINVOKE.TableView_ChildProperty_ROW_SPAN_get();
97 internal static readonly int COLUMN_SPAN = NDalicPINVOKE.TableView_ChildProperty_COLUMN_SPAN_get();
98 internal static readonly int CELL_HORIZONTAL_ALIGNMENT = NDalicPINVOKE.TableView_ChildProperty_CELL_HORIZONTAL_ALIGNMENT_get();
99 internal static readonly int CELL_VERTICAL_ALIGNMENT = NDalicPINVOKE.TableView_ChildProperty_CELL_VERTICAL_ALIGNMENT_get();
103 /// Class to specify layout position for child view.
105 public class CellPosition : global::System.IDisposable
107 private global::System.Runtime.InteropServices.HandleRef swigCPtr;
108 protected bool swigCMemOwn;
110 internal CellPosition(global::System.IntPtr cPtr, bool cMemoryOwn)
112 swigCMemOwn = cMemoryOwn;
113 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(this, cPtr);
116 internal static global::System.Runtime.InteropServices.HandleRef getCPtr(CellPosition obj)
118 return (obj == null) ? new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero) : obj.swigCPtr;
121 //A Flag to check who called Dispose(). (By User or DisposeQueue)
122 private bool isDisposeQueued = false;
123 //A Flat to check if it is already disposed.
124 protected bool disposed = false;
130 isDisposeQueued = true;
131 DisposeQueue.Instance.Add(this);
135 public void Dispose()
137 //Throw excpetion if Dispose() is called in separate thread.
138 if (!Window.IsInstalled())
140 throw new System.InvalidOperationException("This API called from separate thread. This API must be called from MainThread.");
145 Dispose(DisposeTypes.Implicit);
149 Dispose(DisposeTypes.Explicit);
150 System.GC.SuppressFinalize(this);
154 protected virtual void Dispose(DisposeTypes type)
161 if(type == DisposeTypes.Explicit)
164 //Release your own managed resources here.
165 //You should release all of your own disposable objects here.
168 //Release your own unmanaged resources here.
169 //You should not access any managed member here except static instance.
170 //because the execution order of Finalizes is non-deterministic.
172 if (swigCPtr.Handle != global::System.IntPtr.Zero)
177 NDalicPINVOKE.delete_TableView_CellPosition(swigCPtr);
179 swigCPtr = new global::System.Runtime.InteropServices.HandleRef(null, global::System.IntPtr.Zero);
187 /// <param name="rowIndex">The row index initialized</param>
188 /// <param name="columnIndex">The column index initialized</param>
189 /// <param name="rowSpan">The row span initialized</param>
190 /// <param name="columnSpan">The column span initialized</param>
191 public CellPosition(uint rowIndex, uint columnIndex, uint rowSpan, uint columnSpan) : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_0(rowIndex, columnIndex, rowSpan, columnSpan), true)
193 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
197 /// Constructor to initialise values to defaults for convenience.
199 /// <param name="rowIndex">The row index initialized</param>
200 /// <param name="columnIndex">The column index initialized</param>
201 /// <param name="rowSpan">The row span initialized</param>
202 public CellPosition(uint rowIndex, uint columnIndex, uint rowSpan) : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_1(rowIndex, columnIndex, rowSpan), true)
204 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
208 /// Constructor to initialise values to defaults for convenience.
210 /// <param name="rowIndex">The row index initialized</param>
211 /// <param name="columnIndex">The column index initialized</param>
212 public CellPosition(uint rowIndex, uint columnIndex) : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_2(rowIndex, columnIndex), true)
214 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
218 /// Constructor to initialise values to defaults for convenience.
220 /// <param name="rowIndex">The row index initialized</param>
221 public CellPosition(uint rowIndex) : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_3(rowIndex), true)
223 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
227 /// Default constructor
229 public CellPosition() : this(NDalicPINVOKE.new_TableView_CellPosition__SWIG_4(), true)
231 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
241 NDalicPINVOKE.TableView_CellPosition_rowIndex_set(swigCPtr, value);
242 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
246 uint ret = NDalicPINVOKE.TableView_CellPosition_rowIndex_get(swigCPtr);
247 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
255 public uint columnIndex
259 NDalicPINVOKE.TableView_CellPosition_columnIndex_set(swigCPtr, value);
260 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
264 uint ret = NDalicPINVOKE.TableView_CellPosition_columnIndex_get(swigCPtr);
265 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
277 NDalicPINVOKE.TableView_CellPosition_rowSpan_set(swigCPtr, value);
278 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
282 uint ret = NDalicPINVOKE.TableView_CellPosition_rowSpan_get(swigCPtr);
283 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
291 public uint columnSpan
295 NDalicPINVOKE.TableView_CellPosition_columnSpan_set(swigCPtr, value);
296 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
300 uint ret = NDalicPINVOKE.TableView_CellPosition_columnSpan_get(swigCPtr);
301 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
309 /// Creates the TableView view.
311 /// <param name="initialRows">initialRows for the table</param>
312 /// <param name="initialColumns">initialColumns for the table</param>
313 public TableView(uint initialRows, uint initialColumns) : this(NDalicPINVOKE.TableView_New(initialRows, initialColumns), true)
315 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
320 /// Copy constructor. Creates another handle that points to the same real object.
322 /// <param name="handle">Handle to copy from</param>
323 public TableView(TableView handle) : this(NDalicPINVOKE.new_TableView__SWIG_1(TableView.getCPtr(handle)), true)
325 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
329 /// Adds a child to the table.<br>
330 /// If the row or column index is outside the table, the table gets resized bigger.<br>
332 /// <param name="child">The child to add</param>
333 /// <param name="position">The position for the child</param>
334 /// <returns>Tue if the addition succeeded and false if the cell is already occupied</returns>
335 public bool AddChild(View child, TableView.CellPosition position)
337 bool ret = NDalicPINVOKE.TableView_AddChild(swigCPtr, View.getCPtr(child), TableView.CellPosition.getCPtr(position));
338 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
343 /// Returns a child from the given layout position.
345 /// <param name="position">The position in the table</param>
346 /// <returns>Child that was in the cell or an uninitialized handle</returns>
347 public View GetChildAt(TableView.CellPosition position)
349 View ret = new View(NDalicPINVOKE.TableView_GetChildAt(swigCPtr, TableView.CellPosition.getCPtr(position)), true);
350 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
355 /// Removes a child from the given layout position.
357 /// <param name="position">The position for the child to remove</param>
358 /// <returns>Child that was removed or an uninitialized handle</returns>
359 public View RemoveChildAt(TableView.CellPosition position)
361 View ret = new View(NDalicPINVOKE.TableView_RemoveChildAt(swigCPtr, TableView.CellPosition.getCPtr(position)), true);
362 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
367 /// Finds the child's layout position.
369 /// <param name="child">The child to search for</param>
370 /// <param name="position">The position for the child</param>
371 /// <returns>true if the child was included in this TableView</returns>
372 public bool FindChildPosition(View child, TableView.CellPosition position)
374 bool ret = NDalicPINVOKE.TableView_FindChildPosition(swigCPtr, View.getCPtr(child), TableView.CellPosition.getCPtr(position));
375 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
380 /// Inserts a new row to given index.
382 /// <param name="rowIndex">The rowIndex of the new row</param>
383 public void InsertRow(uint rowIndex)
385 NDalicPINVOKE.TableView_InsertRow(swigCPtr, rowIndex);
386 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
390 /// Deletes a row from the given index.<br>
391 /// Removed elements are deleted.<br>
393 /// <param name="rowIndex">The rowIndex of the row to delete</param>
394 public void DeleteRow(uint rowIndex)
396 NDalicPINVOKE.TableView_DeleteRow__SWIG_0(swigCPtr, rowIndex);
397 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
401 /// Inserts a new column to the given index.
403 /// <param name="columnIndex">The columnIndex of the new column</param>
404 public void InsertColumn(uint columnIndex)
406 NDalicPINVOKE.TableView_InsertColumn(swigCPtr, columnIndex);
407 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
411 /// Deletes a column from the given index.<br>
412 /// Removed elements are deleted.<br>
414 /// <param name="columnIndex">The columnIndex of the column to delete</param>
415 public void DeleteColumn(uint columnIndex)
417 NDalicPINVOKE.TableView_DeleteColumn__SWIG_0(swigCPtr, columnIndex);
418 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
422 /// Resizes the TableView.
424 /// <param name="rows">The rows for the table</param>
425 /// <param name="columns">The columns for the table</param>
426 public void Resize(uint rows, uint columns)
428 NDalicPINVOKE.TableView_Resize__SWIG_0(swigCPtr, rows, columns);
429 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
433 /// Sets horizontal and vertical padding between cells.
435 /// <param name="padding">Width and height</param>
436 public void SetCellPadding(Size2D padding)
438 NDalicPINVOKE.TableView_SetCellPadding(swigCPtr, Size2D.getCPtr(padding));
439 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
443 /// Gets the current padding as width and height.
445 /// <returns>The current padding as width and height</returns>
446 public Vector2 GetCellPadding()
448 Vector2 ret = new Vector2(NDalicPINVOKE.TableView_GetCellPadding(swigCPtr), true);
449 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
454 /// Specifies this row as fitting its height to its children.
456 /// <param name="rowIndex">The row to set</param>
457 public void SetFitHeight(uint rowIndex)
459 NDalicPINVOKE.TableView_SetFitHeight(swigCPtr, rowIndex);
460 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
464 /// Checks if the row is a fit row.
466 /// <param name="rowIndex">The row to check</param>
467 /// <returns>true if the row is fit</returns>
468 public bool IsFitHeight(uint rowIndex)
470 bool ret = NDalicPINVOKE.TableView_IsFitHeight(swigCPtr, rowIndex);
471 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
476 /// Specifies this column as fitting its width to its children.
478 /// <param name="columnIndex">The column to set</param>
479 public void SetFitWidth(uint columnIndex)
481 NDalicPINVOKE.TableView_SetFitWidth(swigCPtr, columnIndex);
482 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
486 /// Checks if the column is a fit column.
488 /// <param name="columnIndex">The column to check</param>
489 /// <returns>true if the column is fit</returns>
490 public bool IsFitWidth(uint columnIndex)
492 bool ret = NDalicPINVOKE.TableView_IsFitWidth(swigCPtr, columnIndex);
493 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
498 /// Sets a row to have fixed height.<br>
499 /// Setting a fixed height of 0 has no effect.<br>
501 /// <param name="rowIndex">The rowIndex for row with fixed height</param>
502 /// <param name="height">The height in world coordinate units</param>
503 public void SetFixedHeight(uint rowIndex, float height)
505 NDalicPINVOKE.TableView_SetFixedHeight(swigCPtr, rowIndex, height);
506 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
510 /// Gets a row's fixed height.
512 /// <param name="rowIndex">The row index with fixed height</param>
513 /// <returns>height The height in world coordinate units</returns>
514 public float GetFixedHeight(uint rowIndex)
516 float ret = NDalicPINVOKE.TableView_GetFixedHeight(swigCPtr, rowIndex);
517 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
522 /// Sets a row to have relative height. Relative height means percentage of
523 /// the remainder of the table height after subtracting Padding and Fixed height rows.<br>
524 /// Setting a relative height of 0 has no effect.<br>
526 /// <param name="rowIndex">The rowIndex for row with relative height</param>
527 /// <param name="heightPercentage">The height percentage between 0.0f and 1.0f</param>
528 public void SetRelativeHeight(uint rowIndex, float heightPercentage)
530 NDalicPINVOKE.TableView_SetRelativeHeight(swigCPtr, rowIndex, heightPercentage);
531 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
535 /// Gets a row's relative height.
537 /// <param name="rowIndex">The row index with relative height</param>
538 /// <returns>Height in percentage units, between 0.0f and 1.0f</returns>
539 public float GetRelativeHeight(uint rowIndex)
541 float ret = NDalicPINVOKE.TableView_GetRelativeHeight(swigCPtr, rowIndex);
542 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
547 /// Sets a column to have fixed width.<br>
548 /// Setting a fixed width of 0 has no effect.<br>
550 /// <param name="columnIndex">The columnIndex for column with fixed width</param>
551 /// <param name="width">The width in world coordinate units</param>
552 public void SetFixedWidth(uint columnIndex, float width)
554 NDalicPINVOKE.TableView_SetFixedWidth(swigCPtr, columnIndex, width);
555 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
559 /// Gets a column's fixed width.
561 /// <param name="columnIndex">The column index with fixed width</param>
562 /// <returns>Width in world coordinate units</returns>
563 public float GetFixedWidth(uint columnIndex)
565 float ret = NDalicPINVOKE.TableView_GetFixedWidth(swigCPtr, columnIndex);
566 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
571 /// Sets a column to have relative width. Relative width means percentage of
572 /// the remainder of table width after subtracting Padding and Fixed width columns.<br>
573 /// Setting a relative width of 0 has no effect.<br>
575 /// <param name="columnIndex">The columnIndex for column with fixed width</param>
576 /// <param name="widthPercentage">The widthPercentage between 0.0f and 1.0f</param>
577 public void SetRelativeWidth(uint columnIndex, float widthPercentage)
579 NDalicPINVOKE.TableView_SetRelativeWidth(swigCPtr, columnIndex, widthPercentage);
580 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
584 /// Gets a column's relative width.
586 /// <param name="columnIndex">The column index with relative width</param>
587 /// <returns>Width in percentage units, between 0.0f and 1.0f</returns>
588 public float GetRelativeWidth(uint columnIndex)
590 float ret = NDalicPINVOKE.TableView_GetRelativeWidth(swigCPtr, columnIndex);
591 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
596 /// Sets the alignment on a cell.<br>
597 /// Cells without calling this function have the default values of LEFT and TOP respectively.<br>
599 /// <param name="position">The cell to set alignment on</param>
600 /// <param name="horizontal">The horizontal alignment</param>
601 /// <param name="vertical">The vertical alignment</param>
602 public void SetCellAlignment(TableView.CellPosition position, HorizontalAlignmentType horizontal, VerticalAlignmentType vertical)
604 NDalicPINVOKE.TableView_SetCellAlignment(swigCPtr, TableView.CellPosition.getCPtr(position), (int)horizontal, (int)vertical);
605 if (NDalicPINVOKE.SWIGPendingException.Pending) throw NDalicPINVOKE.SWIGPendingException.Retrieve();
609 /// Enumeration for describing how the size of a row / column has been set.
611 public enum LayoutPolicy
620 /// the amount of rows in the table.
627 GetProperty(TableView.Property.ROWS).Get(out temp);
632 SetProperty(TableView.Property.ROWS, new Tizen.NUI.PropertyValue(value));
636 /// the amount of columns in the table.
643 GetProperty(TableView.Property.COLUMNS).Get(out temp);
648 SetProperty(TableView.Property.COLUMNS, new Tizen.NUI.PropertyValue(value));
652 /// padding between cells.
654 public Vector2 CellPadding
658 Vector2 temp = new Vector2(0.0f, 0.0f);
659 GetProperty(TableView.Property.CELL_PADDING).Get(temp);
664 SetProperty(TableView.Property.CELL_PADDING, new Tizen.NUI.PropertyValue(value));
669 /// The number of layout rows
671 public PropertyMap LayoutRows
675 PropertyMap temp = new PropertyMap();
676 GetProperty(TableView.Property.LAYOUT_ROWS).Get(temp);
681 SetProperty(TableView.Property.LAYOUT_ROWS, new Tizen.NUI.PropertyValue(value));
686 /// The number of layout columns
688 public PropertyMap LayoutColumns
692 PropertyMap temp = new PropertyMap();
693 GetProperty(TableView.Property.LAYOUT_COLUMNS).Get(temp);
698 SetProperty(TableView.Property.LAYOUT_COLUMNS, new Tizen.NUI.PropertyValue(value));