Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/pickups2/src/util/Clipboard.h @ 2152

Last change on this file since 2152 was 1791, checked in by landauf, 16 years ago

added comments to all my classes in util

  • Property svn:eol-style set to native
File size: 1.6 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 Clipboard.h
31    @brief Some functions to exchange text between the OS clipboard and Orxonox.
32
33    Use fromClipboard() to get text from the clipboard (if there is any text) and
34    toClipboard(text) to put text into the clipboard.
35
36    Those functions can only work properly if there's an OS-specific implementation.
37    If an OS isn't supported, the clipboard only works within Orxonox, but exchange
38    with other programs isn't possible.
39*/
40
41#ifndef _Clipboard_H__
42#define _Clipboard_H__
43
44#include "UtilPrereqs.h"
45
46#include <string>
47
48
49_UtilExport bool toClipboard(const std::string& text);
50_UtilExport std::string fromClipboard();
51
52
53#endif /* _Clipboard_H__ */
54
Note: See TracBrowser for help on using the repository browser.