Fix a typo in xas.1 (thanks to Marcell)
[amule.git] / src / DataToText.h
blob1f391440623b970b39380b3cca6c4e9b4692af66
1 //
2 // This file is part of the aMule Project.
3 //
4 // Copyright (c) 2003-2011 aMule Team ( admin@amule.org / http://www.amule.org )
5 //
6 // Any parts of this program derived from the xMule, lMule or eMule project,
7 // or contributed by third-party developers are copyrighted by their
8 // respective authors.
9 //
10 // This program is free software; you can redistribute it and/or modify
11 // it under the terms of the GNU General Public License as published by
12 // the Free Software Foundation; either version 2 of the License, or
13 // (at your option) any later version.
15 // This program is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 // GNU General Public License for more details.
20 // You should have received a copy of the GNU General Public License
21 // along with this program; if not, write to the Free Software
22 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
25 #ifndef DATATOTEXT_H
26 #define DATATOTEXT_H
28 class wxString;
30 // Returns the textual representation of a priority value
31 wxString PriorityToStr( int priority, bool isAuto );
33 // Returns the textual representation of download states
34 wxString DownloadStateToStr( int state, bool queueFull );
36 /**
37 * @return Human-readable client software name.
39 const wxString GetSoftName( unsigned int software_ident );
41 /**
42 * Get "Source From" text, i.e. where we got the source from.
44 * @param source_from A ESourceFrom enum value.
45 * @return Human-readable text for the ESourceFrom enum values.
47 wxString OriginToText(unsigned int source_from);
49 /**
50 * @return The textual representation of a partfile conversion state.
52 wxString GetConversionState(unsigned int state);
54 #endif /* DATATOTEXT_H */
55 // File_checked_for_headers