NewModelViewArchitecture - Revision history

Timotei: /* Process */

2014-08-15T18:44:14Z

‎Process

Timotei: /* Process */

2014-08-15T15:54:29Z

‎Process

Timotei: Add performance process

2014-08-08T19:29:25Z

Add performance process

Timotei: /* List rendering */

2014-05-23T21:27:38Z

‎List rendering

Timotei: update: dumb model index, itemdata role and row/column -> children

2014-05-23T21:26:53Z

update: dumb model index, itemdata role and row/column -> children

Timotei: add tree rendering workflow (part 1)

2014-05-19T23:09:16Z

add tree rendering workflow (part 1)

Timotei: /* ModelIndex */

2014-05-18T22:04:40Z

‎ModelIndex

Timotei: /* List rendering */

2014-05-18T22:03:08Z

‎List rendering

Timotei: add initial section for workflows

2014-05-18T21:57:55Z

add initial section for workflows

Timotei: /* ViewModel */

2014-05-18T21:30:29Z

‎ViewModel

@@ Line 117: / Line 117: @@
 ==Process==
 Before running the performance tests be sure to be in RELEASE mode.
-The process of measuring the performance will be the following:
+The process of measuring the performance consists of executing the following steps. After each one, the render step should be called, to simulate a real usage:
 For list views/widgets
 * Insert 5000 items
 * Clear list
 * Insert 10000 items
 * Delete first 1500 items
 * Repeat the following 17 times
 ** Delete 13 items
 * Delete last 1230 items
 * Clear list
 * Insert 500 items
 * Insert 100 items after the 100'th item
 * Sort items ascending
 * Sort items descending
 For the tree views/widgets:
 * Insert 100 root items, each with 100 items
 * Expand all items
 * Clear first 3 root item's children
 * Sort

@@ Line 116: / Line 116: @@
 ==Process==
 The process of measuring the performance will be the following:
-For each view/widget
+For list views/widgets
-* Insert 1000 items
+* Insert 5000 items
 * Render
 * Clear list
 * Render
-* Insert 1001 items
+* Insert 10000 items
 * Render
-* Delete first 150 items
+* Delete first 1500 items
 * Render
 * Repeat the following 17 times
 ** Delete 13 items
 ** Render
-* Delete last 123 items
+* Delete last 1230 items
 * Render
 * Clear list
 * Render
-* Insert 137 items
+* Insert 500 items
 * Render
-* Insert 10 items after the 100'th item
+* Insert 100 items after the 100'th item
 * Render
-* Clear list
+* Sort items ascending
-* Render
-* Insert 1000 items
 * Render
-* Sort items
+* Sort items descending
 * Render
-For the tree-based views/widgets only:
+For the tree views/widgets:
 * Insert 100 root items, each with 100 items
 * Render

← Older revision		Revision as of 19:29, 8 August 2014
Line 106:		Line 106:
	===Item(s) modified/isolated rendering===		===Item(s) modified/isolated rendering===
	Triggered when some parts of the model changed, but not all.		Triggered when some parts of the model changed, but not all.
		+
		+	=Performance=
		+	We want to measure how well the new views perform compared to the old ones.
		+
		+	==Tested views/widgets==
		+	The following combinations of related views/widgets will be compared:
		+	* ListWidget, ListView - Listbox, ItemListbox
		+	* TreeView, TreeWidget - Tree
		+
		+	==Process==
		+	The process of measuring the performance will be the following:
		+
		+	For each view/widget
		+	* Insert 1000 items
		+	* Render
		+	* Clear list
		+	* Render
		+	* Insert 1001 items
		+	* Render
		+	* Delete first 150 items
		+	* Render
		+	* Repeat the following 17 times
		+	** Delete 13 items
		+	** Render
		+	* Delete last 123 items
		+	* Render
		+	* Clear list
		+	* Render
		+	* Insert 137 items
		+	* Render
		+	* Insert 10 items after the 100'th item
		+	* Render
		+	* Clear list
		+	* Render
		+	* Insert 1000 items
		+	* Render
		+	* Sort items
		+	* Render
		+
		+	For the tree-based views/widgets only:
		+	* Insert 100 root items, each with 100 items
		+	* Render
		+	* Expand all items
		+	* Render
		+	* Clear first 3 root item's children
		+	* Render
		+	* Sort
		+	* Render

