Documentation de SFML 2.6.0

Attention: cette page se réfère à une ancienne version de SFML. Cliquez ici pour passer à la dernière version.
Loading...
Searching...
No Matches
sf::Clipboard Class Reference

Give access to the system clipboard. More...

#include <SFML/Window/Clipboard.hpp>

Static Public Member Functions

static String getString ()
 Get the content of the clipboard as string data.
 
static void setString (const String &text)
 Set the content of the clipboard as string data.
 

Detailed Description

Give access to the system clipboard.

sf::Clipboard provides an interface for getting and setting the contents of the system clipboard.

It is important to note that due to limitations on some operating systems, setting the clipboard contents is only guaranteed to work if there is currently an open window for which events are being handled.

Usage example:

// get the clipboard content as a string
// or use it in the event loop
sf::Event event;
while(window.pollEvent(event))
{
if(event.type == sf::Event::Closed)
window.close();
{
// Using Ctrl + V to paste a string into SFML
if(event.key.control && event.key.code == sf::Keyboard::V)
// Using Ctrl + C to copy a string out of SFML
if(event.key.control && event.key.code == sf::Keyboard::C)
sf::Clipboard::setString("Hello World!");
}
}
static void setString(const String &text)
Set the content of the clipboard as string data.
static String getString()
Get the content of the clipboard as string data.
Defines a system event and its parameters.
Definition: Event.hpp:45
KeyEvent key
Key event parameters (Event::KeyPressed, Event::KeyReleased)
Definition: Event.hpp:225
EventType type
Type of the event.
Definition: Event.hpp:220
@ Closed
The window requested to be closed (no data)
Definition: Event.hpp:190
@ KeyPressed
A key was pressed (data in event.key)
Definition: Event.hpp:195
@ C
The C key.
Definition: Keyboard.hpp:59
@ V
The V key.
Definition: Keyboard.hpp:78
Utility string class that automatically handles conversions between types and encodings.
Definition: String.hpp:46
Keyboard::Key code
Code of the key that has been pressed.
Definition: Event.hpp:64
bool control
Is the Control key pressed?
Definition: Event.hpp:67
See also
sf::String, sf::Event

Definition at line 41 of file Clipboard.hpp.

Member Function Documentation

◆ getString()

static String sf::Clipboard::getString ( )
static

Get the content of the clipboard as string data.

This function returns the content of the clipboard as a string. If the clipboard does not contain string it returns an empty sf::String object.

Returns
Clipboard contents as sf::String object

◆ setString()

static void sf::Clipboard::setString ( const String text)
static

Set the content of the clipboard as string data.

This function sets the content of the clipboard as a string.

Warning
Due to limitations on some operating systems, setting the clipboard contents is only guaranteed to work if there is currently an open window for which events are being handled.
Parameters
textsf::String containing the data to be sent to the clipboard

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