docs: fileselector: improve docs for enum, events and keyword usage
authorStefan Schmidt <stefan@osg.samsung.com>
Mon, 24 Oct 2016 15:41:52 +0000 (17:41 +0200)
committerStefan Schmidt <stefan@osg.samsung.com>
Mon, 24 Oct 2016 15:41:52 +0000 (17:41 +0200)
src/lib/elementary/elm_fileselector.eo
src/lib/elementary/elm_fileselector_button.eo
src/lib/elementary/elm_fileselector_entry.eo
src/lib/elementary/elm_interface_fileselector.eo

index f6f0bb5..77945b1 100644 (file)
@@ -26,7 +26,7 @@ class Elm.Fileselector (Elm.Layout, Elm.Interface.Fileselector,
             ]]
          }
          values {
-            visible: bool; [[true to show buttons, false to hide.]]
+            visible: bool; [[$true to show buttons, $false to hide.]]
          }
       }
    }
@@ -63,10 +63,10 @@ class Elm.Fileselector (Elm.Layout, Elm.Interface.Fileselector,
       Elm.Interface.Atspi_Widget_Action.elm_actions.get;
    }
    events {
-      done;
-      activated;
-      selected,invalid;
-      directory,open;
+      done; [[Called when OK button was pressed]]
+      activated; [[Called when the filesector was activated]]
+      selected,invalid; [[Called when fileselector was selected]]
+      directory,open; [[Called when a directory was opened]]
    }
 
 }
index 46cd057..5ac08ce 100644 (file)
@@ -21,7 +21,7 @@ class Elm.Fileselector_Button (Elm.Button, Elm.Interface.Fileselector)
       Elm.Interface.Fileselector.mode;
    }
    events {
-      file,chosen;
+      file,chosen; [[Called when a file was chosen in the fileselector]]
    }
 
 }
index 2b46f04..9481a70 100644 (file)
@@ -25,9 +25,9 @@ class Elm.Fileselector_Entry (Elm.Layout, Elm.Interface.Fileselector,
       Efl.Part.part;
    }
    events {
-      changed;
-      activated;
-      file,chosen;
+      changed; [[Called when the entry changed]]
+      activated; [[Called when the entry was activated]]
+      file,chosen; [[Called when a file was chosen in the fileselector]]
       press;
    }
 
index b888586..3d18012 100644 (file)
@@ -15,14 +15,15 @@ enum Elm.Fileselector.Mode
 
 enum Elm.Fileselector.Sort
 {
-   by_filename_asc = 0,
-   by_filename_desc,
-   by_type_asc,
-   by_type_desc,
-   by_size_asc,
-   by_size_desc,
-   by_modified_asc,
-   by_modified_desc,
+   [[Fileselector sorting modes]]
+   by_filename_asc = 0, [[Alphabetical sort by ascending filename, default]]
+   by_filename_desc, [[Alphabetical sorting by descending filename]]
+   by_type_asc, [[Sort by file type]]
+   by_type_desc, [[Sort by file type description]]
+   by_size_asc, [[Sort by ascending file size]]
+   by_size_desc, [[Sort by descending file size]]
+   by_modified_asc, [[Sort by ascending modified date]]
+   by_modified_desc, [[Sort by descending modified date]]
    last [[Sentinel (helper) value, not used.]]
 }