<refentry id="GnomeDbEditor">
<refmeta>
<refentrytitle>GnomeDbEditor</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGNOMEDB-4.0 Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GnomeDbEditor</refname><refpurpose>A general purpose SQL editor</refpurpose>
</refnamediv>

<refsynopsisdiv><title>Synopsis</title>

<synopsis>



struct      <link linkend="GnomeDbEditor-struct">GnomeDbEditor</link>;
struct      <link linkend="GnomeDbEditorClass">GnomeDbEditorClass</link>;
struct      <link linkend="GnomeDbEditorPrivate">GnomeDbEditorPrivate</link>;
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gnome-db-editor-new">gnome_db_editor_new</link>             (void);
<link linkend="gboolean">gboolean</link>    <link linkend="gnome-db-editor-get-editable">gnome_db_editor_get_editable</link>    (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor);
<link linkend="void">void</link>        <link linkend="gnome-db-editor-set-editable">gnome_db_editor_set_editable</link>    (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor,
                                             <link linkend="gboolean">gboolean</link> editable);
<link linkend="gboolean">gboolean</link>    <link linkend="gnome-db-editor-get-highlight">gnome_db_editor_get_highlight</link>   (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor);
<link linkend="void">void</link>        <link linkend="gnome-db-editor-set-highlight">gnome_db_editor_set_highlight</link>   (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor,
                                             <link linkend="gboolean">gboolean</link> highlight);
<link linkend="void">void</link>        <link linkend="gnome-db-editor-set-text">gnome_db_editor_set_text</link>        (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor,
                                             const <link linkend="gchar">gchar</link> *text,
                                             <link linkend="gint">gint</link> len);
<link linkend="gchar">gchar</link>*      <link linkend="gnome-db-editor-get-all-text">gnome_db_editor_get_all_text</link>    (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor);
<link linkend="gboolean">gboolean</link>    <link linkend="gnome-db-editor-load-from-file">gnome_db_editor_load_from_file</link>  (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor,
                                             const <link linkend="gchar">gchar</link> *filename);
<link linkend="gboolean">gboolean</link>    <link linkend="gnome-db-editor-save-to-file">gnome_db_editor_save_to_file</link>    (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor,
                                             const <link linkend="gchar">gchar</link> *filename);
<link linkend="void">void</link>        <link linkend="gnome-db-editor-copy-clipboard">gnome_db_editor_copy_clipboard</link>  (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor);
<link linkend="void">void</link>        <link linkend="gnome-db-editor-cut-clipboard">gnome_db_editor_cut_clipboard</link>   (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor);
<link linkend="void">void</link>        <link linkend="gnome-db-editor-paste-clipboard">gnome_db_editor_paste_clipboard</link> (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor);

</synopsis>
</refsynopsisdiv>

<refsect1>
<title>Object Hierarchy</title>
<synopsis>

  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkContainer">GtkContainer</link>
                           +----<link linkend="GtkBox">GtkBox</link>
                                 +----<link linkend="GtkVBox">GtkVBox</link>
                                       +----GnomeDbEditor
</synopsis>

</refsect1>



<refsect1>
<title>Implemented Interfaces</title>
<para>
GnomeDbEditor implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>,  <link linkend="GtkBuildable">GtkBuildable</link> and  <link linkend="GtkOrientable">GtkOrientable</link>.</para>

</refsect1>





<refsect1>
<title>Description</title>
<para>

</para>
</refsect1>

<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="GnomeDbEditor-struct"/>struct GnomeDbEditor</title>
<indexterm><primary>GnomeDbEditor</primary></indexterm><programlisting>struct GnomeDbEditor;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GnomeDbEditorClass"/>struct GnomeDbEditorClass</title>
<indexterm><primary>GnomeDbEditorClass</primary></indexterm><programlisting>struct GnomeDbEditorClass {

	GtkVBoxClass parent_class;

	/* signals */
	void (* text_changed) (GnomeDbEditor editor);
};
</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="GnomeDbEditorPrivate"/>struct GnomeDbEditorPrivate</title>
<indexterm><primary>GnomeDbEditorPrivate</primary></indexterm><programlisting>struct GnomeDbEditorPrivate;</programlisting>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="gnome-db-editor-new"/>gnome_db_editor_new ()</title>
<indexterm><primary>gnome_db_editor_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gnome_db_editor_new             (void);</programlisting>
<para>
Create a new <link linkend="GnomeDbEditor"><type>GnomeDbEditor</type></link> widget, which is a multiline text widget
with support for several languages used to write database stored
procedures and functions. If libgnomedb was compiled with gtksourceview
in, this widget will support syntax highlighting for all supported
languages.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the newly created widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-editor-get-editable"/>gnome_db_editor_get_editable ()</title>
<indexterm><primary>gnome_db_editor_get_editable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_db_editor_get_editable    (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor);</programlisting>
<para>
Retrieve the editable status of the given editor widget.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>editor</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbEditor"><type>GnomeDbEditor</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the editable status.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-editor-set-editable"/>gnome_db_editor_set_editable ()</title>
<indexterm><primary>gnome_db_editor_set_editable</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_db_editor_set_editable    (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor,
                                             <link linkend="gboolean">gboolean</link> editable);</programlisting>
