GCab.Folder

g GCab.Folder GCab.Folder GObject.Object GObject.Object GObject.Object->GCab.Folder

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

class

new (comptype)

add_file (cabfile, recurse, cancellable)

get_comptype ()

get_file_by_name (name)

get_files ()

get_nfiles ()

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Name

Type

Flags

Short Description

compression

GCab.Compression

r

compression

comptype

int

r/w/co

comptype

reserved

GLib.ByteArray

r/w

Reserved

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class GCab.Folder(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

GCab.FolderClass

An opaque object, referencing a folder in a Cabinet.

classmethod new(comptype)
Parameters:

comptype (int) – compression to used in this folder

Returns:

a new GCab.Folder

Return type:

GCab.Folder

Creates a new empty Cabinet folder. Use GCab.Folder.add_file() to add files to an archive.

A Cabinet folder is not a file path, it is a container for files.

add_file(cabfile, recurse, cancellable)
Parameters:
Raises:

GLib.Error

Returns:

True on succes

Return type:

bool

Add file to the GCab.Folder.

get_comptype()
Returns:

a GCab.Compression, e.g. GCab.Compression.MSZIP

Return type:

int

Returns the compression used in this folder.

New in version 1.0.

get_file_by_name(name)
Parameters:

name (str) – a file name

Returns:

A GCab.File, or None if not found

Return type:

GCab.File

Gets a specific GCab.File files contained in the self.

get_files()
Returns:

list of files

Return type:

[GCab.File]

Get the list of GCab.File files contained in the self.

get_nfiles()
Returns:

a int

Return type:

int

Get the number of files in this folder.

Property Details

GCab.Folder.props.compression
Name:

compression

Type:

GCab.Compression

Default Value:

GCab.Compression.NONE

Flags:

READABLE

compression

GCab.Folder.props.comptype
Name:

comptype

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

comptype

GCab.Folder.props.reserved
Name:

reserved

Type:

GLib.ByteArray

Default Value:

None

Flags:

READABLE, WRITABLE

Reserved