summaryrefslogtreecommitdiff
path: root/indra/newview/llinventorylistitem.h
blob: 21540a380bf29e1a5a7d78873457424305dd4e23 (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
/**
 * @file llinventorylistitem.h
 * @brief Inventory list item panel.
 *
 * Class LLPanelInventoryListItemBase displays inventory item as an element
 * of LLInventoryItemsList.
 *
 * $LicenseInfo:firstyear=2010&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_LLINVENTORYLISTITEM_H
#define LL_LLINVENTORYLISTITEM_H

// llcommon
#include "llassettype.h"

// llui
#include "llpanel.h"
#include "llstyle.h"
#include "lliconctrl.h"
#include "lltextbox.h"

// newview
#include "llwearabletype.h"

class LLViewerInventoryItem;

/**
 * @class LLPanelInventoryListItemBase
 *
 * Base class for Inventory flat list item. Panel consists of inventory icon
 * and inventory item name.
 * This class is able to display widgets(buttons) on left(before icon) and right(after text-box) sides
 * of panel.
 *
 * How to use (see LLPanelClothingListItem for example):
 * - implement init() to build panel from xml
 * - create new xml file, fill it with widgets you want to dynamically show/hide/reshape on left/right sides
 * - redefine postBuild()(call base implementation) and add needed widgets to needed sides,
 *
 */
class LLPanelInventoryListItemBase : public LLPanel
{
public:
    struct Params : public LLInitParam::Block<Params, LLPanel::Params>
    {
        Optional<LLStyle::Params>   default_style,
                                    worn_style;
        Optional<LLUIImage*>        hover_image,
                                    selected_image,
                                    separator_image;
        Optional<LLIconCtrl::Params>    item_icon;
        Optional<LLTextBox::Params>     item_name;
        Params();
    };

    typedef enum e_item_state {
        IS_DEFAULT,
        IS_WORN,
    } EItemState;

    static LLPanelInventoryListItemBase* create(LLViewerInventoryItem* item);

    virtual void draw();

    /**
     * Let item know it need to be refreshed in next draw()
     */
    void setNeedsRefresh(bool needs_refresh){ mNeedsRefresh = needs_refresh; }

    bool getNeedsRefresh(){ return mNeedsRefresh; }

    /**
     * Add widget to left side
     */
    void addWidgetToLeftSide(const std::string& name, bool show_widget = true);
    void addWidgetToLeftSide(LLUICtrl* ctrl, bool show_widget = true);

    /**
     * Add widget to right side, widget is supposed to be child of calling panel
     */
    void addWidgetToRightSide(const std::string& name, bool show_widget = true);
    void addWidgetToRightSide(LLUICtrl* ctrl, bool show_widget = true);

    /**
     * Mark widgets as visible. Only visible widgets take part in reshaping children
     */
    void setShowWidget(const std::string& name, bool show);
    void setShowWidget(LLUICtrl* ctrl, bool show);

    /**
     * Set spacing between widgets during reshape
     */
    void setWidgetSpacing(S32 spacing) { mWidgetSpacing = spacing; }

    S32 getWidgetSpacing() { return mWidgetSpacing; }

    /**
     * Inheritors need to call base implementation of postBuild()
     */
    /*virtual*/ bool postBuild();

    /**
     * Handles item selection
     */
    /*virtual*/ void setValue(const LLSD& value);

    /**
     * Handles filter request
     */
    /*virtual*/ S32  notify(const LLSD& info);

    /* Highlights item */
    /*virtual*/ bool handleHover(S32 x, S32 y, MASK mask);
    /* Removes item highlight */
    /*virtual*/ void onMouseLeave(S32 x, S32 y, MASK mask);

    /** Get the name of a corresponding inventory item */
    const std::string& getItemName() const;

    /** Get the asset type of a corresponding inventory item */
    LLAssetType::EType getType() const;

    /** Get the wearable type of a corresponding inventory item */
    LLWearableType::EType getWearableType() const;

    /** Get the description of a corresponding inventory item */
    const std::string& getDescription() const;

    /** Get the creation date of a corresponding inventory item */
    time_t getCreationDate() const;

    /** Get the associated inventory item */
    LLViewerInventoryItem* getItem() const;

    void setSeparatorVisible(bool visible) { mSeparatorVisible = visible; }
    void resetHighlight() { mHovered = false; }

    virtual ~LLPanelInventoryListItemBase(){}

protected:

    LLPanelInventoryListItemBase(LLViewerInventoryItem* item, const Params& params);

    typedef std::vector<LLUICtrl*> widget_array_t;

    /**
     * Called after inventory item was updated, update panel widgets to reflect inventory changes.
     */
    virtual void updateItem(const std::string& name,
                            EItemState item_state = IS_DEFAULT);

    void setLeftWidgetsWidth(S32 width) { mLeftWidgetsWidth = width; }
    void setRightWidgetsWidth(S32 width) { mRightWidgetsWidth = width; }

    /**
     * Set all widgets from both side visible/invisible. Only enabled widgets
     * (see setShowWidget()) can become visible
     */
    virtual void setWidgetsVisible(bool visible);

    /**
     * Reshape all child widgets - icon, text-box and side widgets
     */
    virtual void reshapeWidgets();

    /** set wearable type icon image */
    void setIconImage(const LLUIImagePtr& image);

    /** Set item title - inventory item name usually */
    void setTitle(const std::string& title,
                  const std::string& highlit_text,
                  EItemState item_state = IS_DEFAULT);

    /**
     * Show tool tip if item name text size > panel size
     */
    virtual bool handleToolTip( S32 x, S32 y, MASK mask);

    const LLUUID mInventoryItemUUID;
    bool mHovered;

private:

    /** reshape left side widgets
     * Deprecated for now. Disabled reshape left for now to reserve space for 'delete'
     * button in LLPanelClothingListItem according to Neal's comment (https://codereview.productengine.com/secondlife/r/325/)
     */
    void reshapeLeftWidgets();

    /** reshape right side widgets */
    void reshapeRightWidgets();

    /** reshape remaining widgets */
    void reshapeMiddleWidgets();


    LLIconCtrl*     mIconCtrl;
    LLTextBox*      mTitleCtrl;

    LLUIImagePtr    mIconImage;
    LLUIImagePtr    mHoverImage;
    LLUIImagePtr    mSelectedImage;
    LLUIImagePtr    mSeparatorImage;

    bool            mSelected;
    bool            mSeparatorVisible;

    std::string     mHighlightedText;

    widget_array_t  mLeftSideWidgets;
    widget_array_t  mRightSideWidgets;
    S32             mWidgetSpacing;

    S32             mLeftWidgetsWidth;
    S32             mRightWidgetsWidth;
    bool            mNeedsRefresh;
};

#endif //LL_LLINVENTORYLISTITEM_H