summaryrefslogtreecommitdiff
path: root/indra/newview/llnamelistctrl.h
blob: dde85f4d29057433a61da61716f3d7c9bf1e9109 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
/**
 * @file llnamelistctrl.h
 * @brief A list of names, automatically refreshing from the name cache.
 *
 * $LicenseInfo:firstyear=2003&license=viewerlgpl$
 * Second Life Viewer Source Code
 * Copyright (C) 2010, Linden Research, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation;
 * version 2.1 of the License only.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Linden Research, Inc., 945 Battery Street, San Francisco, CA  94111  USA
 * $/LicenseInfo$
 */

#ifndef LL_LLNAMELISTCTRL_H
#define LL_LLNAMELISTCTRL_H

#include <set>

#include "llscrolllistctrl.h"

class LLAvatarName;

/**
 * LLNameListCtrl item
 *
 * We don't use LLScrollListItem to be able to override getUUID(), which is needed
 * because the name list item value is not simply an UUID but a map (uuid, is_group).
 */
class LLNameListItem : public LLScrollListItem, public LLHandleProvider<LLNameListItem>
{
public:
    bool isGroup() const { return mIsGroup; }
    void setIsGroup(bool is_group) { mIsGroup = is_group; }
    bool isExperience() const { return mIsExperience; }
    void setIsExperience(bool is_experience) { mIsExperience = is_experience; }
    void setSpecialID(const LLUUID& special_id) { mSpecialID = special_id; }
    const LLUUID& getSpecialID() const { return mSpecialID; }

protected:
    friend class LLNameListCtrl;

    LLNameListItem( const LLScrollListItem::Params& p )
    :   LLScrollListItem(p), mIsGroup(false), mIsExperience(false)
    {
    }

    LLNameListItem( const LLScrollListItem::Params& p, bool is_group )
    :   LLScrollListItem(p), mIsGroup(is_group), mIsExperience(false)
    {
    }

    LLNameListItem( const LLScrollListItem::Params& p, bool is_group, bool is_experience )
    :   LLScrollListItem(p), mIsGroup(is_group), mIsExperience(is_experience)
    {
    }

private:
    bool mIsGroup;
    bool mIsExperience;

    LLUUID mSpecialID;
};


