openmw-tes3coop/extern/mygui_3.0.1/MyGUIEngine/include/MyGUI_ListBox.h
2010-07-08 00:23:28 +02:00

147 lines
4.5 KiB
C++

/*!
@file
@author Albert Semenov
@date 04/2009
@module
*/
/*
This file is part of MyGUI.
MyGUI 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, either version 3 of the License, or
(at your option) any later version.
MyGUI 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 MyGUI. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __MYGUI_LIST_BOX_H__
#define __MYGUI_LIST_BOX_H__
#include "MyGUI_Prerequest.h"
#include "MyGUI_ListCtrl.h"
namespace MyGUI
{
class MYGUI_EXPORT ListBox :
public ListCtrl
{
MYGUI_RTTI_DERIVED( ListBox )
public:
ListBox();
//------------------------------------------------------------------------------//
// ìàíèïóëÿöèè àéòåìàìè
//! Get number of items
size_t getItemCount() const { return mItemsInfo.size(); }
//! Insert an item into a array at a specified position
void insertItemAt(size_t _index, const UString& _name, Any _data = Any::Null);
//! Add an item to the end of a array
void addItem(const UString& _name, Any _data = Any::Null) { insertItemAt(ITEM_NONE, _name, _data); }
//! Remove item at a specified position
void removeItemAt(size_t _index);
//! Remove all items
void removeAllItems();
//! Swap items at a specified positions
void swapItemsAt(size_t _index1, size_t _index2);
//! Search item, returns the position of the first occurrence in array or ITEM_NONE if item not found
size_t findItemIndexWith(const UString& _name);
//------------------------------------------------------------------------------//
// ìàíèïóëÿöèè âûäåëåíèÿìè
/** Get index of selected item (ITEM_NONE if none selected) */
size_t getIndexSelected() { return Base::getIndexSelected(); }
/** Select specified _index */
void setIndexSelected(size_t _index) { Base::setIndexSelected(_index); }
/** Clear item selection */
void clearIndexSelected() { Base::clearIndexSelected(); }
//------------------------------------------------------------------------------//
// ìàíèïóëÿöèè äàííûìè
//! Replace an item data at a specified position
void setItemDataAt(size_t _index, Any _data) { Base::setItemDataAt(_index, _data); }
//! Clear an item data at a specified position
void clearItemDataAt(size_t _index) { Base::clearItemDataAt(_index); }
//! Get item data from specified position
template <typename ValueType>
ValueType * getItemDataAt(size_t _index, bool _throw = true)
{
return Base::getItemDataAt<ValueType>(_index, _throw);
}
//------------------------------------------------------------------------------//
// ìàíèïóëÿöèè îòîáðàæåíèåì
//! Replace an item name at a specified position
void setItemNameAt(size_t _index, const UString& _name);
//! Get item name from specified position
const UString& getItemNameAt(size_t _index);
//------------------------------------------------------------------------------//
// ìàíèïóëÿöèè âûäèìîñòüþ
//! Move all elements so specified becomes visible
void beginToItemAt(size_t _index);
//! Move all elements so first becomes visible
void beginToItemFirst() { if (getItemCount()) beginToItemAt(0); }
//! Move all elements so last becomes visible
void beginToItemLast() { if (getItemCount()) beginToItemAt(getItemCount() - 1); }
//! Move all elements so selected becomes visible
void beginToItemSelected() { if (getIndexSelected() != ITEM_NONE) beginToItemAt(getIndexSelected()); }
/*internal:*/
virtual void _initialise(WidgetStyle _style, const IntCoord& _coord, Align _align, ResourceSkin* _info, Widget* _parent, ICroppedRectangle * _croppedParent, IWidgetCreator * _creator, const std::string& _name);
protected:
virtual ~ListBox();
void baseChangeWidgetSkin(ResourceSkin* _info);
private:
void initialiseWidgetSkin(ResourceSkin* _info);
void shutdownWidgetSkin();
void notifyCreateWidgetItem(MyGUI::ListCtrl* _sender, MyGUI::Widget* _item);
void notifyDrawItem(MyGUI::ListCtrl* _sender, MyGUI::Widget* _item, const MyGUI::IBDrawItemInfo& _info, MyGUI::IntCoord& _coord);
private:
std::string mSkinLine;
int mHeightLine;
typedef std::vector<UString> VectorUTFString;
VectorUTFString mItemsInfo;
};
} // namespace MyGUI
#endif // __MYGUI_LIST_BOX_H__