MyGUI::StaticImage Class Reference

#include <MyGUI_StaticImage.h>

Inheritance diagram for MyGUI::StaticImage:
Inheritance graph
[legend]

Public Member Functions

 StaticImage ()
void setImageInfo (const std::string &_texture, const IntCoord &_coord, const IntSize &_tile)
void setImageTexture (const std::string &_value)
void setImageRect (const IntRect &_value)
void setImageCoord (const IntCoord &_value)
void setImageTile (const IntSize &_value)
void setImageIndex (size_t _index)
size_t getImageIndex ()
size_t getItemCount () const
 Get number of items.
void setItemSelect (size_t _index)
 Select specified _index.
size_t getItemSelect ()
 Get index of selected item (ITEM_NONE if none selected).
void resetItemSelect ()
 Reset item selection.
void insertItem (size_t _index, const IntCoord &_item)
 Insert an item into a list at a specified position.
void addItem (const IntCoord &_item)
 Add an item to the end of a list.
void setItem (size_t _index, const IntCoord &_item)
 Replace an item at a specified position.
void deleteItem (size_t _index)
 Delete item at a specified position.
void deleteAllItems ()
 Delete all items.
void addItemFrame (size_t _index, const IntCoord &_item)
void insertItemFrame (size_t _index, size_t _indexFrame, const IntCoord &_item)
void addItemFrameDublicate (size_t _index, size_t _indexSourceFrame)
void insertItemFrameDublicate (size_t _index, size_t _indexFrame, size_t _indexSourceFrame)
void setItemFrame (size_t _index, size_t _indexFrame, const IntCoord &_item)
void deleteItemFrame (size_t _index, size_t _indexFrame)
void deleteAllItemFrames (size_t _index)
void setItemFrameRate (size_t _index, float _rate)
float getItemFrameRate (size_t _index)
bool setItemResource (const Guid &_id)
bool setItemResource (const std::string &_name)
void setItemGroup (const std::string &_value)
void setItemName (const std::string &_value)
void setItemResourcePtr (ResourceImageSetPtr _resource)
void setItemResourceInfo (const ImageIndexInfo &_info)
ResourceImageSetPtr getItemResource ()
void setItemResourceInfo (ResourceImageSetPtr _resource, const std::string &_group, const std::string &_name)
virtual void setProperty (const std::string &_key, const std::string &_value)
virtual void _initialise (WidgetStyle _style, const IntCoord &_coord, Align _align, ResourceSkin *_info, Widget *_parent, ICroppedRectangle *_croppedParent, IWidgetCreator *_creator, const std::string &_name)

Protected Member Functions

virtual ~StaticImage ()
void baseChangeWidgetSkin (ResourceSkin *_info)

Detailed Description

Definition at line 35 of file MyGUI_StaticImage.h.

Constructor & Destructor Documentation

MyGUI::StaticImage::StaticImage (  ) 

Definition at line 37 of file MyGUI_StaticImage.cpp.

MyGUI::StaticImage::~StaticImage (  )  [protected, virtual]

Definition at line 53 of file MyGUI_StaticImage.cpp.

Member Function Documentation

void MyGUI::StaticImage::_initialise ( WidgetStyle  _style,
const IntCoord &  _coord,
Align  _align,
ResourceSkin *  _info,
Widget *  _parent,
ICroppedRectangle *  _croppedParent,
IWidgetCreator *  _creator,
const std::string &  _name 
) [virtual]

Reimplemented from MyGUI::Widget.

Definition at line 46 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::addItem ( const IntCoord &  _item  )  [inline]

Add an item to the end of a list.

Definition at line 101 of file MyGUI_StaticImage.h.

void MyGUI::StaticImage::addItemFrame ( size_t  _index,
const IntCoord &  _item 
)

Add frame

Parameters:
_index Image item index
_item Frame coordinates at image texture

Definition at line 299 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::addItemFrameDublicate ( size_t  _index,
size_t  _indexSourceFrame 
)

Add copy of frame (similar to StaticImage::addItemFrame but we copy frame coordinates)

Parameters:
_index Image item index
_indexSourceFrame Frame index of frame that we copying

Definition at line 320 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::baseChangeWidgetSkin ( ResourceSkin *  _info  )  [protected, virtual]

Reimplemented from MyGUI::Widget.

Definition at line 58 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::deleteAllItemFrames ( size_t  _index  ) 

Delete all frames

Parameters:
_index Image item index

Definition at line 292 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::deleteAllItems (  ) 

Delete all items.

Definition at line 243 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::deleteItem ( size_t  _index  ) 

Delete item at a specified position.

Definition at line 230 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::deleteItemFrame ( size_t  _index,
size_t  _indexFrame 
)

Delete frame

Parameters:
_index Image item index
_indexFrame Frame index that we delete

Definition at line 364 of file MyGUI_StaticImage.cpp.

size_t MyGUI::StaticImage::getImageIndex (  ) 

Get current tile index

Definition at line 511 of file MyGUI_StaticImage.cpp.

