KRemoteEncoding
#include <KRemoteEncoding>
Public Member Functions | |
KRemoteEncoding (const char *name=nullptr) | |
virtual | ~KRemoteEncoding () |
QString | decode (const QByteArray &name) const |
QByteArray | directory (const QUrl &url, bool ignore_trailing_slash=true) const |
QByteArray | encode (const QString &name) const |
QByteArray | encode (const QUrl &url) const |
const char * | encoding () const |
int | encodingMib () const |
QByteArray | fileName (const QUrl &url) const |
void | setEncoding (const char *name) |
Protected Member Functions | |
virtual void | virtual_hook (int id, void *data) |
Detailed Description
A class for handling remote filenames.
Allows encoding and decoding properly remote filenames into Unicode.
Certain protocols do not specify an appropriate encoding for decoding their 8-bit data into proper Unicode forms. Therefore, KIO workers should use this class in order to convert those forms into QStrings before creating the respective KIO::UDSEntry. The same is true for decoding URLs to its components.
Each KIO::WorkerBase has one object of this kind, even if it is not necessary. It can be accessed through KIO::WorkerBase::remoteEncoding.
Definition at line 36 of file kremoteencoding.h.
Constructor & Destructor Documentation
◆ KRemoteEncoding()
|
explicit |
Constructor.
Constructs this object to use the given encoding name. If name
is a null pointer, the standard encoding will be used.
Definition at line 26 of file kremoteencoding.cpp.
◆ ~KRemoteEncoding()
|
virtualdefault |
Destructor.
Member Function Documentation
◆ decode()
QString KRemoteEncoding::decode | ( | const QByteArray & | name | ) | const |
Converts the given full pathname or filename to Unicode.
This function is supposed to work for dirnames, filenames or a full pathname.
Definition at line 34 of file kremoteencoding.cpp.
◆ directory()
QByteArray KRemoteEncoding::directory | ( | const QUrl & | url, |
bool | ignore_trailing_slash = true |
||
) | const |
Converts the given URL into 8-bit form and separate the dirname from the filename.
This is useful for worker functions like stat or get.
The dirname is returned with the final slash always stripped
Definition at line 67 of file kremoteencoding.cpp.
◆ encode() [1/2]
QByteArray KRemoteEncoding::encode | ( | const QString & | name | ) | const |
Converts the given name from Unicode.
This function is supposed to work for dirnames, filenames or a full pathname.
Definition at line 52 of file kremoteencoding.cpp.
◆ encode() [2/2]
QByteArray KRemoteEncoding::encode | ( | const QUrl & | url | ) | const |
Converts the given URL into its 8-bit components.
Definition at line 62 of file kremoteencoding.cpp.
◆ encoding()
const char * KRemoteEncoding::encoding | ( | ) | const |
Returns the encoding being used.
Definition at line 82 of file kremoteencoding.cpp.
◆ encodingMib()
int KRemoteEncoding::encodingMib | ( | ) | const |
Returns the MIB for the codec being used.
Definition at line 89 of file kremoteencoding.cpp.
◆ fileName()
QByteArray KRemoteEncoding::fileName | ( | const QUrl & | url | ) | const |
Converts the given URL into 8-bit form and retrieve the filename.
Definition at line 77 of file kremoteencoding.cpp.
◆ setEncoding()
void KRemoteEncoding::setEncoding | ( | const char * | name | ) |
Sets the encoding being used.
This function does not change the global configuration.
Pass a null pointer in name
to revert to the standard encoding.
Definition at line 94 of file kremoteencoding.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Nov 28 2023 03:55:15 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.