Inheritance diagram for Osp::Ui::ClipboardItem:
- Since:
- 2.0
The ClipboardItem class represents the items in the system Clipboard. The ClipboardItem is the unit of data handling between the system clipboard and applications, and it contains both data itself and the type of the data.
For more information on the class features, see Clipboard.
Public Member Functions | |
| ClipboardItem (void) | |
| result | Construct (ClipboardDataType dataType, const Osp::Base::Object &data) |
| Osp::Base::Object * | GetData (void) const |
| ClipboardDataType | GetDataType (void) const |
| virtual | ~ClipboardItem (void) |
Constructor & Destructor Documentation
| Osp::Ui::ClipboardItem::ClipboardItem | ( | void | ) |
This is the default constructor for this class.
- Since:
- 2.0
| virtual Osp::Ui::ClipboardItem::~ClipboardItem | ( | void | ) | [virtual] |
This is the destructor for this class.
- Since:
- 2.0
Member Function Documentation
| result Osp::Ui::ClipboardItem::Construct | ( | ClipboardDataType | dataType, |
| const Osp::Base::Object & | data | ||
| ) |
Initializes this instance of ClipboardItem with the specified parameters.
- Since:
- 2.0
- Returns:
- An error code
- Parameters:
-
[in] dataType The data type [in] data The data to be copied
- Exceptions:
-
E_SUCCESS The method is successful. E_OUT_OF_MEMORY The memory is insufficient. E_INVALID_ARG A specified input parameter is invalid. E_INVALID_STATE This instance has already been constructed. E_SYSTEM A system error has occurred.
- Remarks:
- For the image data type, the bitmap instance should be deleted by the application after the item is copied to the clipboard.
| Osp::Base::Object* Osp::Ui::ClipboardItem::GetData | ( | void | ) | const |
Gets the data of ClipboardItem.
- Since:
- 2.0
- Returns:
- The pointer to the data
- Remarks:
- The application needs to type-cast the returned data object according to its data type.
| ClipboardDataType Osp::Ui::ClipboardItem::GetDataType | ( | void | ) | const |
Gets the data type of ClipboardItem.
- Since:
- 2.0
- Returns:
- The data type of the clipboard item
The documentation for this class was generated from the following file: