BDeskbar Class Reference

#include <Deskbar.h>

List of all members.

Detailed Description

BDeskbar lets you query for the Deskbar's location, orientation (expanded or contracted), and frame, and lets you add and remove items from the shelf.

The class lets you expand/contract the Deskbar and move it to one of the pre-defined locations, but it doesn't let you remove or hide the Deskbar, nor does it let you replace it with a UI object of your own.
Note:
You don't need a be_app object to create and use a BDeskbar.
See also:
Deskbar Constants


Public Member Functions

 BDeskbar ()
 ~BDeskbar ()
BRect Frame () const
deskbar_location Location (bool *isExpanded=NULL) const
status_t SetLocation (deskbar_location location, bool expanded=false)
bool IsExpanded () const
status_t Expand (bool yn)
status_t GetItemInfo (int32 id, const char **name) const
status_t GetItemInfo (const char *name, int32 *id) const
bool HasItem (int32 id) const
bool HasItem (const char *name) const
uint32 CountItems () const
status_t AddItem (BView *archivableView, int32 *id=NULL)
status_t AddItem (entry_ref *addon, int32 *id=NULL)
status_t RemoveItem (int32 id)
status_t RemoveItem (const char *name)
 BDeskbar ()
 ~BDeskbar ()
BRect Frame () const
deskbar_location Location (bool *isExpanded=NULL) const
status_t SetLocation (deskbar_location location, bool expanded=false)
bool IsExpanded () const
status_t Expand (bool yn)
status_t GetItemInfo (int32 id, const char **name) const
status_t GetItemInfo (const char *name, int32 *id) const
bool HasItem (int32 id) const
bool HasItem (const char *name) const
uint32 CountItems () const
status_t AddItem (BView *archivableView, int32 *id=NULL)
status_t AddItem (entry_ref *addon, int32 *id=NULL)
status_t RemoveItem (int32 id)
status_t RemoveItem (const char *name)

Constructor & Destructor Documentation

BDeskbar (   ) 
 

~BDeskbar (   ) 
 

BDeskbar (   ) 
 

~BDeskbar (   ) 
 

Member Function Documentation

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

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

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

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

uint32 CountItems (   )  const
 

uint32 CountItems (   )  const
 

status_t Expand (  bool  yn  ) 
 

status_t Expand (  bool  yn  ) 
 

BRect Frame (   )  const
 

BRect Frame (   )  const
 

status_t GetItemInfo (  const char *  name,
int32 *  id
)  const
 

status_t GetItemInfo (  int32  id,
const char **  name
)  const
 

status_t GetItemInfo (  const char *  name,
int32 *  id
)  const
 

status_t GetItemInfo (  int32  id,
const char **  name
)  const
 

bool HasItem (  const char *  name  )  const
 

bool HasItem (  int32  id  )  const
 

bool HasItem (  const char *  name  )  const
 

bool HasItem (  int32  id  )  const
 

bool IsExpanded (   )  const
 

bool IsExpanded (   )  const
 

deskbar_location Location (  bool *  isExpanded = NULL  )  const
 

deskbar_location Location (  bool *  isExpanded = NULL  )  const
 

status_t RemoveItem (  const char *  name  ) 
 

status_t RemoveItem (  int32  id  ) 
 

status_t RemoveItem (  const char *  name  ) 
 

status_t RemoveItem (  int32  id  ) 
 

status_t SetLocation (  deskbar_location  location,
bool  expanded = false
) 
 

status_t SetLocation (  deskbar_location  location,
bool  expanded = false
) 
 

Copyright 2005 by yellowTAB GmbH, Be Inc., Palm Source Inc. and their respective legal successors
All rights reserved.