<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="cutter-Assertion-Utilities-for-GObject">
<refmeta>
<refentrytitle role="top_of_page" id="cutter-Assertion-Utilities-for-GObject.top_of_page">Assertion Utilities for GObject</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
  CUTTER Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>Assertion Utilities for GObject</refname>
<refpurpose>Utilities to write assertions related
to <link linkend="GObject"><type>GObject</type></link> more easily.</refpurpose>
</refnamediv>

<refsect1 id="cutter-Assertion-Utilities-for-GObject.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_return" colwidth="150px"/>
<colspec colname="functions_name"/>
<tbody>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gcut-object-equal">gcut_object_equal</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gcut-object-inspect">gcut_object_inspect</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gcut-object-inspect-custom">gcut_object_inspect_custom</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="cutter-Assertion-Utilities-for-GObject.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>
</screen>
</refsect1>


<refsect1 id="cutter-Assertion-Utilities-for-GObject.description" role="desc">
<title role="desc.title">Description</title>
<para>To write assertions, you need to check equality and show
expected and actual values.</para>
<para>The utilities help you to write assertions that are
related to <link linkend="GObject"><type>GObject</type></link>.</para>

</refsect1>
<refsect1 id="cutter-Assertion-Utilities-for-GObject.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gcut-object-equal" role="function" condition="since:1.0.5">
<title>gcut_object_equal&#160;()</title>
<indexterm zone="gcut-object-equal" role="1.0.5"><primary>gcut_object_equal</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gcut_object_equal (<parameter>const <link linkend="GObject"><type>GObject</type></link> *object1</parameter>,
                   <parameter>const <link linkend="GObject"><type>GObject</type></link> *object2</parameter>,
                   <parameter><link linkend="GEqualFunc"><type>GEqualFunc</type></link> equal_func</parameter>);</programlisting>
<para>Compares two <link linkend="GObject"><type>GObject</type></link>, <parameter>object1</parameter>
 and <parameter>object2</parameter>
 by
<parameter>equal_func</parameter>
. If <parameter>equal_func</parameter>
 is NULL, <parameter>object1</parameter>
 and
<parameter>object2</parameter>
 is just only compared by memory location.</para>
<refsect3 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>object1</para></entry>
<entry role="parameter_description"><para>a <link linkend="GObject"><type>GObject</type></link> to be compared.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>object2</para></entry>
<entry role="parameter_description"><para>a <link linkend="GObject"><type>GObject</type></link> to be compared.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>equal_func</para></entry>
<entry role="parameter_description"><para>a function that compares two <link linkend="GObject"><type>GObject</type></link>. NULL
is OK.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> TRUE if <parameter>object1</parameter>
== <parameter>object2</parameter>
or
<parameter>equal_func</parameter>
(<parameter>object1</parameter>
, <parameter>object2</parameter>
), FALSE otherwise.</para>
<para></para>
</refsect3><para role="since">Since 1.0.5</para></refsect2>
<refsect2 id="gcut-object-inspect" role="function" condition="since:1.0.5">
<title>gcut_object_inspect&#160;()</title>
<indexterm zone="gcut-object-inspect" role="1.0.5"><primary>gcut_object_inspect</primary></indexterm>
<programlisting language="C"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gcut_object_inspect (<parameter>const <link linkend="GObject"><type>GObject</type></link> *object</parameter>);</programlisting>
<para>Inspects <parameter>object</parameter>
's property. The returned string should
be freed when no longer needed.</para>
<refsect3 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>object</para></entry>
<entry role="parameter_description"><para>a <link linkend="GObject"><type>GObject</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> inspected <parameter>object</parameter>
as a string.</para>
<para></para>
</refsect3><para role="since">Since 1.0.5</para></refsect2>
<refsect2 id="gcut-object-inspect-custom" role="function" condition="since:1.0.5">
<title>gcut_object_inspect_custom&#160;()</title>
<indexterm zone="gcut-object-inspect-custom" role="1.0.5"><primary>gcut_object_inspect_custom</primary></indexterm>
<programlisting language="C"><link linkend="gchar"><returnvalue>gchar</returnvalue></link>&#160;*
gcut_object_inspect_custom (<parameter>const <link linkend="GObject"><type>GObject</type></link> *object</parameter>,
                            <parameter><link linkend="GCutInspectFunction"><type>GCutInspectFunction</type></link> inspect_func</parameter>,
                            <parameter><link linkend="gpointer"><type>gpointer</type></link> user_data</parameter>);</programlisting>
<para>Inspects <parameter>object</parameter>
 by <parameter>inspect_func</parameter>
. The returned string
should be freed when no longer needed.</para>
<refsect3 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>object</para></entry>
<entry role="parameter_description"><para>a <link linkend="GObject"><type>GObject</type></link>.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>inspect_func</para></entry>
<entry role="parameter_description"><para>a function that inspects <parameter>object</parameter>
.</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>user_data</para></entry>
<entry role="parameter_description"><para>user data to pass to the function.</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> inspected <parameter>object</parameter>
as a string.</para>
<para></para>
</refsect3><para role="since">Since 1.0.5</para></refsect2>

</refsect1>
<refsect1 id="cutter-Assertion-Utilities-for-GObject.other_details" role="details">
<title role="details.title">Types and Values</title>

</refsect1>

</refentry>
