Documentation | StorageKit | RefFilter

NAME

RefFilter

VERSION

0.01

SYNOPSIS

use HaikuR1::RefFilter;

# define MyFilter subclass here

my $filter = MyFilter->new();
$panel->SetRefFilter($filter);

from HaikuR1.StorageKit import RefFilter

# define MyFilter subclass here

filter = MyFitler()
panel.SetRefFilter(filter)

DESCRIPTION

Exposes the BRefFilter object.

For more information on RefFilter, see the Be Book class description, the Be Book overview, and the Haiku Book class description.

METHODS

Constructor

Creates a RefFilter.

HaikuR1::RefFilter->new();

RefFilter()

EVENTS

Filter

When a directory is opened in a FilePanel, or when FilePanel.Refresh is called, this method is called once for each entry in the directory. Return true to include the entry, false to skip it.

$filter->Filter($ref, $node, $stat, $type);

filter.Filter(ref, node, stat, type)

• ref

  A string, the full path name of the entry.

• node

  A Node pointed at the entry.

• stat

  A native map with the following fields:

  • st_dev - device id
  • st_ino - inode number
  • st_mode - type and mode (as a single integer)
  • st_nlink - number of hard links
  • st_uid - owner id
  • st_gid - group id
  • st_size - size in bytes
  • st_rdev - unused (provided for System V compatibility)
  • st_blksize - block size (on entry's FS)
  • st_atim - last accessed time
  • st_mtim - last modified time (contents only)
  • st_ctim - last changed time (contents or permissions)
  • st_crtim - creation time

• type

  A string, the MIME type of the entry.