summaryrefslogtreecommitdiff
path: root/indra/newview/llscriptfloater.h
blob: 8f3b8e99f620f8571c1e9c044604903205653040 (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
226
227
228
229
230
/**
 * @file llscriptfloater.h
 * @brief LLScriptFloater class definition
 *
 * $LicenseInfo:firstyear=2009&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_SCRIPTFLOATER_H
#define LL_SCRIPTFLOATER_H

#include "lltransientdockablefloater.h"
#include "llnotificationptr.h"

class LLToastPanel;

/**
 * Handles script notifications ("ScriptDialog" and "ScriptDialogGroup")
 * and manages Script Floaters.
 */
class LLScriptFloaterManager : public LLSingleton<LLScriptFloaterManager>
{
    // *TODO
    // LLScriptFloaterManager and LLScriptFloater will need some refactoring after we
    // know how script notifications should look like.
    LLSINGLETON(LLScriptFloaterManager);
public:

    typedef enum e_object_type
    {
        OBJ_SCRIPT,
        OBJ_GIVE_INVENTORY,
        OBJ_LOAD_URL,

        OBJ_UNKNOWN
    }EObjectType;

    typedef enum e_limitation_type
    {
        SCRIPT_PER_OBJECT = 0,
        SCRIPT_PER_CHANNEL = 1,
        SCRIPT_ATTACHMENT_PER_CHANNEL,
        SCRIPT_HUD_PER_CHANNEL,
        SCRIPT_HUD_UNCONSTRAINED
    }ELimitationType;

    /**
     * Handles new notifications.
     * Saves notification and object ids, removes old notification if needed, creates script chiclet
     * Note that one object can spawn one script floater.
     */
    void onAddNotification(const LLUUID& notification_id);

    /**
     * Removes notification.
     */
    void removeNotification(const LLUUID& notification_id);

    /**
     * Handles notification removal.
     * Removes script notification toast, removes script chiclet, closes script floater
     */
    void onRemoveNotification(const LLUUID& notification_id);

    /**
     * Toggles script floater.
     * Removes "new message" icon from chiclet and removes notification toast.
     */
    void toggleScriptFloater(const LLUUID& object_id, bool set_new_message = false);

    LLUUID findObjectId(const LLUUID& notification_id);

    LLUUID findNotificationId(const LLUUID& object_id);

    static EObjectType getObjectType(const LLUUID& notification_id);

    static std::string getObjectName(const LLUUID& notification_id);

    typedef boost::signals2::signal<void(const LLSD&)> object_signal_t;

    boost::signals2::connection addNewObjectCallback(const object_signal_t::slot_type& cb) { return mNewObjectSignal.connect(cb); }
    boost::signals2::connection addToggleObjectFloaterCallback(const object_signal_t::slot_type& cb) { return mToggleFloaterSignal.connect(cb); }

    struct FloaterPositionInfo
    {
        LLRect mRect;
        bool mDockState;
    };

    void saveFloaterPosition(const LLUUID& object_id, const FloaterPositionInfo& fpi);

    bool getFloaterPosition(const LLUUID& object_id, FloaterPositionInfo& fpi);

    void setFloaterVisible(const LLUUID& notification_id, bool visible);

protected:

    /**
     * Removes all script-dialog notifications
     */
    static void clearScriptNotifications();

    typedef std::map<std::string, EObjectType> object_type_map;

    static object_type_map initObjectTypeMap();

    // <notification_id, object_id>
    typedef std::map<LLUUID, LLUUID> script_notification_map_t;

    script_notification_map_t::const_iterator findUsingObjectId(const LLUUID& object_id);
    script_notification_map_t::const_iterator findUsingObjectIdAndChannel(const LLUUID& object_id, S32 im_channel);

private:

    script_notification_map_t mNotifications;

    object_signal_t mNewObjectSignal;
    object_signal_t mToggleFloaterSignal;

    // <object_id, floater position>
    typedef std::map<LLUUID, FloaterPositionInfo> floater_position_map_t;

    floater_position_map_t mFloaterPositions;
    boost::signals2::connection mDialogLimitationsSlot;
};

/**
 * Floater script forms.
 * LLScriptFloater will create script form based on notification data and
 * will auto fit the form.
 */
class LLScriptFloater : public LLDockableFloater
{
public:

    /**
     * key - UUID of scripted Object
     */
    LLScriptFloater(const LLSD& key);

    virtual ~LLScriptFloater(){};

    /**
     * Toggle existing floater or create and show a new one.
     */
    static bool toggle(const LLUUID& object_id);

    /**
     * Creates and shows floater
     */
    static LLScriptFloater* show(const LLUUID& object_id);

    const LLUUID& getNotificationId() { return mNotificationId; }

    void setNotificationId(const LLUUID& id);

    /**
     * Close notification if script floater is closed.
     */
    /*virtual*/ void onClose(bool app_quitting);

    /**
     * Hide all notification toasts when we show dockable floater
     */
    /*virtual*/ void setDocked(bool docked, bool pop_on_undock = true);

    /**
     * Hide all notification toasts when we show dockable floater
     */
    /*virtual*/ void setVisible(bool visible);

    bool getSavePosition() { return mSaveFloaterPosition; }

    void setSavePosition(bool save) { mSaveFloaterPosition = save; }

    void savePosition();

    void restorePosition();

protected:

    /**
     * Creates script form, will delete old form if floater is shown for same object.
     */
    void createForm(const LLUUID& object_id);

    /**
     * Hide all notification toasts.
     */
    static void hideToastsIfNeeded();

    /**
     * Removes chiclets new messages icon
     */
    void onMouseDown();

    /*virtual*/ void onFocusLost();

    /*virtual*/ void onFocusReceived();

    void dockToChiclet(bool dock);

private:
    bool isScriptTextbox(LLNotificationPtr notification);

    LLToastPanel* mScriptForm;
    LLUUID mNotificationId;
    LLUUID mObjectId;
    bool mSaveFloaterPosition;
};

#endif //LL_SCRIPTFLOATER_H