The Battle for Wesnoth  1.19.2+dev
clipboard.hpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2003 - 2024
3  by David White <dave@whitevine.net>
4  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY.
12 
13  See the COPYING file for more details.
14 */
15 
16 #pragma once
17 
18 #include <string>
19 
20 union SDL_Event;
21 
22 namespace desktop {
23 
24 namespace clipboard {
25 
26 /**
27  * Copies text to the clipboard.
28  *
29  * @param text The text to copy.
30  * @param mouse Is the selection done by the mouse? On UNIX systems there
31  * are multiple clipboards and the mouse selection uses a
32  * different clipboard. Ignored on other systems.
33  */
34 void copy_to_clipboard(const std::string& text, const bool mouse);
35 
36 /**
37  * Copies text from the clipboard.
38  *
39  * @param mouse Is the pasting done by the mouse?
40  *
41  * @returns String on clipbaord.
42  */
43 std::string copy_from_clipboard(const bool mouse);
44 
45 void handle_system_event(const SDL_Event& ev);
46 
47 /**
48  * Whether wesnoth was compiled with support for a clipboard.
49  */
50 bool available();
51 
52 } // end namespace clipboard
53 
54 } // end namespace desktop
std::string copy_from_clipboard(const bool)
Copies text from the clipboard.
Definition: clipboard.cpp:37
void copy_to_clipboard(const std::string &text, const bool)
Copies text to the clipboard.
Definition: clipboard.cpp:32
void handle_system_event(const SDL_Event &)
Definition: clipboard.cpp:49
bool available()
Whether wesnoth was compiled with support for a clipboard.
Definition: clipboard.cpp:53