GtkStatusbar

GtkStatusbar — Rapporte des messages d'importance mineur pour l'utilisateur

Synopsis

#include <gtk/gtk.h>


                    GtkStatusbar;
GtkWidget*          gtk_statusbar_new                   (void);
guint               gtk_statusbar_get_context_id        (GtkStatusbar *statusbar,
                                                         const gchar *context_description);
guint               gtk_statusbar_push                  (GtkStatusbar *statusbar,
                                                         guint context_id,
                                                         const gchar *text);
void                gtk_statusbar_pop                   (GtkStatusbar *statusbar,
                                                         guint context_id);
void                gtk_statusbar_remove                (GtkStatusbar *statusbar,
                                                         guint context_id,
                                                         guint message_id);
void                gtk_statusbar_set_has_resize_grip   (GtkStatusbar *statusbar,
                                                         gboolean setting);
gboolean            gtk_statusbar_get_has_resize_grip   (GtkStatusbar *statusbar);

Hiérarchie de l'Objet

  GObject
   +----GInitiallyUnowned
         +----GtkObject
               +----GtkWidget
                     +----GtkContainer
                           +----GtkBox
                                 +----GtkHBox
                                       +----GtkStatusbar

Interfaces Implémentés

GtkStatusbar implémente AtkImplementorIface.

Propriétés

  "has-resize-grip"          gboolean              : Lire / Ecrire

Propriétés des Styles 

  "shadow-type"              GtkShadowType         : Lire

Signaux

  "text-popped"                                    : Exécute Dernier
  "text-pushed"                                    : Exécute Dernier

Description

