VOSChatGUI::AvatarList Class Reference
[Applibs]

A list of avatar object in some "world" (children of some Vobject). More...

#include <avatarlist.hh>

Inheritance diagram for VOSChatGUI::AvatarList:

List of all members.

Public Member Functions

• void setup (Vobject *world, Vobject *display=0, Avatar *yourAvatar=0)

  Setup.
  
  

• void enablePrivMsg (bool q=true)

  Enable/disable the "Send Private Message" button.
  
  

• virtual ~AvatarList ()
• AvatarList (MetaObject *s)
• VOSGUI::SelectList * getList ()
• VOS::Vobject * getWorld ()
• Avatar * getYourAvatar ()

Static Public Member Functions

• void registerExtenders ()

  Register with MetaObject system.
  
  

• void registerOtherExtenders ()

  Register MetaObject extenders for other ChatGUI classes that Avatarlist might use.
  
  

• MetaObject * create (MetaObject *s, const string &type)

Protected Member Functions

• virtual void notifyChildInserted (VobjectEvent &)

  Child added callback.
  
  

• virtual void notifyChildReplaced (VobjectEvent &)

  Child replaced callback.
  
  

• virtual void notifyChildRemoved (VobjectEvent &)

  Child removed callback.
  
  

• virtual void notifyObjectExcise (RefCounted *obj)

  Child excised callback.
  
  

Protected Attributes

• vRef< Vobject > world
• vRef< VOSGUI::SelectList > list
• vRef< Vobject > display
• vRef< Avatar > yourAvatar
• vRef< LocalSite > site
• bool usePrivMsg

Friends

• void UserInfoButton::push (const string &userid)
• void EditYourInfoButton::push (const string &userid)
• void PrivMsgButton::push (const string &userid)

---

Detailed Description

A list of avatar object in some "world" (children of some Vobject).

Controls are also given to inspect info about the avatars, to change the info for "your" avatar, and to open a private message window for one or more talkative avatars.

Definition at line 55 of file avatarlist.hh.

---

Constructor & Destructor Documentation

AvatarList::~AvatarList (   )  [virtual]

Definition at line 106 of file avatarlist.cc.

AvatarList::AvatarList (  MetaObject *  s  )

Definition at line 41 of file avatarlist.cc. Referenced by create().

---

Member Function Documentation

MetaObject * AvatarList::create (  MetaObject *  s, const string &  type )  [static]

Definition at line 114 of file avatarlist.cc.

void AvatarList::enablePrivMsg (  bool  q = true  )

Enable/disable the "Send Private Message" button. Definition at line 46 of file avatarlist.cc.

VOSGUI::SelectList* VOSChatGUI::AvatarList::getList (   )  [inline]

Definition at line 106 of file avatarlist.hh.

VOS::Vobject* VOSChatGUI::AvatarList::getWorld (   )  [inline]

Definition at line 110 of file avatarlist.hh.

Avatar* VOSChatGUI::AvatarList::getYourAvatar (   )  [inline]

Definition at line 114 of file avatarlist.hh.

void AvatarList::notifyChildInserted (  VobjectEvent &   )  [protected, virtual]

Child added callback. Definition at line 127 of file avatarlist.cc. Referenced by notifyChildReplaced().

void AvatarList::notifyChildRemoved (  VobjectEvent &   )  [protected, virtual]

Child removed callback. Definition at line 147 of file avatarlist.cc. Referenced by notifyChildReplaced().

void AvatarList::notifyChildReplaced (  VobjectEvent &   )  [protected, virtual]

Child replaced callback. Definition at line 141 of file avatarlist.cc.

void AvatarList::notifyObjectExcise (  RefCounted *  obj  )  [protected, virtual]

Child excised callback. Definition at line 160 of file avatarlist.cc.

void AvatarList::registerExtenders (   )  [static]

Register with MetaObject system. Reimplemented from VOSGUI::Container. Definition at line 118 of file avatarlist.cc.

void AvatarList::registerOtherExtenders (   )  [static]

Register MetaObject extenders for other ChatGUI classes that Avatarlist might use. Definition at line 122 of file avatarlist.cc.

void AvatarList::setup (  Vobject *  world, Vobject *  display = 0, Avatar *  yourAvatar = 0 )

Setup. Listens to world for avatars. Sets up GUI widgets. Sets a default title. Parameters: world  Object to listen to for avatars. Acquires a reference. display  Object to insert new windows into. Acquires a reference. you  Definition at line 50 of file avatarlist.cc.

---

Friends And Related Function Documentation

void EditYourInfoButton::push (  const string &  userid  )  [friend]

void PrivMsgButton::push (  const string &  userid  )  [friend]

void UserInfoButton::push (  const string &  userid  )  [friend]

---

Member Data Documentation

vRef<Vobject> VOSChatGUI::AvatarList::display [protected]

Definition at line 64 of file avatarlist.hh. Referenced by setup().

vRef<VOSGUI::SelectList> VOSChatGUI::AvatarList::list [protected]

Definition at line 63 of file avatarlist.hh. Referenced by notifyChildInserted(), notifyChildRemoved(), and setup().

vRef<LocalSite> VOSChatGUI::AvatarList::site [protected]

Definition at line 66 of file avatarlist.hh. Referenced by setup().

bool VOSChatGUI::AvatarList::usePrivMsg [protected]

Definition at line 67 of file avatarlist.hh. Referenced by enablePrivMsg(), and setup().

vRef<Vobject> VOSChatGUI::AvatarList::world [protected]

Definition at line 62 of file avatarlist.hh. Referenced by setup(), and ~AvatarList().

vRef<Avatar> VOSChatGUI::AvatarList::yourAvatar [protected]

Definition at line 65 of file avatarlist.hh. Referenced by setup().

---

The documentation for this class was generated from the following files:

• vos/applibs/chatgui/avatarlist.hh
• vos/applibs/chatgui/avatarlist.cc

---