<para>
Set the editable state of the given editor widget.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>editor</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbEditor"><type>GnomeDbEditor</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>editable</parameter>&nbsp;:</term>
<listitem><simpara> editable state.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-editor-get-highlight"/>gnome_db_editor_get_highlight ()</title>
<indexterm><primary>gnome_db_editor_get_highlight</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_db_editor_get_highlight   (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor);</programlisting>
<para>
Retrieve the highlighting status of the given editor widget.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>editor</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbEditor"><type>GnomeDbEditor</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the highlighting status.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-editor-set-highlight"/>gnome_db_editor_set_highlight ()</title>
<indexterm><primary>gnome_db_editor_set_highlight</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_db_editor_set_highlight   (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor,
                                             <link linkend="gboolean">gboolean</link> highlight);</programlisting>
<para>
Set the highlighting status on the given editor widget.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>editor</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbEditor"><type>GnomeDbEditor</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>highlight</parameter>&nbsp;:</term>
<listitem><simpara> highlighting status.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-editor-set-text"/>gnome_db_editor_set_text ()</title>
<indexterm><primary>gnome_db_editor_set_text</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_db_editor_set_text        (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor,
                                             const <link linkend="gchar">gchar</link> *text,
                                             <link linkend="gint">gint</link> len);</programlisting>
<para>
Set the contents of the given editor widget.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>editor</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbEditor"><type>GnomeDbEditor</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter>&nbsp;:</term>
<listitem><simpara> text to display in the editor.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>len</parameter>&nbsp;:</term>
<listitem><simpara> length of <parameter>text</parameter>.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-editor-get-all-text"/>gnome_db_editor_get_all_text ()</title>
<indexterm><primary>gnome_db_editor_get_all_text</primary></indexterm><programlisting><link linkend="gchar">gchar</link>*      gnome_db_editor_get_all_text    (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor);</programlisting>
<para>
Retrieve the full contents of the given editor widget.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>editor</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbEditor"><type>GnomeDbEditor</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the current contents of the editor buffer. You must free
the returned value when no longer needed.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-editor-load-from-file"/>gnome_db_editor_load_from_file ()</title>
<indexterm><primary>gnome_db_editor_load_from_file</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_db_editor_load_from_file  (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor,
                                             const <link linkend="gchar">gchar</link> *filename);</programlisting>
<para>
Load the given filename into the editor widget.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>editor</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbEditor"><type>GnomeDbEditor</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
<listitem><simpara> the file to be loaded.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if successful, FALSE otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-editor-save-to-file"/>gnome_db_editor_save_to_file ()</title>
<indexterm><primary>gnome_db_editor_save_to_file</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>    gnome_db_editor_save_to_file    (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor,
                                             const <link linkend="gchar">gchar</link> *filename);</programlisting>
<para>
Save the current editor contents to the given file.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>editor</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbEditor"><type>GnomeDbEditor</type></link> widget.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>filename</parameter>&nbsp;:</term>
<listitem><simpara> the file to save to.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if successful, FALSE otherwise.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-editor-copy-clipboard"/>gnome_db_editor_copy_clipboard ()</title>
<indexterm><primary>gnome_db_editor_copy_clipboard</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_db_editor_copy_clipboard  (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor);</programlisting>
<para>
Copy currently selected text in the given editor widget to the clipboard.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>editor</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbEditor"><type>GnomeDbEditor</type></link> widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-editor-cut-clipboard"/>gnome_db_editor_cut_clipboard ()</title>
<indexterm><primary>gnome_db_editor_cut_clipboard</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_db_editor_cut_clipboard   (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor);</programlisting>
<para>
Moves currently selected text in the given editor widget to the clipboard.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>editor</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbEditor"><type>GnomeDbEditor</type></link> widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-db-editor-paste-clipboard"/>gnome_db_editor_paste_clipboard ()</title>
<indexterm><primary>gnome_db_editor_paste_clipboard</primary></indexterm><programlisting><link linkend="void">void</link>        gnome_db_editor_paste_clipboard (<link linkend="GnomeDbEditor">GnomeDbEditor</link> *editor);</programlisting>
<para>
Paste clipboard contents into editor widget, at the current position.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>editor</parameter>&nbsp;:</term>
<listitem><simpara> a <link linkend="GnomeDbEditor"><type>GnomeDbEditor</type></link> widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