size_t MyGUI::StaticImage::getItemCount (  )  const [inline]

Get number of items.

Definition at line 89 of file MyGUI_StaticImage.h.

float MyGUI::StaticImage::getItemFrameRate ( size_t  _index  ) 

Get item frame rate

Parameters:
_index Image item index

Definition at line 313 of file MyGUI_StaticImage.cpp.

ResourceImageSetPtr MyGUI::StaticImage::getItemResource (  )  [inline]

Get current items resource used in StaticImage

Definition at line 195 of file MyGUI_StaticImage.h.

size_t MyGUI::StaticImage::getItemSelect (  )  [inline]

Get index of selected item (ITEM_NONE if none selected).

Definition at line 94 of file MyGUI_StaticImage.h.

void MyGUI::StaticImage::insertItem ( size_t  _index,
const IntCoord &  _item 
)

Insert an item into a list at a specified position.

Definition at line 249 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::insertItemFrame ( size_t  _index,
size_t  _indexFrame,
const IntCoord &  _item 
)

Insert frame

Parameters:
_index Image item index
_indexFrame Frame index where we insert frame
_item Frame coordinates at image texture

Definition at line 329 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::insertItemFrameDublicate ( size_t  _index,
size_t  _indexFrame,
size_t  _indexSourceFrame 
)

Insert copy of frame (similar to StaticImage::insertItemFrame but we copy frame coordinates)

Parameters:
_index Image item index
_indexFrame Frame index where we insert frame
_indexSourceFrame Frame index of frame that we copying

Definition at line 341 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::resetItemSelect (  )  [inline]

Reset item selection.

Definition at line 96 of file MyGUI_StaticImage.h.

void MyGUI::StaticImage::setImageCoord ( const IntCoord &  _value  ) 

Set _coord - part of texture where we take tiles

Definition at line 116 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::setImageIndex ( size_t  _index  ) 

Set current tile index

Parameters:
_index - tile index
Remarks:
Tiles in file start numbering from left to right and from top to bottom.
:
				+---+---+---+
				| 0 | 1 | 2 |
				+---+---+---+
				| 3 | 4 | 5 |
				+---+---+---+

Definition at line 506 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::setImageInfo ( const std::string &  _texture,
const IntCoord &  _coord,
const IntSize &  _tile 
)

Definition at line 88 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::setImageRect ( const IntRect &  _value  ) 

Set _rect - part of texture where we take tiles

Definition at line 132 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::setImageTexture ( const std::string &  _value  ) 

Definition at line 145 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::setImageTile ( const IntSize &  _value  ) 

Set _tile size

Definition at line 103 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::setItem ( size_t  _index,
const IntCoord &  _item 
)

Replace an item at a specified position.

Definition at line 261 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::setItemFrame ( size_t  _index,
size_t  _indexFrame,
const IntCoord &  _item 
)

Change frame

Parameters:
_index Image item index
_indexFrame Frame index to change
_item Frame coordinates at image texture

Definition at line 354 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::setItemFrameRate ( size_t  _index,
float  _rate 
)

Set item frame rate

Parameters:
_index Image item index
_rate Duration of one frame in seconds

Definition at line 306 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::setItemGroup ( const std::string &  _value  ) 

Select current item group

Definition at line 457 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::setItemName ( const std::string &  _value  ) 

Select current item mane

Definition at line 467 of file MyGUI_StaticImage.cpp.

bool MyGUI::StaticImage::setItemResource ( const std::string &  _name  ) 

Select current items resource used in StaticImage

Parameters:
_id Resource name
Returns:
false if resource with such name not exist

Definition at line 407 of file MyGUI_StaticImage.cpp.

bool MyGUI::StaticImage::setItemResource ( const Guid &  _id  ) 

Select current items resource used in StaticImage

Parameters:
_id Resource guid
Returns:
false if resource with such guid not exist

Definition at line 400 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::setItemResourceInfo ( ResourceImageSetPtr  _resource,
const std::string &  _group,
const std::string &  _name 
)

Select current item resource, group and name

Definition at line 477 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::setItemResourceInfo ( const ImageIndexInfo &  _info  ) 

Set current item

Definition at line 375 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::setItemResourcePtr ( ResourceImageSetPtr  _resource  ) 

Select current items resource used in StaticImage

Parameters:
_resource Resource pointer

Definition at line 414 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::setItemSelect ( size_t  _index  ) 

Select specified _index.

Definition at line 516 of file MyGUI_StaticImage.cpp.

void MyGUI::StaticImage::setProperty ( const std::string &  _key,
const std::string &  _value 
) [virtual]

Set any widget property

Parameters:
_key Property name (for example Widget_Alpha or Edit_MultiLine)
_value Value converted to string

Reimplemented from MyGUI::Widget.

Definition at line 521 of file MyGUI_StaticImage.cpp.

The documentation for this class was generated from the following files:
Generated on Thu Nov 17 15:31:20 2011 for MyGUI by  doxygen 1.6.3