Git commit 68002b4aa7d98116cacf684c99414a860e218396 by Jos=C3=A9 Manuel San= tamar=C3=ADa Lema. Committed on 11/07/2016 at 10:57. Pushed by joselema into branch 'master'. Fix various typos. M +8 -7 src/api_v2_design/README http://commits.kde.org/krecipes/68002b4aa7d98116cacf684c99414a860e218396 diff --git a/src/api_v2_design/README b/src/api_v2_design/README index ca85c82..30f4528 100644 --- a/src/api_v2_design/README +++ b/src/api_v2_design/README @@ -26,8 +26,9 @@ List of issues: = #3 The class Ingredient in src/datablocks is not a class to represent a ro= w in the 'ingredients' SQL table; it's a class to represent an ingredient en= try - for a recipe. To represent a row in the ingredients table the class Ele= ment. - This various issues: + for a recipe. To represent a row in the ingredients table we have the + Element class. + This have various issues: - It's confusing - It's difficult to reference ingredient subsitutes (see the Ingredient= vs IngredientData hack to have a list of substitutes) @@ -124,7 +125,7 @@ New API design to solve the above issues id and ingredient name we could filter out the id one for comboboxes u= sing this technique: https://wiki.qt.io/Filter_Columns_in_a_QFileSystemModel = - - NOTE 2: To transfer data from the database QSqlRecipeDB will use eithe= r: + - NOTE 2: To transfer data from the database QSqlRecipeDB we will use ei= ther: a) dtos or QLists of dtos b) models such as QStandardItemModel or KCompletion objects For instance, to read all the ingredients from the database we will us= e the @@ -142,14 +143,14 @@ New API design to solve the above issues Mockup of the new design ------------------------ = -* Inside this directory there is a file called 'datablocks_v2.h' with some +* Inside this directory there is a file called 'kreelements.h' with some drafts of the classes meant to replace the current stuff in 'src/datablo= cks'. -* There is also a file called 'api_v2_models.h' with some drafs of the mod= el +* There is also a file called 'kremodels.h' with some drafs of the model classes meant to be filled by RecipeDB and used all over the program when needed. -* The classes in 'datablocks_v2.h' would be located in 'src/dtos/'. DTO me= ans +* The classes in 'kreelements.h' would be located in 'src/dtos/'. DTO means "Data Transfer Object" = -* The classes in 'api_v2_models.h' would be located mostly in 'src/models/' +* The classes in 'kremodels.h' would be located mostly in 'src/models/' = = ----------------------------------------------------------