ooodev.adapter.deployment.package_type_info_partial module

class ooodev.adapter.deployment.package_type_info_partial.PackageTypeInfoPartial(component, interface=com.sun.star.deployment.XPackageTypeInfo)[source]

Bases: object

Partial class for XPackageTypeInfo.

Parameters:
  • component (XPackageTypeInfo) –

  • interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.deployment.XPackageTypeInfo)[source]

Constructor.

Parameters:
  • component (XPackageTypeInfo) – UNO component implementing the com.sun.star.deployment.XPackageTypeInfo interface.

  • interface (UnoInterface, optional) – Interface to validate against. Defaults to XPackageTypeInfo.

Return type:

None

get_description()[source]

Returns a description string to describe a package type.

Raises:

ExtensionRemovedException – If the extension has been removed.

Return type:

str

get_file_filter()[source]

Returns a file filter string for the file picker user interface.

Both the short description string and file filter string will be passed to com.sun.star.ui.dialogs.XFilterManager.appendFilter().

Return type:

str

get_icon(high_contrast, small_icon)[source]

Returns an icon for a package.

Parameters:
  • high_contrast (bool) – Whether to use a high-contrast icon.

  • small_icon (bool) – Whether to use a small icon.

Returns:

The icon representation.

Return type:

Any

get_media_type()[source]

Returns the media type of a package, e.g., ‘application/vnd.sun.star.basic-script’.

Returns:

The media type of the package.

Return type:

str

get_short_description()[source]

Returns a short description string to describe a package type (one line only).

Returns:

The short description of the package type.

Return type:

str