KFilterBase Class Reference
from PyKDE5.karchive import *
Detailed Description
This is the base class for compression filters
such as gzip and bzip2. It's pretty much internal.
Don't use directly, use KFilterDev instead.
- Internal:
-
Enumerations |
FilterFlags | { NoHeaders, WithHeaders, ZlibHeaders } |
Result | { Ok, End, Error } |
Methods |
| __init__ (self) |
KFilterBase::Result | compress (self, bool finish) |
QIODevice | device (self) |
KFilterBase::FilterFlags | filterFlags (self) |
int | inBufferAvailable (self) |
bool | inBufferEmpty (self) |
bool | init (self, int mode) |
int | mode (self) |
int | outBufferAvailable (self) |
bool | outBufferFull (self) |
bool | readHeader (self) |
| reset (self) |
| setDevice (self, QIODevice dev, bool autodelete=0) |
| setFilterFlags (self, KFilterBase::FilterFlags flags) |
| setInBuffer (self, QString data, long size) |
| setOutBuffer (self, QString data, long maxlen) |
bool | terminate (self) |
KFilterBase::Result | uncompress (self) |
| virtual_hook (self, int id, void data) |
bool | writeHeader (self, QByteArray filename) |
Method Documentation
KFilterBase::Result compress |
( |
self, |
|
|
|
bool |
finish |
|
) |
|
|
|
- Abstract method:
- This method is abstract and can be overridden but not called directly.
- Internal:
-
QIODevice device |
( |
|
self ) |
|
Returns the device on which the filter will work.
- Returns:
- the device on which the filter will work
KFilterBase::FilterFlags filterFlags |
( |
|
self ) |
|
int inBufferAvailable |
( |
|
self ) |
|
- Abstract method:
- This method is abstract and can be overridden but not called directly.
- Internal:
-
bool inBufferEmpty |
( |
|
self ) |
|
bool init |
( |
self, |
|
|
|
int |
mode |
|
) |
|
|
|
- Abstract method:
- This method is abstract and can be overridden but not called directly.
- Internal:
-
- Abstract method:
- This method is abstract and can be overridden but not called directly.
- Internal:
-
int outBufferAvailable |
( |
|
self ) |
|
- Abstract method:
- This method is abstract and can be overridden but not called directly.
- Internal:
-
bool outBufferFull |
( |
|
self ) |
|
- Abstract method:
- This method is abstract and can be overridden but not called directly.
- Internal:
-
setDevice |
( |
self, |
|
|
|
QIODevice |
dev, |
|
|
bool |
autodelete=0 |
|
) |
|
|
|
Sets the device on which the filter will work
- Parameters:
-
| dev | the device on which the filter will work
|
| autodelete | if true, dev is deleted when the filter is deleted
|
setFilterFlags |
( |
self, |
|
|
|
KFilterBase::FilterFlags |
flags |
|
) |
|
|
|
setInBuffer |
( |
self, |
|
|
|
QString |
data, |
|
|
long |
size |
|
) |
|
|
|
- Abstract method:
- This method is abstract and can be overridden but not called directly.
- Internal:
-
setOutBuffer |
( |
self, |
|
|
|
QString |
data, |
|
|
long |
maxlen |
|
) |
|
|
|
- Abstract method:
- This method is abstract and can be overridden but not called directly.
- Internal:
-
KFilterBase::Result uncompress |
( |
|
self ) |
|
- Abstract method:
- This method is abstract and can be overridden but not called directly.
- Internal:
-
virtual_hook |
( |
self, |
|
|
|
int |
id, |
|
|
void |
data |
|
) |
|
|
|
Virtual hook, used to add new "virtual" functions while maintaining
binary compatibility. Unused in this class.
bool writeHeader |
( |
self, |
|
|
|
QByteArray |
filename |
|
) |
|
|
|
- Abstract method:
- This method is abstract and can be overridden but not called directly.
- Internal:
-
Enumeration Documentation
- Internal:
-
- Since:
- 4.3
- Enumerator:
-
NoHeaders = 0 | |
WithHeaders = 1 | |
ZlibHeaders = 2 | |