ManaTools::Rpmdragora::gui

Section: User Contributed Perl Documentation (3)
Updated: 2017-07-06
Page Index
 

format_link

INPUT

    $description: Description to be shown as link
    $url: to be reach when click on $description link

OUTPUT

    $webref: href HTML tag

DESCRIPTION

    This function returns an href string to be published

 

node_state(pkgname)

returns the state of the node (pkg) querying an urpm object from $pkgs->{$pkgname}
to_install
to_remove
to_update
installed
uninstalled
 

set_node_state($tblItem, $state, $detail_list)

setup the table row by adding a cell representing the state of the package
see node_state
$tblItem , YTableItem instance
$state , string containing the state of the package from node_state
$detail_list , reference to the YCBTable
 

grep_unselected

INPUT

    $l: ARRAY reference containing the list of package fullnames

OUTPUT

    \@result: ARRAY reference containing the list of packages
             that are not selected

DESCRIPTION

    Function returning the list of not selected packages

 

add_parent($tree, $root, $state)

populates the treeview with the rpm package groups
$tree , YTree for the group of the rpm packages
$root , string containing a path-like sequence (e.g. "foo|bar")
$state , not used currently (from the old impl.)
 

add_tree_item

INPUT
$tree YTree for the group of the rpm packages
$item string containing a group (to be added as leaf node)
$selected if the new item is selected

DESCRIPTION

    This function add a group to the tree view

 

add_package_item

INPUT
$item_list: reference to a YItemCollection
$pkg_name: package name
$select: select given package
$skip_other_arch: true if other archs have to be skipped

OUTPUT return 1 if item is added 0 otherwise

DESCRIPTION

    populates the item list for the table view with the given rpm package

 

add_node($leaf, $root, $options)

populates the tableview with the rpm packages or the treeview with the package groups
$leaf , could be the name of a package or the name of a group o packages
$root , string containing a path-like sequence (e.g. "foo|bar")
$state , the string with the state of the package if leaf is the name of a package
 

treeview_children

INPUT

    $tbl: YCBTable widget containing the package list shown

OUTPUT

    \@l: ARRAY reference containing the list
        of YItem contained into YCBTable

DESCRIPTION

    This functions just returns the YCBTable content such as all the
    YItem objects

 

children

INPUT

    $tbl: YCBTable object
    @table_item_list: array containing package fullnames

OUTPUT

    \@result: ARRAY reference containing package fullnames

DESCRIPTION

    This Function return the list of package fullnames

 

toggle_all

INPUT

    $common: HASH reference containing (### TODO ###)
            widgets => {
                detail_list: YTable reference (?)
            }
            table_item_list  => array containing package fullnames
            partialsel_unsel => (?)

            set_state_callback => set state callback invoked by
                                  toggle_nodes if needed. if undef
                                  set_leaf_state is used.
    $_val: value to be set (so it seems not a toggle! unused?)

DESCRIPTION

This method (should) check -or un-check if already checked- all the packages  

info_details

INPUT

    $info_detail_selected: string to get more info details
                           (see %hidden_info)
    $info_options:         reference to info options that are going to changed
                           based on passed $info_detail_selected

OUTPUT

    [0, 1]: 0 if $info_detail_selected not valid, 1 otherwise

DESCRIPTION

    This function change the info_options accordingly to the string passed
    returning 0 if the string is not managed (see %hidden_info)

 

setInfoOnWidget

INPUT

    $pckgname: full name of the package
    $infoWidget: YRichText object to fill

DESCRIPTION

    This function writes on a YRichText object package info

 

get_info

INPUT

    $key: package full name
    $options: HASH reference containing:
                details   => show details
                changelog => show changelog
                files     => show files
                new_deps  => show new dependencies

DESCRIPTION

    return a string with all the package info

 

run_browser

INPUT

    $url: url to be passed to the configured browser

DESCRIPTION

    This function calls the browser with the given URL

 

group_path_name

INPUT

    $treeItem: YTreeItem object

OUTPUT

    $fullname: completed path group name

DESCRIPTION

    This function returns the path name treeItem group name (e.g. foo|bar)

 

POD ERRORS

Hey! The above document had some coding errors, which are explained below:
Around line 632:
'=item' outside of any '=over'
Around line 639:
You forgot a '=back' before '=head3'
Around line 666:
'=item' outside of any '=over'
Around line 674:
You forgot a '=back' before '=head3'


 

Index

format_link
node_state(pkgname)
set_node_state($tblItem, $state, $detail_list)
grep_unselected
add_parent($tree, $root, $state)
add_tree_item
add_package_item
add_node($leaf, $root, $options)
treeview_children
children
toggle_all
info_details
setInfoOnWidget
get_info
run_browser
group_path_name
POD ERRORS
LinuxReviews : manual page archive : man3pm