summaryrefslogtreecommitdiff
path: root/indra/llui/lldockablefloater.cpp
blob: 19ae03cdf9f8aa2178698ca89d84eac390d5735b (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
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
/**
 * @file lldockablefloater.cpp
 * @brief Creates a panel of a specific kind for a toast
 *
 * $LicenseInfo:firstyear=2000&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$
 */

#include "linden_common.h"

#include "lldockablefloater.h"
#include "llfloaterreg.h"

//static
LLHandle<LLFloater> LLDockableFloater::sInstanceHandle;

//static
void LLDockableFloater::init(LLDockableFloater* thiz)
{
    thiz->setDocked(thiz->mDockControl.get() != NULL
            && thiz->mDockControl.get()->isDockVisible());
    thiz->resetInstance();

    // all dockable floaters should have close, dock and minimize buttons
    thiz->setCanClose(true);
    thiz->setCanDock(true);
    thiz->setCanMinimize(true);
    thiz->setOverlapsScreenChannel(false);
    thiz->mForceDocking = false;
}

LLDockableFloater::LLDockableFloater(LLDockControl* dockControl,
        const LLSD& key, const Params& params) :
    LLFloater(key, params), mDockControl(dockControl), mUniqueDocking(true)
{
    init(this);
    mUseTongue = true;
}

LLDockableFloater::LLDockableFloater(LLDockControl* dockControl, bool uniqueDocking,
        const LLSD& key, const Params& params) :
    LLFloater(key, params), mDockControl(dockControl), mUniqueDocking(uniqueDocking)
{
    init(this);
    mUseTongue = true;
}

LLDockableFloater::LLDockableFloater(LLDockControl* dockControl, bool uniqueDocking,
        bool useTongue, const LLSD& key, const Params& params) :
    LLFloater(key, params), mDockControl(dockControl), mUseTongue(useTongue), mUniqueDocking(uniqueDocking)
{
    init(this);
}

LLDockableFloater::~LLDockableFloater()
{
}

bool LLDockableFloater::postBuild()
{
    // Remember we should force docking when the floater is opened for the first time
    if (mIsDockedStateForcedCallback != NULL && mIsDockedStateForcedCallback())
    {
        mForceDocking = true;
    }

    mDockTongue = LLUI::getUIImage("Flyout_Pointer");
    LLFloater::setDocked(true);
    return LLView::postBuild();
}

//static
void LLDockableFloater::toggleInstance(const LLSD& sdname)
{
    LLSD key;
    std::string name = sdname.asString();

    LLDockableFloater* instance =
            dynamic_cast<LLDockableFloater*> (LLFloaterReg::findInstance(name));
    // if floater closed or docked
    if (instance == NULL || (instance && instance->isDocked()))
    {
        LLFloaterReg::toggleInstance(name, key);
        // restore button toggle state
        if (instance != NULL)
        {
            instance->storeVisibilityControl();
        }
    }
    // if floater undocked
    else if (instance != NULL)
    {
        instance->setMinimized(false);
        if (instance->getVisible())
        {
            instance->setVisible(false);
        }
        else
        {
            instance->setVisible(true);
            gFloaterView->bringToFront(instance);
        }
    }
}

void LLDockableFloater::resetInstance()
{
    if (mUniqueDocking && sInstanceHandle.get() != this)
    {
        if (sInstanceHandle.get() != NULL && sInstanceHandle.get()->isDocked())
        {
            sInstanceHandle.get()->setVisible(false);
        }
        sInstanceHandle = getHandle();
    }
}

void LLDockableFloater::setVisible(bool visible)
{
    // Force docking if requested
    if (visible && mForceDocking)
    {
        setCanDock(true);
        setDocked(true);
        mForceDocking = false;
    }

    if(visible && isDocked())
    {
        resetInstance();
    }

    if (visible && mDockControl.get() != NULL)
    {
        mDockControl.get()->repositionDockable();
    }

    if (visible && !isMinimized())
    {
        LLFloater::setFrontmost(getAutoFocus());
    }
    LLFloater::setVisible(visible);
}

void LLDockableFloater::setMinimized(bool minimize)
{
    if(minimize && isDocked())
    {
        // minimizing a docked floater just hides it
        setVisible(false);
    }
    else
    {
        LLFloater::setMinimized(minimize);
    }
}

LLView * LLDockableFloater::getDockWidget()
{
    LLView * res = NULL;
    if (getDockControl() != NULL) {
        res = getDockControl()->getDock();
    }

    return res;
}

void LLDockableFloater::onDockHidden()
{
    setCanDock(false);
}

void LLDockableFloater::onDockShown()
{
    if (!isMinimized())
    {
        setCanDock(true);
    }
}

void LLDockableFloater::setDocked(bool docked, bool pop_on_undock)
{
    if (mDockControl.get() != NULL && mDockControl.get()->isDockVisible())
    {
        if (docked)
        {
            resetInstance();
            mDockControl.get()->on();
        }
        else
        {
            mDockControl.get()->off();
        }

        if (!docked && pop_on_undock)
        {
            // visually pop up a little bit to emphasize the undocking
            translate(0, UNDOCK_LEAP_HEIGHT);
        }
    }

    LLFloater::setDocked(docked, pop_on_undock);
}

void LLDockableFloater::draw()
{
    if (mDockControl.get() != NULL)
    {
        mDockControl.get()->repositionDockable();
        if (isDocked())
        {
            mDockControl.get()->drawToungue();
        }
    }
    LLFloater::draw();
}

void LLDockableFloater::setDockControl(LLDockControl* dockControl)
{
    mDockControl.reset(dockControl);
    setDocked(isDocked());
}

const LLUIImagePtr& LLDockableFloater::getDockTongue(LLDockControl::DocAt dock_side)
{
    switch(dock_side)
    {
    case LLDockControl::LEFT:
        mDockTongue = LLUI::getUIImage("Flyout_Left");
        break;
    case LLDockControl::RIGHT:
        mDockTongue = LLUI::getUIImage("Flyout_Right");
        break;
    default:
        mDockTongue = LLUI::getUIImage("Flyout_Pointer");
        break;
    }

    return mDockTongue;
}

LLDockControl* LLDockableFloater::getDockControl()
{
    return mDockControl.get();
}