summaryrefslogtreecommitdiff
path: root/indra/llui/lldraghandle.h
blob: f61dae8dc3ad50a38bf599a43ab69632cc73d7fb (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
/**
 * @file lldraghandle.h
 * @brief LLDragHandle base class
 *
 * $LicenseInfo:firstyear=2001&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$
 */

// A widget for dragging a view around the screen using the mouse.

#ifndef LL_DRAGHANDLE_H
#define LL_DRAGHANDLE_H

#include "llview.h"
#include "v4color.h"
#include "llrect.h"
#include "llcoord.h"

class LLTextBox;

class LLDragHandle : public LLView
{
public:
    struct Params
    :   public LLInitParam::Block<Params, LLView::Params>
    {
        Optional<std::string> label;
        Optional<LLUIColor> drag_highlight_color;
        Optional<LLUIColor> drag_shadow_color;

        Params()
        :   label("label"),
            drag_highlight_color("drag_highlight_color", LLUIColorTable::instance().getColor("DefaultHighlightLight")),
            drag_shadow_color("drag_shadow_color", LLUIColorTable::instance().getColor("DefaultShadowDark"))
        {
            changeDefault(mouse_opaque, true);
            changeDefault(follows.flags, FOLLOWS_ALL);
        }
    };
    void initFromParams(const Params&);

    virtual ~LLDragHandle();

    virtual void setValue(const LLSD& value);

    void            setForeground(BOOL b)       { mForeground = b; }
    BOOL            getForeground() const       { return mForeground; }
    void            setMaxTitleWidth(S32 max_width) {mMaxTitleWidth = llmin(max_width, mMaxTitleWidth); }
    S32             getMaxTitleWidth() const { return mMaxTitleWidth; }
    void            setButtonsRect(const LLRect& rect){ mButtonsRect = rect; }
    LLRect          getButtonsRect() { return mButtonsRect; }
    void            setTitleVisible(BOOL visible);

    virtual void    setTitle( const std::string& title ) = 0;
    virtual std::string getTitle() const = 0;

    virtual BOOL    handleHover(S32 x, S32 y, MASK mask);
    virtual BOOL    handleMouseDown(S32 x, S32 y, MASK mask);
    virtual BOOL    handleMouseUp(S32 x, S32 y, MASK mask);

protected:
    LLDragHandle(const Params&);
    friend class LLUICtrlFactory;

protected:
    LLTextBox*      mTitleBox;

private:
    LLRect          mButtonsRect;
    S32             mDragLastScreenX;
    S32             mDragLastScreenY;
    S32             mLastMouseScreenX;
    S32             mLastMouseScreenY;
    LLCoordGL       mLastMouseDir;
    LLUIColor       mDragHighlightColor;
    LLUIColor       mDragShadowColor;
    S32             mMaxTitleWidth;
    BOOL            mForeground;

    // Pixels near the edge to snap floaters.
    static S32      sSnapMargin;
};


// Use this one for traditional top-of-window draggers
class LLDragHandleTop
: public LLDragHandle
{
protected:
    LLDragHandleTop(const Params& p) : LLDragHandle(p) {}
    friend class LLUICtrlFactory;
public:
    virtual void    setTitle( const std::string& title );
    virtual std::string getTitle() const;
    virtual void    draw();
    virtual void    reshape(S32 width, S32 height, BOOL called_from_parent = TRUE);

private:
    void    reshapeTitleBox();
};


// Use this for left-side, vertical text draggers
class LLDragHandleLeft
: public LLDragHandle
{
protected:
    LLDragHandleLeft(const Params& p) : LLDragHandle(p) {}
    friend class LLUICtrlFactory;
public:
    virtual void    setTitle( const std::string& title );
    virtual std::string getTitle() const;
    virtual void    draw();
    virtual void    reshape(S32 width, S32 height, BOOL called_from_parent = TRUE);

};

const S32 DRAG_HANDLE_HEIGHT = 16;
const S32 DRAG_HANDLE_WIDTH = 16;

#endif  // LL_DRAGHANDLE_H