CGUIClipboard Class Reference

A simple Clipboard wrapper. More...

#include <GUIClipboard.h>

Public Member Functions
void	ClearClipboard ()
eC_String	GetString () const
void	PutString (const eC_String &kStr)

Static Public Member Functions
static void	CreateInstance ()
static void	DeleteInstance ()

Friends
class	CGUIComponentManager

Detailed Description

A simple Clipboard wrapper.

This offers basic access to the clipboard under windows, and serves as a plain global storage for a string on all other platforms. This class is intended to be used internally by Guiliani controls.

The following code demonstrates a basic Copy&Paste implementation which uses the CGUIClipboard class.

eC_Bool CDemoObject::DoKeyDown(const GUIKeyIdentifier_t &eKeyIdentifier, const eC_UInt &uiModifiers)
{
    switch (eKeyIdentifier)
    {
        case GK_PASTE:
        {
            m_pTextObject->SetText(GET_CLIPBOARD.GetString());
        }
        break;
        case GK_COPY:
        {
            GET_CLIPBOARD.PutString(m_pTextObject->GetText());
        }
    }
    return false;
}

Member Function Documentation

ClearClipboard()

void CGUIClipboard::ClearClipboard

(

)

Clear the clipboard.

CreateInstance()

static void CGUIClipboard::CreateInstance ( )

static

Create Instance

DeleteInstance()

static void CGUIClipboard::DeleteInstance ( )

static

Delete Instance

GetString()

eC_String CGUIClipboard::GetString

(

)

const

Retrieves the latest text string from the clipboard.

Returns

String with text from clipboard

PutString()

void CGUIClipboard::PutString

(

const eC_String &

kStr

)

Push the given string onto the clipboard. This will replace any former clipboard contents.

Parameters

kStr	String to copy onto the clipboard

Friends And Related Function Documentation

CGUIComponentManager

friend class CGUIComponentManager

friend

---

The documentation for this class was generated from the following file:

• GUIClipboard.h