@@ Line 76: / Line 76: @@
 * Create root model index (parent=0)
-* Query the number of rows for root
+* Query the number of children for root
-* For each row (value=[0, rowCount))
+* For each child (value=[0, childrenCount))
-** Create row model index (row=current row value, parent=rootModelIndex)
+** Create child model index (parent=rootModelIndex)
-** Query the image to be displayed for row index
+** Query the image to be displayed for child index (Role=Imagedecoration)
 ** Draw image
-** Query the text to be displayed for row index
+** Query the text to be displayed for child index (Role=text)
 ** Draw text
-* Render non-row elements
+* Render non-child elements
 ==Tree rendering==

@@ Line 5: / Line 5: @@
 =Proposed architecture=
 ==ModelIndex==
 Identifies uniquely items in the model.
 Properties:
-* row : size_t
+* modelData : void *
-* column : size_t
-* parent : ModelIndex *
-* indexModelData : void *
-Methods:
+==ItemDataRole==
-* isValid
+This is an enum, that contains the types of data the model is requested to provide.
 ==ItemModel==
-The model for the view, that provides data like items count to the view. This is implemented by the developers that want to use this new architecture.
+The model for the view, that provides data like items count to the view.
 Structure-related methods:
-* rowCount(modelIndex)
+* childrenCount(modelIndex)
-* columnCount(modelIndex)
+* makeIndex(child, parentModelIndex)
-* makeIndex(row, column, parentModelIndex)
 * getParentIndex(modelIndex)
 Data-provider methods:
-* getString(modelIndex)
+* getData(modelIndex, role)
-* getImage(modelIndex)
 Events:
-* Rows/ColumnsAdded - startIndex, count
+* ChildrenAdded - startIndex, count
-* Rows/ColumnsRemoved - startIndex, count
+* ChildrenRemoved - startIndex, count
-* Rows/ColumnsDataChanged - startIndex, count
+* ChildrenDataChanged - startIndex, count
 TODO: Should we instead allow for a rectangular notification area? Like: startIndex / endIndex ?
@@ Line 89: / Line 91: @@
 Recursive rendering procedure starting with a model index
 * > Given a parent model index
-* Query the number of rows for index
+* Query the number of children for index
-* For each row (value=[0, rowCount))
+* For each child (value=[0, childrenCount))
-** Create row model index (row=current row value, parent=parent<odelIndex)
+** Create child model index (parent=parentModelIndex)
-** Query the image to be displayed for row index
+** Query the image to be displayed for child index (Role=imageDecoration)
 ** Draw image
-** Query the text to be displayed for row index
+** Query the text to be displayed for child index (Role=Text)
 ** Draw text
-** Call procedure with row model index.
+** Call procedure with child model index.
 Actual rendering:

@@ Line 74: / Line 74: @@
 =Workflow examples=
 ==List rendering==
 ==Tree rendering==

← Older revision		Revision as of 21:57, 18 May 2014
Line 71:		Line 71:
	** It's used in other places like: MenuBase and ScrolledItemListBase		** It's used in other places like: MenuBase and ScrolledItemListBase
	** Remove the other usages as well?		** Remove the other usages as well?
		+
		+	=Workflow examples=
		+	==List rendering==
		+
		+	==Tree rendering==

@@ Line 32: / Line 32: @@
 Data-provider methods:
-* getItemDisplayString(modelIndex)
+* getString(modelIndex)
-* getItemDisplayImage(modelIndex)
+* getImage(modelIndex)
 Events:
-* Rows/ColumnsAdded - start, count
+* Rows/ColumnsAdded - startIndex, count
-* Rows/ColumnsRemoved - start, count
+* Rows/ColumnsRemoved - startIndex, count
-* Rows/ColumnsDataChanged - start, count
+* Rows/ColumnsDataChanged - startIndex, count
 ==ModelIndex Invalidation==