<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
<!ENTITY pi "&#960;">
<!ENTITY solidus "&#8260;">
]>
<refentry id="GtkBoolFilter">
<refmeta>
<refentrytitle role="top_of_page" id="GtkBoolFilter.top_of_page">GtkBoolFilter</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkBoolFilter</refname>
<refpurpose>Filtering by boolean expressions</refpurpose>
</refnamediv>

<refsect1 id="GtkBoolFilter.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_proto_type" colwidth="150px"/>
<colspec colname="functions_proto_name"/>
<tbody>
<row><entry role="function_type"><link linkend="GtkBoolFilter"><returnvalue>GtkBoolFilter</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-bool-filter-new">gtk_bool_filter_new</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkExpression"><returnvalue>GtkExpression</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-bool-filter-get-expression">gtk_bool_filter_get_expression</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-bool-filter-set-expression">gtk_bool_filter_set_expression</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-bool-filter-get-invert">gtk_bool_filter_get_invert</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-bool-filter-set-invert">gtk_bool_filter_set_invert</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkBoolFilter.properties" role="properties">
<title role="properties.title">Properties</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="properties_type" colwidth="150px"/>
<colspec colname="properties_name" colwidth="300px"/>
<colspec colname="properties_flags" colwidth="200px"/>
<tbody>
<row><entry role="property_type"><link linkend="GtkExpression"><type>GtkExpression</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkBoolFilter--expression">expression</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="GtkBoolFilter--invert">invert</link></entry><entry role="property_flags">Read / Write</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkBoolFilter.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="other_proto_type" colwidth="150px"/>
<colspec colname="other_proto_name"/>
<tbody>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="GtkBoolFilter-struct">GtkBoolFilter</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkBoolFilter.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GObject">GObject</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GtkFilter">GtkFilter</link>
        <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> GtkBoolFilter
</screen>
</refsect1>

<refsect1 id="GtkBoolFilter.includes"><title>Includes</title><synopsis>#include &lt;gtk/gtk.h&gt;
</synopsis></refsect1>

<refsect1 id="GtkBoolFilter.description" role="desc">
<title role="desc.title">Description</title>
<para>GtkBoolFilter is a simple filter that takes a boolean <link linkend="GtkExpression"><type>GtkExpression</type></link>
to determine whether to include items.</para>

