Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkstatusbar.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkStatusbar
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Report messages of minor importance to the user
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 A #GtkStatusbar is usually placed along the bottom of an application's main
  10 #GtkWindow. It may provide a regular commentary of the application's status
  11 (as is usually the case in a web browser, for example), or may be used to
  12 simply output a message when the status changes, (when an upload is complete
  13 in an FTP client, for example).
  14 It may also have a resize grip (a triangular area in the lower right corner)
  15 which can be clicked on to resize the window containing the statusbar.
  16 </para>
  17 <para>
  18 Status bars in GTK+ maintain a stack of messages. The message at
  19 the top of the each bar's stack is the one that will currently be displayed.
  20 </para>
  21 <para>
  22 Any messages added to a statusbar's stack must specify a <emphasis>context
  23 id</emphasis> that is used to uniquely identify the source of a message.
  24 This context id can be generated by gtk_statusbar_get_context_id(), given a
  25 message and the statusbar that it will be added to. Note that messages are
  26 stored in a stack, and when choosing which message to display, the stack
  27 structure is adhered to, regardless of the context identifier of a message.
  28 </para>
  29 <para>
  30 One could say that a statusbar maintains one stack of messages for display
  31 purposes, but allows multiple message producers to maintain sub-stacks of
  32 the messages they produced (via context ids).
  33 </para>
  34 <para>
  35 Status bars are created using gtk_statusbar_new().
  36 </para>
  37 <para>
  38 Messages are added to the bar's stack with gtk_statusbar_push().
  39 </para>
  40 <para>
  41 The message at the top of the stack can be removed using gtk_statusbar_pop().
  42 A message can be removed from anywhere in the stack if its message_id was
  43 recorded at the time it was added. This is done using gtk_statusbar_remove().
  44 </para>
  45
  46 <!-- ##### SECTION See_Also ##### -->
  47
  48
  49 <!-- ##### SECTION Stability_Level ##### -->
  50
  51
  52 <!-- ##### STRUCT GtkStatusbar ##### -->
  53 <para>
  54 Contains private data that should be modified with the functions described
  55 below.
  56 </para>
  57
  58
  59 <!-- ##### SIGNAL GtkStatusbar::text-popped ##### -->
  60 <para>
  61
  62 </para>
  63
  64 @statusbar:
  65 @context_id:
  66 @text:
  67
  68 <!-- ##### SIGNAL GtkStatusbar::text-pushed ##### -->
  69 <para>
  70
  71 </para>
  72
  73 @statusbar:
  74 @context_id:
  75 @text:
  76
  77 <!-- ##### ARG GtkStatusbar:has-resize-grip ##### -->
  78 <para>
  79
  80 </para>
  81
  82 <!-- ##### ARG GtkStatusbar:shadow-type ##### -->
  83 <para>
  84
  85 </para>
  86
  87 <!-- ##### FUNCTION gtk_statusbar_new ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @Returns:
  93
  94
  95 <!-- ##### FUNCTION gtk_statusbar_get_context_id ##### -->
  96 <para>
  97
  98 </para>
  99
 100 @statusbar:
 101 @context_description:
 102 @Returns:
 103
 104
 105 <!-- ##### FUNCTION gtk_statusbar_push ##### -->
 106 <para>
 107
 108 </para>
 109
 110 @statusbar:
 111 @context_id:
 112 @text:
 113 @Returns:
 114
 115
 116 <!-- ##### FUNCTION gtk_statusbar_pop ##### -->
 117 <para>
 118
 119 </para>
 120
 121 @statusbar:
 122 @context_id:
 123
 124
 125 <!-- ##### FUNCTION gtk_statusbar_remove ##### -->
 126 <para>
 127
 128 </para>
 129
 130 @statusbar:
 131 @context_id:
 132 @message_id:
 133
 134
 135 <!-- ##### FUNCTION gtk_statusbar_set_has_resize_grip ##### -->
 136 <para>
 137
 138 </para>
 139
 140 @statusbar:
 141 @setting:
 142
 143
 144 <!-- ##### FUNCTION gtk_statusbar_get_has_resize_grip ##### -->
 145 <para>
 146
 147 </para>
 148
 149 @statusbar:
 150 @Returns:
 151
 152
 153 <!-- ##### FUNCTION gtk_statusbar_get_message_area ##### -->
 154 <para>
 155
 156 </para>
 157
 158 @statusbar:
 159 @Returns:
 160
 161