vcs.maemo.org Git - hildon/blob - doc/tmpl/hildon-scroll-area.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 hildon-scroll-area
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 @GtkScrollArea is a helper to create specific views,
   6 which are using scrollable area.
   7
   8 <!-- ##### SECTION Long_Description ##### -->
   9 <para>
  10 When application developer needs a view which contains multiple
  11 components, from which some has built-in @GtkScrolledWindow handling.
  12 (eg. @GtkTreeView) These widgets creates a problem which can be seen as
  13 unfunctional scrolling. @GtkScrollArea creates an area which handles
  14 these scrolling problems.
  15
  16 <informalexample>
  17 <programlisting>
  18 /*
  19 Following code is not a working copy,
  20 it's only giving an example of possible situation
  21 */
  22
  23 window = gtk_window_new ();
  24 box = gtk_box_new ();
  25 buttonA = gtk_button_new ();
  26 buttonB = gtk_button_new ();
  27 treeview = gtk_tree_view_new ();
  28 swindow = gtk_scrolled_window_new ();
  29
  30 scrollarea = gtk_scroll_area_new (swindow, treeview);
  31
  32 /*
  33 Pack the buttons to the box, the box to the scrolled window
  34 and the scrolled window to the window.
  35 */
  36
  37 gtk_box_pack (box, scrollarea);
  38
  39 /*
  40 You can trye following situation without scroll area and
  41 notice that the treeview is not working as well as it should
  42 */
  43 </programlisting>
  44 </informalexample>
  45 </para>
  46
  47 <!-- ##### SECTION See_Also ##### -->
  48 <para>
  49
  50 </para>
  51
  52 <!-- ##### FUNCTION hildon_scroll_area_new ##### -->
  53 <para>
  54
  55 </para>
  56
  57 @sw:
  58 @child:
  59 @Returns:
  60
  61