</refsect1>
<refsect1 id="GtkBoolFilter.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-bool-filter-new" role="function">
<title>gtk_bool_filter_new&#160;()</title>
<indexterm zone="gtk-bool-filter-new"><primary>gtk_bool_filter_new</primary></indexterm>
<programlisting language="C"><link linkend="GtkBoolFilter"><returnvalue>GtkBoolFilter</returnvalue></link>&#160;*
gtk_bool_filter_new (<parameter><link linkend="GtkExpression"><type>GtkExpression</type></link> *expression</parameter>);</programlisting>
<para>Creates a new bool filter.</para>
<refsect3 id="gtk-bool-filter-new.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>expression</para></entry>
<entry role="parameter_description"><para>The expression to evaluate
or <link linkend="NULL:CAPS"><literal>NULL</literal></link> for none. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>transfer full</acronym>][<acronym>nullable</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-bool-filter-new.returns" role="returns">
<title>Returns</title>
<para> a new <link linkend="GtkBoolFilter"><type>GtkBoolFilter</type></link></para>
</refsect3></refsect2>
<refsect2 id="gtk-bool-filter-get-expression" role="function">
<title>gtk_bool_filter_get_expression&#160;()</title>
<indexterm zone="gtk-bool-filter-get-expression"><primary>gtk_bool_filter_get_expression</primary></indexterm>
<programlisting language="C"><link linkend="GtkExpression"><returnvalue>GtkExpression</returnvalue></link>&#160;*
gtk_bool_filter_get_expression (<parameter><link linkend="GtkBoolFilter"><type>GtkBoolFilter</type></link> *self</parameter>);</programlisting>
<para>Gets the expression that the filter uses to evaluate if
an item should be filtered.</para>
<refsect3 id="gtk-bool-filter-get-expression.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkBoolFilter"><type>GtkBoolFilter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-bool-filter-get-expression.returns" role="returns">
<title>Returns</title>
<para>a <link linkend="GtkExpression"><type>GtkExpression</type></link>. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-bool-filter-set-expression" role="function">
<title>gtk_bool_filter_set_expression&#160;()</title>
<indexterm zone="gtk-bool-filter-set-expression"><primary>gtk_bool_filter_set_expression</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_bool_filter_set_expression (<parameter><link linkend="GtkBoolFilter"><type>GtkBoolFilter</type></link> *self</parameter>,
                                <parameter><link linkend="GtkExpression"><type>GtkExpression</type></link> *expression</parameter>);</programlisting>
<para>Sets the expression that the filter uses to
check if items should be filtered. The expression must have
a value type of <link linkend="G-TYPE-BOOLEAN:CAPS"><type>G_TYPE_BOOLEAN</type></link>.</para>
<refsect3 id="gtk-bool-filter-set-expression.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkBoolFilter"><type>GtkBoolFilter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>expression</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkExpression"><type>GtkExpression</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-bool-filter-get-invert" role="function">
<title>gtk_bool_filter_get_invert&#160;()</title>
<indexterm zone="gtk-bool-filter-get-invert"><primary>gtk_bool_filter_get_invert</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_bool_filter_get_invert (<parameter><link linkend="GtkBoolFilter"><type>GtkBoolFilter</type></link> *self</parameter>);</programlisting>
<para>Returns whether the filter inverts the expression.</para>
<refsect3 id="gtk-bool-filter-get-invert.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkBoolFilter"><type>GtkBoolFilter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-bool-filter-get-invert.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the filter inverts</para>
</refsect3></refsect2>
<refsect2 id="gtk-bool-filter-set-invert" role="function">
<title>gtk_bool_filter_set_invert&#160;()</title>
<indexterm zone="gtk-bool-filter-set-invert"><primary>gtk_bool_filter_set_invert</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_bool_filter_set_invert (<parameter><link linkend="GtkBoolFilter"><type>GtkBoolFilter</type></link> *self</parameter>,
                            <parameter><link linkend="gboolean"><type>gboolean</type></link> invert</parameter>);</programlisting>
<para>Sets whether the filter should invert the expression.</para>
<refsect3 id="gtk-bool-filter-set-invert.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkBoolFilter"><type>GtkBoolFilter</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>invert</para></entry>
<entry role="parameter_description"><para><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to invert</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>

</refsect1>
<refsect1 id="GtkBoolFilter.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="GtkBoolFilter-struct" role="struct">
<title>GtkBoolFilter</title>
<indexterm zone="GtkBoolFilter-struct"><primary>GtkBoolFilter</primary></indexterm>
<programlisting language="C">typedef struct _GtkBoolFilter GtkBoolFilter;</programlisting>
</refsect2>

</refsect1>
<refsect1 id="GtkBoolFilter.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkBoolFilter--expression" role="property"><title>The <literal>“expression”</literal> property</title>
<indexterm zone="GtkBoolFilter--expression"><primary>GtkBoolFilter:expression</primary></indexterm>
<programlisting>  “expression”               <link linkend="GtkExpression"><type>GtkExpression</type></link>&#160;*</programlisting>
<para>The boolean expression to evaluate on item</para>

<para><emphasis role="annotation">[<acronym>type</acronym> GtkExpression]</emphasis></para><para>Owner: GtkBoolFilter</para>
<para>Flags: Read / Write</para>
</refsect2>
<refsect2 id="GtkBoolFilter--invert" role="property"><title>The <literal>“invert”</literal> property</title>
<indexterm zone="GtkBoolFilter--invert"><primary>GtkBoolFilter:invert</primary></indexterm>
<programlisting>  “invert”                   <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para>If the expression result should be inverted</para>
<para>Owner: GtkBoolFilter</para>
<para>Flags: Read / Write</para>
<para>Default value: FALSE</para>
</refsect2>

</refsect1>

</refentry>
