Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/util/Clipboard.h @ 10497

Last change on this file since 10497 was 7401, checked in by landauf, 14 years ago

merged doc branch back to trunk

  • Property svn:eol-style set to native
File size: 1.7 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file
31    @ingroup Util Command
32    @brief Some functions to exchange text between the OS clipboard and the Shell in Orxonox.
33
34    Use fromClipboard() to get text from the clipboard (if there is any text) and
35    toClipboard() to put text into the clipboard.
36
37    These functions can only work properly if there's an OS-specific implementation
38    in Clipboard.cc. If a specific OS is not supported, the clipboard only works
39    within Orxonox, but the exchange with other programs is not possible.
40*/
41
42#ifndef _Clipboard_H__
43#define _Clipboard_H__
44
45#include "UtilPrereqs.h"
46#include <string>
47
48namespace orxonox
49{
50    _UtilExport bool toClipboard(const std::string& text);
51    _UtilExport std::string fromClipboard();
52}
53
54#endif /* _Clipboard_H__ */
55
Note: See TracBrowser for help on using the repository browser.