Page MenuHomePhabricator

docs: Fill-in parts docs for Efl.Ui.Grid_Default_Item
Changes PlannedPublic

Authored by segfaultxavi on Mar 28 2019, 5:19 AM.

Details

Reviewers
zmike
Maniphest Tasks
T7717: docs todo
Test Plan

Only docs updated

Diff Detail

Repository
rEFL core/efl
Branch
devs/xartigas/docs-todo-1.22
Lint
No Linters Available
Unit
No Unit Test Coverage
Build Status
Buildable 10620
Build 8313: arc lint + arc unit
segfaultxavi created this revision.Mar 28 2019, 5:19 AM
segfaultxavi requested review of this revision.Mar 28 2019, 5:19 AM

This documentation is very theme dependend, noone ones if this is still true for some other theme, and our themes do not have a specification of how to deal with icon or end. Maybe we can call the icon a "decoration for the text" and end a "subtile graphical element that can guide usages, but is not located in the mainfocus of the user?". I don't know, i am bad at specifying stuff.

Damn. OK. I thought there was a contract somewhere specifying what an Icon and an End are.

If every theme is free to interpret parts as it wishes, there is no way to properly document parts, correct?
If that is the case, we better drop part documentation at the EO level, and introduce some mechanism to allow themes to document their parts 😦

I don't have a strong opinion if we move that away, or have documentation here what the purpose of the parts is...

Maybe the people who designed Parts have a better idea?
@cedric @raster @q66: Where should we document the purpose of Parts, if every theme is free to do whatever it pleases with them?

SanghyeonLee added a subscriber: SanghyeonLee.EditedApr 7 2019, 10:49 PM

sorry I made it and I have a plan to update this to using Efl.Ui.Item_Part_Icon and End not generating same part repeatly, but in here I was thinking that doc need to be updated,

     text: Efl.Ui.Item_Part_Text [[The text part for grid default item.
	                               text part is the caption of grid item.]]
     icon: Efl.Ui.Item_Part_Icon; [[The icon content part for grid default item.
	                                icon part is the main content of grid item.]]
     end: Efl.Ui.Item_Part_End; [[The end content part for grid default item.
	                              end part is the subordinary content of grid item.
	                              you can swallow small badge widget such as check, radio.]]
segfaultxavi planned changes to this revision.Apr 8 2019, 12:49 AM

OK, if there is a plan to update this widget then you can add the docs later.
I'll leave this task open so we do not forget :)