git.maemo.org Git - hildon/blob - doc/tmpl/hildon-find-toolbar.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 HildonFindToolbar
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 A special toolbar to be used with HildonAppView.
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 HildonFindToolbar is a predefined toolbar for text searching purpose. It contains a GtkListStore which
  10 has the text items that the user has searched. But once the application is terminated, or HildonFindToolbar is trashed. Programmer
  11  is responsible for getting the GtkListStore through property "list", if he/she wants to use the information in the future.
  12  And through the same property, programmer is able to set the GtkListStore. Note, once the search button is pressed, string in the
  13  GtkComboxEntry is automatically added to the existing model, unless it is empty.
  14 </para>
  15
  16 <!-- ##### SECTION See_Also ##### -->
  17 <para>
  18
  19 </para>
  20
  21 <!-- ##### STRUCT HildonFindToolbar ##### -->
  22 <para>
  23
  24 </para>
  25
  26
  27 <!-- ##### FUNCTION hildon_find_toolbar_new ##### -->
  28 <para>
  29 Create a HildonFindToolbar without any preset GtkListStore.
  30 </para>
  31
  32 @label:
  33 @Returns:
  34
  35
  36 <!-- ##### FUNCTION hildon_find_toolbar_new_with_model ##### -->
  37 <para>
  38 Creat a HildonFindToolbar with a preset GtkListStore.
  39 </para>
  40
  41 @label:
  42 @model:
  43 @column:
  44 @Returns:
  45
  46
  47 <!-- ##### SIGNAL HildonFindToolbar::close ##### -->
  48 <para>
  49 It is emitted everytime the close button is clicked. Note that HildonFindToolbar
  50 does not hide itself. It is programmer's responsibility to hide the HildonFindToolbar
  51  on receiving this signal, or do whatever he thinks is appropreiate.
  52 </para>
  53
  54 @hildonfindtoolbar: the object which received the signal.
  55
  56 <!-- ##### SIGNAL HildonFindToolbar::history-append ##### -->
  57 <para>
  58 Every time the user presses search button, the search signal is first emitted,
  59  then history-append signal is emitted. The default handler will add
  60  the currect item to the search history list. In case that the programmer
  61  does not want to have the item added to list, for instance, when the search
  62  fails, he must write his own handler and return TRUE.
  63
  64 </para>
  65
  66 @hildonfindtoolbar: the object which received the signal.
  67 @Returns:
  68
  69 <!-- ##### SIGNAL HildonFindToolbar::invalid-input ##### -->
  70 <para>
  71 This signal indicates that the user has reached the maximum allowed character in the
  72  search field. The typical action is to kindly inform the user that he has
  73  reached the limit of search field using info print.
  74 </para>
  75
  76 @hildonfindtoolbar: the object which received the signal.
  77
  78 <!-- ##### SIGNAL HildonFindToolbar::search ##### -->
  79 <para>
  80 It is emitted everytime the search button is clicked, even the GtkComboboxEntry is empty.
  81 </para>
  82
  83 @hildonfindtoolbar: the object which received the signal.
  84
  85 <!-- ##### ARG HildonFindToolbar:column ##### -->
  86 <para>
  87
  88 </para>
  89
  90 <!-- ##### ARG HildonFindToolbar:history-limit ##### -->
  91 <para>
  92
  93 </para>
  94
  95 <!-- ##### ARG HildonFindToolbar:label ##### -->
  96 <para>
  97
  98 </para>
  99
 100 <!-- ##### ARG HildonFindToolbar:list ##### -->
 101 <para>
 102
 103 </para>
 104
 105 <!-- ##### ARG HildonFindToolbar:max-characters ##### -->
 106 <para>
 107
 108 </para>
 109
 110 <!-- ##### ARG HildonFindToolbar:prefix ##### -->
 111 <para>
 112
 113 </para>
 114