summaryrefslogtreecommitdiff
path: root/indra/llui/llscrollbar.h
blob: bbfc3a03406661e7cdd01af01cfdc448365f72c7 (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
/**
 * @file llscrollbar.h
 * @brief Scrollbar UI widget
 *
 * $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$
 */

#ifndef LL_SCROLLBAR_H
#define LL_SCROLLBAR_H

#include "stdtypes.h"
#include "lluictrl.h"
#include "v4color.h"
#include "llbutton.h"

//
// Classes
//
class LLScrollbar
: public LLUICtrl
{
public:

    typedef boost::function<void (S32, LLScrollbar*)> callback_t;
    struct Params
    :   public LLInitParam::Block<Params, LLUICtrl::Params>
    {
        Mandatory<EOrientation>         orientation;
        Mandatory<S32>                  doc_size;
        Mandatory<S32>                  doc_pos;
        Mandatory<S32>                  page_size;

        Optional<callback_t>            change_callback;
        Optional<S32>                   step_size;
        Optional<S32>                   thickness;

        Optional<LLUIImage*>            thumb_image_vertical,
                                        thumb_image_horizontal,
                                        track_image_horizontal,
                                        track_image_vertical;

        Optional<bool>                  bg_visible;

        Optional<LLUIColor>             track_color,
                                        thumb_color,
                                        bg_color;

        Optional<LLButton::Params>      up_button;
        Optional<LLButton::Params>      down_button;
        Optional<LLButton::Params>      left_button;
        Optional<LLButton::Params>      right_button;

        Params();
    };

protected:
    LLScrollbar (const Params & p);
    friend class LLUICtrlFactory;

public:
    virtual ~LLScrollbar();

    virtual void setValue(const LLSD& value);

    // Overrides from LLView
    virtual BOOL    handleKeyHere(KEY key, MASK mask);
    virtual BOOL    handleMouseDown(S32 x, S32 y, MASK mask);
    virtual BOOL    handleMouseUp(S32 x, S32 y, MASK mask);
    virtual BOOL    handleDoubleClick(S32 x, S32 y, MASK mask);
    virtual BOOL    handleHover(S32 x, S32 y, MASK mask);
    virtual BOOL    handleScrollWheel(S32 x, S32 y, S32 clicks);
    virtual BOOL    handleScrollHWheel(S32 x, S32 y, S32 clicks);
    virtual BOOL    handleDragAndDrop(S32 x, S32 y, MASK mask, BOOL drop,
        EDragAndDropType cargo_type, void *cargo_data, EAcceptance *accept, std::string &tooltip_msg);

    virtual void    reshape(S32 width, S32 height, BOOL called_from_parent = TRUE);

    virtual void    draw();

    // How long the "document" is.
    void                setDocSize( S32 size );
    S32                 getDocSize() const      { return mDocSize; }

    // How many "lines" the "document" has scrolled.
    // 0 <= DocPos <= DocSize - DocVisibile
    bool                setDocPos( S32 pos, BOOL update_thumb = TRUE );
    S32                 getDocPos() const       { return mDocPos; }

    bool                isAtBeginning() const;
    bool                isAtEnd() const;

    // Setting both at once.
    void                setDocParams( S32 size, S32 pos );

    // How many "lines" of the "document" is can appear on a page.
    void                setPageSize( S32 page_size );
    S32                 getPageSize() const     { return mPageSize; }

    // The farthest the document can be scrolled (top of the last page).
    S32                 getDocPosMax() const    { return llmax( 0, mDocSize - mPageSize); }

    void                pageUp(S32 overlap);
    void                pageDown(S32 overlap);

    void                onLineUpBtnPressed(const LLSD& data);
    void                onLineDownBtnPressed(const LLSD& data);

    S32                 getThickness() const { return mThickness; }
    void                setThickness(S32 thickness);

private:
    void                updateThumbRect();
    bool                changeLine(S32 delta, BOOL update_thumb );

    callback_t          mChangeCallback;

    const EOrientation  mOrientation;
    S32                 mDocSize;       // Size of the document that the scrollbar is modeling.  Units depend on the user.  0 <= mDocSize.
    S32                 mDocPos;        // Position within the doc that the scrollbar is modeling, in "lines" (user size)
    S32                 mPageSize;      // Maximum number of lines that can be seen at one time.
    S32                 mStepSize;
    BOOL                mDocChanged;

    LLRect              mThumbRect;
    S32                 mDragStartX;
    S32                 mDragStartY;
    F32                 mHoverGlowStrength;
    F32                 mCurGlowStrength;

    LLRect              mOrigRect;
    S32                 mLastDelta;

    LLUIColor           mTrackColor;
    LLUIColor           mThumbColor;
    LLUIColor           mBGColor;

    bool                mBGVisible;

    LLUIImagePtr        mThumbImageV;
    LLUIImagePtr        mThumbImageH;
    LLUIImagePtr        mTrackImageV;
    LLUIImagePtr        mTrackImageH;

    S32                 mThickness;
};


#endif  // LL_SCROLLBAR_H