class LLNameListCtrl
:   public LLScrollListCtrl, public LLInstanceTracker<LLNameListCtrl>
{
public:
    typedef boost::signals2::signal<void(bool)> namelist_complete_signal_t;

    typedef enum e_name_type
    {
        INDIVIDUAL,
        GROUP,
        SPECIAL,
        EXPERIENCE
    } ENameType;

    // provide names for enums
    struct NameTypeNames : public LLInitParam::TypeValuesHelper<LLNameListCtrl::ENameType, NameTypeNames>
    {
        static void declareValues();
    };

    struct NameItem : public LLInitParam::Block<NameItem, LLScrollListItem::Params>
    {
        Optional<std::string>               name;
        Optional<ENameType, NameTypeNames>  target;
        Optional<LLUUID>                    special_id;

        NameItem()
        :   name("name"),
            target("target", INDIVIDUAL),
            special_id("special_id", LLUUID())
        {}
    };

    struct NameColumn : public LLInitParam::ChoiceBlock<NameColumn>
    {
        Alternative<S32>                column_index;
        Alternative<std::string>        column_name;
        NameColumn()
        :   column_name("name_column"),
            column_index("name_column_index", 0)
        {}
    };

    struct Params : public LLInitParam::Block<Params, LLScrollListCtrl::Params>
    {
        Optional<NameColumn>    name_column;
        Optional<bool>  allow_calling_card_drop;
        Optional<bool>          short_names;
        Params();
    };

protected:
    LLNameListCtrl(const Params&);
    virtual ~LLNameListCtrl()
    {
        for (avatar_name_cache_connection_map_t::iterator it = mAvatarNameCacheConnections.begin(); it != mAvatarNameCacheConnections.end(); ++it)
        {
            if (it->second.connected())
            {
                it->second.disconnect();
            }
        }
        mAvatarNameCacheConnections.clear();
    }
    friend class LLUICtrlFactory;
public:
    // Add a user to the list by name.  It will be added, the name
    // requested from the cache, and updated as necessary.
    LLScrollListItem* addNameItem(const LLUUID& agent_id, EAddPosition pos = ADD_BOTTOM,
                     bool enabled = true, const std::string& suffix = LLStringUtil::null, const std::string& prefix = LLStringUtil::null);
    LLScrollListItem* addNameItem(NameItem& item, EAddPosition pos = ADD_BOTTOM);

    /*virtual*/ LLScrollListItem* addElement(const LLSD& element, EAddPosition pos = ADD_BOTTOM, void* userdata = NULL);
    LLScrollListItem* addNameItemRow(const NameItem& value, EAddPosition pos = ADD_BOTTOM, const std::string& suffix = LLStringUtil::null,
                                                                                            const std::string& prefix = LLStringUtil::null);

    // Add a user to the list by name.  It will be added, the name
    // requested from the cache, and updated as necessary.
    void addGroupNameItem(const LLUUID& group_id, EAddPosition pos = ADD_BOTTOM,
                          bool enabled = true);
    void addGroupNameItem(NameItem& item, EAddPosition pos = ADD_BOTTOM);


    void removeNameItem(const LLUUID& agent_id);

    LLScrollListItem* getNameItemByAgentId(const LLUUID& agent_id);

    void selectItemBySpecialId(const LLUUID& special_id);
    LLUUID getSelectedSpecialId();

    // LLView interface
    /*virtual*/ bool    handleDragAndDrop(S32 x, S32 y, MASK mask,
                                      bool drop, EDragAndDropType cargo_type, void *cargo_data,
                                      EAcceptance *accept,
                                      std::string& tooltip_msg);
    /*virtual*/ bool handleToolTip(S32 x, S32 y, MASK mask);

    void setAllowCallingCardDrop(bool b) { mAllowCallingCardDrop = b; }

    void sortByName(bool ascending);

    /*virtual*/ void updateColumns(bool force_update);

    /*virtual*/ void mouseOverHighlightNthItem( S32 index );

    /*virtual*/ bool handleRightMouseDown(S32 x, S32 y, MASK mask);

    bool isSpecialType() { return (mNameListType == SPECIAL); }

    void setNameListType(e_name_type type) { mNameListType = type; }
    void setHoverIconName(std::string icon_name) { mHoverIconName = icon_name; }

private:
    void showInspector(const LLUUID& avatar_id, bool is_group, bool is_experience = false);
    void onAvatarNameCache(const LLUUID& agent_id, const LLAvatarName& av_name, std::string suffix, std::string prefix, LLHandle<LLNameListItem> item);
    void onGroupNameCache(const LLUUID& group_id, const std::string name, LLHandle<LLNameListItem> item);

private:
    S32             mNameColumnIndex;
    std::string     mNameColumn;
    bool            mAllowCallingCardDrop;
    bool            mShortNames;  // display name only, no SLID
    typedef std::map<LLUUID, boost::signals2::connection> avatar_name_cache_connection_map_t;
    avatar_name_cache_connection_map_t mAvatarNameCacheConnections;
    avatar_name_cache_connection_map_t mGroupNameCacheConnections;

    S32 mPendingLookupsRemaining;
    namelist_complete_signal_t mNameListCompleteSignal;

    std::string     mHoverIconName;
    e_name_type     mNameListType;

    boost::signals2::signal<void(const LLUUID &)> mIconClickedSignal;

public:
    boost::signals2::connection setOnNameListCompleteCallback(boost::function<void(bool)> onNameListCompleteCallback)
    {
        return mNameListCompleteSignal.connect(onNameListCompleteCallback);
    }

    boost::signals2::connection setIconClickedCallback(boost::function<void(const LLUUID &)> cb)
    {
        return mIconClickedSignal.connect(cb);
    }
};


#endif