vos/applibs/chatgui/avatarlist.hh

Go to the documentation of this file.

/*  $Id: avatarlist.hh,v 1.15 2003/07/29 23:03:47 reed Exp $

    Copyright (C) 2003 Reed Hedges

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/

#ifndef _VOSCHATGUI_AVATAR_LIST_H_
#define _VOSCHATGUI_AVATAR_LIST_H_


#include <vos/corelibs/vos/vos.hh>
#include <vos/metaobjects/property/property.hh>
#include <vos/metaobjects/misc/talkative.hh>
#include <vos/metaobjects/misc/avatar.hh>
#include <vos/gui/gui/gui.hh>

#if defined(_WIN32) && defined(_MSC_VER)
# ifdef CHATGUI_EXPORTS
#  define CHATGUI_API __declspec(dllexport)
# else
#  define CHATGUI_API __declspec(dllimport)
# endif
#else
# define CHATGUI_API
#endif

/** @addtogroup applibs
 *  @{
 *
 *  Text chat user interface built with the VOS GUI. 
 */
namespace VOSChatGUI {

/** 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.
    @ingroup chatgui
    @ingroup applibs
*/

class CHATGUI_API AvatarList : 
    public virtual ChildChangeListener, 
    public virtual ObjectExciseListener, 
    public virtual VOSGUI::LocalContainer
{  

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

protected:
    /* Buttons in the window. */
    VOSGUI_DEFINE_BUTTON(PrivMsgButton, AvatarList, "Private Message")
    VOSGUI_DEFINE_BUTTON(UserInfoButton, AvatarList, "User Info")   
    VOSGUI_DEFINE_BUTTON(EditYourInfoButton, AvatarList, "Edit Your Info...")

public:
    friend void UserInfoButton::push(const string& userid);
    friend void EditYourInfoButton::push(const string& userid);
    friend void PrivMsgButton::push(const string& userid);

public:

    /** Register with MetaObject system */
    static void registerExtenders();

    /** Register MetaObject extenders for other ChatGUI classes that Avatarlist
        might use. */
    static void registerOtherExtenders();

    /** Setup. Listens to world for avatars. Sets up GUI widgets. Sets a default
        title.
        @param world Object to listen to for avatars. Acquires a reference.
        @param display Object to insert new windows into. Acquires a reference.
        @param you
    */
    void setup(Vobject* world, Vobject* display = 0, Avatar* yourAvatar = 0);

    /** Enable/disable the "Send Private Message" button */
    void enablePrivMsg(bool q = true);

    virtual ~AvatarList();

    AvatarList(MetaObject* s);

    static MetaObject* create(MetaObject* s, const string& type);

    VOSGUI::SelectList* getList() {
        return &list;
    }

    VOS::Vobject* getWorld() {
        return &world;
    }

    Avatar* getYourAvatar() {
        return &yourAvatar;
    }

protected:

    /** Child added callback */
    virtual void notifyChildInserted(VobjectEvent&);

    /** Child replaced callback */
    virtual void notifyChildReplaced(VobjectEvent&);

    /** Child removed callback */
    virtual void notifyChildRemoved(VobjectEvent&);

    /** Child excised callback */
    virtual void notifyObjectExcise(RefCounted* obj);

};

}

/** @} */

#endif

---