haiku-website/static/legacy-docs/bebook/BRefFilter_Overview.html

30 lines
5.9 KiB
HTML
Raw Permalink Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>The Be Book - System Overview - The Storage Kit</title><link rel="stylesheet" href="be_book.css" type="text/css" media="all" /><link rel="shortcut icon" type="image/vnd.microsoft.icon" href="./images/favicon.ico" /><!--[if IE]>
<link rel="stylesheet" type="text/css" href="be_book_ie.css" />
<![endif]--><meta name="generator" content="DocBook XSL Stylesheets V1.73.2" /><meta name="keywords" content="Access, BeOS, BeBook, API" /><link rel="start" href="index.html" title="The Be Book" /><link rel="up" href="TheStorageKit_Overview.html" title="The Storage Kit" /><link rel="prev" href="BQuery_Overview.html" title="BQuery" /><link rel="next" href="BResources_Overview.html" title="BResources" /></head><body><div id="header"><div id="headerT"><div id="headerTL"><a accesskey="p" href="BQuery_Overview.html" title="BQuery"><img src="./images/navigation/prev.png" alt="Prev" /></a> <a accesskey="u" href="TheStorageKit_Overview.html" title="The Storage Kit"><img src="./images/navigation/up.png" alt="Up" /></a> <a accesskey="n" href="BResources_Overview.html" title="BResources"><img src="./images/navigation/next.png" alt="Next" /></a></div><div id="headerTR"><div id="navigpeople"><a href="http://www.haiku-os.org"><img src="./images/People_24.png" alt="haiku-os.org" title="Visit The Haiku Website" /></a></div><div class="navighome" title="Home"><a accesskey="h" href="index.html"><img src="./images/navigation/home.png" alt="Home" /></a></div><div class="navigboxed" id="navigindex"><a accesskey="i" href="ClassIndex.html" title="Index">I</a></div><div class="navigboxed" id="naviglang" title="English">en</div></div><div id="headerTC">The Be Book - System Overview - The Storage Kit</div></div><div id="headerB">Prev: <a href="BQuery_Overview.html">BQuery</a>  Up: <a href="TheStorageKit_Overview.html">The Storage Kit</a>  Next: <a href="BResources_Overview.html">BResources</a></div><hr /></div><div class="section"><div xmlns="" xmlns:d="http://docbook.org/ns/docbook" class="titlepage"><div><div xmlns:d="http://docbook.org/ns/docbook"><h2 xmlns="http://www.w3.org/1999/xhtml" class="title"><a id="BRefFilter_Overview"></a>BRefFilter</h2></div></div></div><a id="id613287" class="indexterm"></a><p>
The <code class="classname">BRefFilter</code> class lets you filter the items that a file panel is about
to display. This filtering is performed by the class' only function,
<a class="link" href="BRefFilter.html#BRefFilter_Filter" title="Filter()"><code class="methodname">Filter()</code></a>.
<a class="link" href="BRefFilter.html#BRefFilter_Filter" title="Filter()"><code class="methodname">Filter()</code></a>
is a hook function; to use a <code class="classname">BRefFilter</code>, you have to
create a derived class and implement the
<a class="link" href="BRefFilter.html#BRefFilter_Filter" title="Filter()"><code class="methodname">Filter()</code></a> function.
</p><p>
To assign your <code class="classname">BRefFilter</code> object to a file panel, you invoke
<a class="link" href="BFilePanel.html" title="BFilePanel"><code class="classname">BFilePanel</code></a>'s
<a class="link" href="BFilePanel.html#BFilePanel_SetRefFilter" title="SetRefFilter(), RefFilter()"><code class="methodname">SetRefFilter()</code></a>
function. (The <a class="link" href="BFilePanel.html" title="BFilePanel"><code class="classname">BFilePanel</code></a>
constructor also lets you set
the filter.) If you don't specifically assign a filter, the file panel
will not have one—there is no "default" ref filter object. You
maintain ownership of the <code class="classname">BRefFilter</code> that you assign to a file panel; the
file panel doesn't delete or otherwise change your object.
</p><p>
You can assign the same filter to more than file panel. However, the
<a class="link" href="BRefFilter.html#BRefFilter_Filter" title="Filter()"><code class="methodname">Filter()</code></a>
function isn't told which panel it's being invoked for.
</p></div><div id="footer"><hr /><div id="footerT">Prev: <a href="BQuery_Overview.html">BQuery</a>  Up: <a href="TheStorageKit_Overview.html">The Storage Kit</a>  Next: <a href="BResources_Overview.html">BResources</a> </div><div id="footerB"><div id="footerBL"><a href="BQuery_Overview.html" title="BQuery"><img src="./images/navigation/prev.png" alt="Prev" /></a> <a href="TheStorageKit_Overview.html" title="The Storage Kit"><img src="./images/navigation/up.png" alt="Up" /></a> <a href="BResources_Overview.html" title="BResources"><img src="./images/navigation/next.png" alt="Next" /></a></div><div id="footerBR"><div><a href="http://www.haiku-os.org"><img src="./images/People_24.png" alt="haiku-os.org" title="Visit The Haiku Website" /></a></div><div class="navighome" title="Home"><a accesskey="h" href="index.html"><img src="./images/navigation/home.png" alt="Home" /></a></div></div><div id="footerBC"><a href="http://www.access-company.com/home.html" title="ACCESS Co."><img alt="Access Company" src="./images/access_logo.png" /></a></div></div></div><div id="licenseFooter"><div id="licenseFooterBL"><a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/3.0/" title="Creative Commons License"><img alt="Creative Commons License" style="border-width:0" src="https://licensebuttons.net/l/by-nc-nd/3.0/88x31.png" /></a></div><div id="licenseFooterBR"><a href="./LegalNotice.html">Legal Notice</a></div><div id="licenseFooterBC"><span id="licenseText">This work is licensed under a
<a rel="license" href="http://creativecommons.org/licenses/by-nc-nd/3.0/">Creative
Commons Attribution-Non commercial-No Derivative Works 3.0 License</a>.</span></div></div></body></html>