view release on metacpan or  search on metacpan

README  view on Meta::CPAN

NAME
    Desktop::Workspace::Util - Utilities related to DesktopWorkspace

VERSION
    This document describes version 0.004 of Desktop::Workspace::Util (from
    Perl distribution Desktop-Workspace-Util), released on 2026-05-04.

SYNOPSIS
DESCRIPTION
FUNCTIONS
  get_desktop_workspace_module
    Usage:

     get_desktop_workspace_module(%args) -> any

    Get the first Perl desktop workspace specification module.

    This function is not exported by default, but exportable.

    Arguments ('*' denotes required arguments):

    *   module* => *perl::modname*

        (No description)

    *   ns_prefixes => *array[perl::modname|str]* (default:
        ["DesktopWorkspace",""])

        List of namespaces to search for a Desktop Workspace specification
        modules.

    Return value: (any)

  instantiate_desktop_workspace_module
    Usage:

     instantiate_desktop_workspace_module(%args) -> any

    Instantiate the desktop workspace specification module (class).

    This function is not exported by default, but exportable.

    Arguments ('*' denotes required arguments):

    *   module* => *perl::modname*

        (No description)

    *   module_args => *hash*

        (No description)

    *   ns_prefixes => *array[perl::modname|str]* (default:
        ["DesktopWorkspace",""])

        List of namespaces to search for a Desktop Workspace specification
        modules.

    Return value: (any)

  list_desktop_workspace_items
    Usage:

     list_desktop_workspace_items(%args) -> [$status_code, $reason, $payload, \%result_meta]

    List the items from desktop workspace specification module, with
    filtering options.

    This function is not exported by default, but exportable.

    Arguments ('*' denotes required arguments):

    *   all => *bool*

        Whether to include items that are not included by default (has
        property `include_by_default`=0).

    *   detail => *bool*

        (No description)

    *   exclude_all_tags => *array[str]*

        Exclude all items that have ALL tags specified.

    *   exclude_any_tags => *array[str]*

        Exclude all items that have any tags specified.

    *   include_all_tags => *array[str]*

        Include all items that have ALL tags specified.

    *   include_any_tags => *array[str]*

        Include all items that have any tag specified.

    *   include_dir => *bool*

        Whether to include dir items.

    *   include_file => *bool*

        Whether to include file items.

    *   include_prog => *bool*

        Whether to include program items.

    *   include_url => *bool*

        Whether to include URL items.

    *   module* => *perl::modname*

        (No description)

    *   module_args => *hash*

        (No description)

    *   ns_prefixes => *array[perl::modname|str]* (default:
        ["DesktopWorkspace",""])

        List of namespaces to search for a Desktop Workspace specification
        modules.

    *   query => *array[str]*

        (No description)

    *   shuffle => *bool*

        (No description)

    Returns an enveloped result (an array).

    First element ($status_code) is an integer containing HTTP-like status
    code (200 means OK, 4xx caller error, 5xx function error). Second
    element ($reason) is a string containing error message, or something
    like "OK" if status is 200. Third element ($payload) is the actual
    result, but usually not present when enveloped result is an error
    response ($status_code is not 2xx). Fourth element (%result_meta) is
    called result metadata and is optional, a hash that contains extra
    information, much like how HTTP response headers provide additional
    metadata.

    Return value: (any)

  open_desktop_workspace_items
    Usage:

     open_desktop_workspace_items(%args) -> [$status_code, $reason, $payload, \%result_meta]

    Open desktop workspace items.

    This function is not exported by default, but exportable.

    This function supports dry-run operation.

    Arguments ('*' denotes required arguments):

    *   all => *bool*

        Whether to include items that are not included by default (has
        property `include_by_default`=0).

    *   detail => *bool*

        (No description)

    *   exclude_all_tags => *array[str]*

        Exclude all items that have ALL tags specified.

    *   exclude_any_tags => *array[str]*

        Exclude all items that have any tags specified.

    *   include_all_tags => *array[str]*

        Include all items that have ALL tags specified.

    *   include_any_tags => *array[str]*

        Include all items that have any tag specified.

    *   include_dir => *bool*

        Whether to include dir items.

    *   include_file => *bool*

        Whether to include file items.

    *   include_prog => *bool*

        Whether to include program items.

    *   include_url => *bool*

        Whether to include URL items.

    *   kde_activity => *str*

        Switch to the specified KDE activity name.

        Override's desktop workspace specification's "kde_activity"
        property.

    *   module* => *perl::modname*

        (No description)

    *   module_args => *hash*

        (No description)

    *   ns_prefixes => *array[perl::modname|str]* (default:
        ["DesktopWorkspace",""])

        List of namespaces to search for a Desktop Workspace specification
        modules.

    *   query => *array[str]*

        (No description)

    *   reuse_window => *bool*

        Do not open if existing window is detected.

    *   shuffle => *bool*

        (No description)

    Special arguments:

    *   -dry_run => *bool*

        Pass -dry_run=>1 to enable simulation mode.

    Returns an enveloped result (an array).

    First element ($status_code) is an integer containing HTTP-like status
    code (200 means OK, 4xx caller error, 5xx function error). Second
    element ($reason) is a string containing error message, or something
    like "OK" if status is 200. Third element ($payload) is the actual
    result, but usually not present when enveloped result is an error
    response ($status_code is not 2xx). Fourth element (%result_meta) is
    called result metadata and is optional, a hash that contains extra
    information, much like how HTTP response headers provide additional
    metadata.

    Return value: (any)

HOMEPAGE
    Please visit the project's homepage at
    <https://metacpan.org/release/Desktop-Workspace-Util>.

SOURCE
    Source repository is at
    <https://github.com/perlancar/perl-Desktop-Workspace-Util>.

SEE ALSO
    DesktopWorkspace

AUTHOR