summaryrefslogtreecommitdiff
path: root/indra/llui/llscrolllistitem.h
blob: 8a78efbd7c09f027424cc08482aaae70cfb9ba93 (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
/**
 * @file llscrolllistitem.h
 * @brief Scroll lists are composed of rows (items), each of which
 * contains columns (cells).
 *
 * $LicenseInfo:firstyear=2007&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 LLSCROLLLISTITEM_H
#define LLSCROLLLISTITEM_H

#include "llpointer.h"      // LLPointer<>
#include "llsd.h"
#include "v4color.h"
#include "llinitparam.h"
#include "llscrolllistcell.h"
#include "llcoord.h"

#include <vector>

class LLCheckBoxCtrl;
class LLResizeBar;
class LLScrollListCtrl;
class LLScrollColumnHeader;
class LLUIImage;

//---------------------------------------------------------------------------
// LLScrollListItem
//---------------------------------------------------------------------------
class LLScrollListItem
{
    friend class LLScrollListCtrl;
public:
    struct Params : public LLInitParam::Block<Params>
    {
        Optional<bool>      enabled;
        Optional<void*>     userdata;
        Optional<LLSD>      value;
        Optional<LLSD>      alt_value;

        Ignored             name; // use for localization tools
        Ignored             type;
        Ignored             length;

        Multiple<LLScrollListCell::Params> columns;

        Params()
        :   enabled("enabled", true),
            value("value"),
            alt_value("alt_value"),
            name("name"),
            type("type"),
            length("length"),
            columns("columns")
        {
            addSynonym(columns, "column");
            addSynonym(value, "id");
        }
    };

    virtual ~LLScrollListItem();

    void    setSelected( BOOL b );
    BOOL    getSelected() const             { return mSelected; }

    void    setEnabled( BOOL b )            { mEnabled = b; }
    BOOL    getEnabled() const              { return mEnabled; }

    void    setHighlighted( BOOL b );
    BOOL    getHighlighted() const          { return mHighlighted; }

    void    setSelectedCell( S32 cell );
    S32     getSelectedCell() const         { return mSelectedIndex; }

    void    setHoverCell( S32 cell );
    S32     getHoverCell() const            { return mHoverIndex; }

    void    setUserdata( void* userdata )   { mUserdata = userdata; }
    void*   getUserdata() const             { return mUserdata; }

    virtual LLUUID  getUUID() const         { return mItemValue.asUUID(); }
    LLSD    getValue() const                { return mItemValue; }
    LLSD    getAltValue() const             { return mItemAltValue; }

    void    setRect(LLRect rect)            { mRectangle = rect; }
    LLRect  getRect() const                 { return mRectangle; }

    void    addColumn( const LLScrollListCell::Params& p );

    void    setNumColumns(S32 columns);

    void    setColumn( S32 column, LLScrollListCell *cell );

    S32     getNumColumns() const;

    LLScrollListCell *getColumn(const S32 i) const;

    std::string getContentsCSV() const;

    virtual void draw(const LLRect& rect,
                      const LLColor4& fg_color,
                      const LLColor4& hover_color, // highlight/hover selection of whole item or cell
                      const LLColor4& select_color, // highlight/hover selection of whole item or cell
                      const LLColor4& highlight_color, // highlights contents of cells (ex: text)
                      S32 column_padding);

protected:
    LLScrollListItem( const Params& );

private:
    BOOL    mSelected;
    BOOL    mHighlighted;
    S32     mHoverIndex;
    S32     mSelectedIndex;
    BOOL    mEnabled;
    void*   mUserdata;
    LLSD    mItemValue;
    LLSD    mItemAltValue;
    std::vector<LLScrollListCell *> mColumns;
    LLRect  mRectangle;
};

#endif