Table des matières du Be Book      Index Deskbar

BDeskbar

Declarée dans : be/be_apps/Deskbar/Deskbar.h

Librairie : libbe.so

Allocation : par constructeur ou sur la pile

Résumé

BDeskbar vous permet de connaître l'emplacement, le type (normale ou réduite) et la forme de la Deskbar, et vous permet d'ajouter ou d'enlever des éléments de la barre d'état. Cette classe vous permet de réduire/rétablir la Deskbar et de la déplacer vers l'un des endroits pré-définis, mais elle ne vous permet pas de supprimer ou cacher la Deskbar, ni de la remplacer par une autre interface.

 
Vous n'avez pas besoin d'objet be_app pour créer et utiliser une BDeskbar.



Constructeur et Destructeur


BDeskbar() , ~Deskbar()

                                                         
  

BDeskbar(void)

~BDeskbar()

Le constructeur crée et renvoit un nouvel objet BDeskbar. Le destructeur le détruit.


Fonctions


AddItem() , RemoveItem() , CountItems() , HasItem() , GetItemInfo()

                                                         
  

status_t AddItem(BView *view, int32 *id=NULL)

status_t AddItem(entry_ref *addon, int32 *id=NULL)

status_t RemoveItem(int32 id)

status_t RemoveItem(const char *name)

int32 CountItems(void) const

bool HasItem(int32 id) const

bool HasItem(const char *name) const

status_t GetItemInfo(int32 for_id, const char **found_name)

status_t GetItemInfo(const char *for_name, int32 *found_id)

 
Une vue qui se trouve dans la barre d'état de la Deskbar ne peut appeler aucune de ces fonctions.


La Deskbar contient une barre d'état qui contient les replicants (BViews archivable). Typiquement, ces replicants surveillent ou contrôlent des services. Par exemple, BeOS offre des éléments qui surveillent et contrôlent les entrées, PPP, et le démon mail (la vue date/heure n'est pas un replicant) :

AddItem() rajoute un nouvel élément dans la barre d'état de la Deskbar. view, la BView qui sera affichée dans la barre d'état, doit être archivable (voir BArchivable). Un élément de la barre d'état est identifié par un nom et un id entier. Le nom est celui de la vue elle-même (i.e., tel qu'il a été défini dans le constructeur de la BView ); l'id est généré par la Deskbar et on est certain qu'il sera unique. id, s'il est fourni, prend la valeur de l'id de l'élément qu'on ajoute.

Vous pouvez également ajouter un élément à la Deskbar en passant un entry_ref, addon, à l'add-on de la Deskbar.

RemoveItem() supprime l'élément de la barre d'état identifié par name ou id.

CountItems() renvoie le nombre d'éléments qui se trouvent dans la barre d'état (notez qu'on ne compte pas la vue date/heure).

HasItem() renvoie true si la barre d'état de la Deskbar contient l'élément identifié par name ou id.

GetItemInfo() fait pointer *found_name vers le nom de l'élément identifié par for_id, ou met à true le found_id de l'élément identifié par for_name.

 
L'appelant est responsable de la libération de found_name.


CODES DE RETOUR

B_OK. La requête d'ajout, suppression ou d'information sur l'élément a été correctement envoyée à la Deskbar. Notez que cela ne signifie pas que la fonction a réellement effectué ce qu'elle était censée faire.


CountItems() voir AddItem()


Expand() voir Location()


Frame()

                                                         
  

BRect Frame(void) const

Renvoie la position de la Deskbar en coordonnées écran.


GetItemInfo() voir AddItem()


Additem()


IsExpanded() voir Location()


Location() , IsExpanded() , SetLocation() , Expand()

                                                         
  

deskbar_location Location(bool *isExpanded=NULL) const

bool IsExpanded(void) const

status_t SetLocation(deskbar_location location, bool expanded=false)

status_t Expand(bool expand)

Location() renvoie une description symbolique de l'emplacement de la Deskbar; voir deskbar_location pour la liste des emplacements pré-définis. isExpanded (si elle existe) vaut true si la Deskbar est à l'état normal, et false si elle est réduite; IsExpanded() renvoie directement cette valeur. Les états "normal" ou "réduit" n'existent que si la Deskbar se trouve dans le coin supérieur gauche ou droit; pour tous les autres emplacements, l'état de la Deskbar est forcé par le système. Voir deskbar_location pour l'illustration.

SetLocation() modifie l'emplacement de la Deskbar et son état (normal/réduit) ; selon l'emplacement, l'état est forcé par le système. Expand() restaure/réduit la Deskbar (lorsque la valeur n'est pas forcée par le système) sans affecter son emplacement. Normalement vous n'aurez que rarement à utiliser ces fonctions. C'est plutôt l'utilisateur qui va déplacer et restaurer/réduire la Deskbar.

CODES DE RETOUR

SetLocation() et Expand() renvoient...


Additem()


SetLocation() voir Location()


Constantes de la Deskbar


Emplacement de la Deskbar

                                                         
  

enum deskbar_location { ... }

Constante Signification
B_DESKBAR_TOP Normale (uniquement) au sommet de l'écran.
B_DESKBAR_BOTTOM Normale (uniquement) au bas de l'écran.
B_DESKBAR_LEFT_BOTTOM Réduite (uniquement) dans le coin inférieur gauche.
B_DESKBAR_RIGHT_BOTTOM Réduite (uniquement) dans le coin inférieur droit.
B_DESKBAR_LEFT_TOP Dans le coin supérieur gauche (normale ou réduite).
B_DESKBAR_RIGHT_TOP Dans le coin supérieur droit (normale ou réduite).

Les constantes deskbar_location sevrent à affecter ou à récupérer l'emplacement de la Deskbar (voir Location()). Les six emplacement sont indiqués sur les deux schémas suivants :

La valeur deskbar_location modifie l'état (normal/réduit) de la Deskbar : La Deskbar peut être restaurée ou réduite uniquement aux emplacements B_DESKBAR_LEFT_TOP et B_DESKBAR_RIGHT_TOP. Pour les autres emplacements, l'état est forcé par le système. L'illustration suivante montre une Deskbar dans le coin supérieur gauche aux états normal et réduit :


Table des Matières du Be Book      Index Deskbar


The Be Book,
...in lovely HTML...
for BeOS Release 5.

Copyright © 2000 Be, Inc. All rights reserved..