Une GtkStatusbar est généralement placée en bas de la GtkWindow principale d'un application. Elle peut fournir un commentaire sur les statuts de l'application ( comme c'est le cas dans les explorateur web par exemple) ou elle peut être utilisée pour envoyer une message quand le statut a  changé, (quand un envoie sur un client FTP est terminé par exemple). Elle peut aussi avoir une poignée de redimensionnement (une aire triangulaire dans le coin inférieur droit) sur lequel on peut cliquer pour redimensionner la fenêtre qui contient la barre des statuts.

La barre des statuts dans GTK+ soutient une pile de messages. Le message  qui est au dessus de cette pile est celui qui va être affiché.

Tout m essage ajouté à la pile de la barre des statuts doit spécifier un  context id (identifiant de contexte) qui est utilisé  pour identifier de façon unique la source d'un message. Cet id de contexte peut être généré par gtk_statusbar_get_context_id(), en fournissant le message et  la barre des statuts à laquelle il sera ajouté. Notez que les messages son stockés dans une pile, et en choisissant quel message sera affiché, la structure de la pile  est respectée, indépendemment de l'identifiant de contexte d'un message.

On pourrait dire  qu'une barre de statuts soutient  une pile de messages à afficher, mais qu'elle permet à des producteurs de messages multiples de soutenir des sous-piles de messages qu'ils ont produit ( via les ids de contexte).

Les barres de statuts sont créées avec gtk_statusbar_new().

Les messages sont ajoutés à la barre des statuts avec  gtk_statusbar_push().

Le message en haut de la pile peut être supprimé en utilisant  gtk_statusbar_pop(). Un message peut être supprimé n'importe où dans la pile si l'identifiant du message a été raccordé au moment où il a été ajouté. Cela se fait en utilisant gtk_statusbar_remove().

Détails

GtkStatusbar


typedef struct _GtkStatusbar GtkStatusbar;

Contient des données privées qui doivent être modifiées avec les fonctions décrites plus bas.

gtk_statusbar_new ()


GtkWidget*          gtk_statusbar_new                   (void);

Crée une nouvelle GtkStatusbar prète pour les messages.

Retourne : la nouvelle GtkStatusbar

gtk_statusbar_get_context_id ()


guint               gtk_statusbar_get_context_id        (GtkStatusbar *statusbar,
                                                         const gchar *context_description);

Retourne un nouvel idnetifiant de contexte donnant une description a new context identifier du contexte courant. Notez que la description n'est pas montrée dans le UI.

statusbar : une GtkStatusbar
context_description : description textuelle du contexte dans lequel le nouveau message sera utilisé.
Retourne : un id entier

gtk_statusbar_push ()


guint               gtk_statusbar_push                  (GtkStatusbar *statusbar,
                                                         guint context_id,
                                                         const gchar *text);

Place un nouveau message sur une pile de barre des statuts.

statusbar : une GtkStatusbar
context_id : idnetifiant de contexte du message retourné par gtk_statusbar_get_context_id()
text : message à ajouter à la barre des statuts
Retourne : un identifiant de message qui peut être utilisé dans  gtk_statusbar_remove().

gtk_statusbar_pop ()


void                gtk_statusbar_pop                   (GtkStatusbar *statusbar,
                                                         guint context_id);

Supprime le premier message de la pile de la GtkStatusBar's avec l'identifiant de contexte donné.

Notez que cela peut ne pas modifier l'affichage du message, si le message au dessus de la pile a un identifiant de contexte différent.

statusbar : une GtkStatusBar
context_id : un identifiant de contexte

gtk_statusbar_remove ()


void                gtk_statusbar_remove                (GtkStatusbar *statusbar,
                                                         guint context_id,
                                                         guint message_id);

Force la suppression d'un message dans la pile d'une barre des statuts. Le  context_id  exact et le  message_id doivent être spécifiés.

statusbar : une  GtkStatusBar
context_id : un identifiant de contexte
message_id : un identifiant de message retourné par gtk_statusbar_push()

gtk_statusbar_set_has_resize_grip ()


void                gtk_statusbar_set_has_resize_grip   (GtkStatusbar *statusbar,
                                                         gboolean setting);

Définit si la barre des statuts a une poignée de redimensionnement.  TRUE par défaut.

statusbar : une GtkStatusBar
setting : TRUE pour avoir une poignée de redimensionnement

gtk_statusbar_get_has_resize_grip ()


gboolean            gtk_statusbar_get_has_resize_grip   (GtkStatusbar *statusbar);

Retourne si la barre des statuts a une poignée de redimensionnement.

statusbar : une GtkStatusBar
Retourne : TRUE si la barre des statuts a une poignée de redimensionnement

Détails des Propriétés

La propriété "has-resize-grip" 


  "has-resize-grip"          gboolean              : Lire /Ecrire

Si la barre des statuts a une poignée de redimensionnement dans la fenêtre de haut niveau.

Valeur par défaut: TRUE

Depuis 2.4

Détails des Propriétés de Style

La propriété  de style "shadow-type" 


  "shadow-type"              GtkShadowType         : Lire

Style biseauté autour du texte de la barre des statuts.

Valeur par défaut : GTK_SHADOW_IN

Détails de Signaux 

Le signal  "text-popped" 


void                user_function                      (GtkStatusbar *statusbar,
                                                        guint         context_id,
                                                        gchar        *text,
                                                        gpointer      user_data)       : Exécute Dernier

Est émis chaque fois q'un nouveau message est (retiré)d'  popped off une pile de barre des statuts.

statusbar : objet qui reçoit le signal
context_id : identifiant de contexte du message/barre de statuts approprié.
text : message qui a juste été  popped. (sauté)
user_data : données utilisateur définies quand le gestionnaire de signal a été connecté.

Le signal  "text-pushed" 


void                user_function                      (GtkStatusbar *statusbar,
                                                        guint         context_id,
                                                        gchar        *text,
                                                        gpointer      user_data)       : Exécute Dernier

Est émis chaque fois qu'un  nouveau message est placé dans la pile d'une barre des statuts.

statusbar : objet qui reçoit le signal
context_id : identifiant de contexte du message/barre de statuts approprié.
text : message qui est placé dans la pile
user_data : données utilisateur définies quand le gestionnaire de signal a été connecté.