Sophie

Sophie

distrib > Mandriva > 2009.0 > i586 > by-pkgid > 76909b5763edb96a2bc7bd7fb5b301b8 > files > 43

cuiterm-0.9.9-1mdv2008.1.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML><HEAD><TITLE>CuiWidget</TITLE><META NAME="GENERATOR" CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK REL="HOME" TITLE="Cuiterm Reference Manual" HREF="index.html"><LINK REL="UP" TITLE="Cuiterm Documentation 0.5" HREF="c4.html"><LINK REL="PREVIOUS" TITLE="program" HREF="cuiterm-program.html"><LINK REL="NEXT" TITLE="CuiRectangle" HREF="cuirectangle.html"><META NAME="GENERATOR" CONTENT="GTK-Doc V1.3 (SGML mode)"><STYLE TYPE="text/css">.synopsis, .classsynopsis {
    background: #eeeeee;
    border: solid 1px #aaaaaa;
    padding: 0.5em;
}
.programlisting {
    background: #eeeeff;
    border: solid 1px #aaaaff;
    padding: 0.5em;
}
.variablelist {
    padding: 4px;
    margin-left: 3em;
}
.navigation {
    background: #ffeeee;
    border: solid 1px #ffaaaa;
    margin-top: 0.5em;
    margin-bottom: 0.5em;
}
.navigation a {
    color: #770000;
}
.navigation a:visited {
    color: #550000;
}
.navigation .title {
    font-size: 200%;
}</STYLE></HEAD><BODY CLASS="REFENTRY" BGCOLOR="#FFFFFF" TEXT="#000000" LINK="#0000FF" VLINK="#840084" ALINK="#0000FF"><TABLE WIDTH="100%" CLASS="navigation" SUMMARY="Navigation header" CELLPADDING="2" CELLSPACING="2"><TR VALIGN="middle"><TD><A ACCESSKEY="p" HREF="cuiterm-program.html"><IMG SRC="left.png" WIDTH="24" HEIGHT="24" BORDER="0" ALT="Prev"></A></TD><TD><A ACCESSKEY="u" HREF="c4.html"><IMG SRC="up.png" WIDTH="24" HEIGHT="24" BORDER="0" ALT="Up"></A></TD><TD><A ACCESSKEY="h" HREF="index.html"><IMG SRC="home.png" WIDTH="24" HEIGHT="24" BORDER="0" ALT="Home"></A></TD><TH WIDTH="100%" align="center">Cuiterm Reference Manual</TH><TD><A ACCESSKEY="n" HREF="cuirectangle.html"><IMG SRC="right.png" WIDTH="24" HEIGHT="24" BORDER="0" ALT="Next"></A></TD></TR></TABLE><H1><A NAME="CUIWIDGET"></A>CuiWidget</H1><DIV CLASS="REFNAMEDIV"><A NAME="AEN1810"></A><H2>Name</H2>CuiWidget&nbsp;--&nbsp;The base class for CUI Widgets.</DIV><DIV CLASS="REFSYNOPSISDIV"><A NAME="AEN1813"></A><H2>Synopsis</H2><PRE CLASS="SYNOPSIS">&#13;#include &lt;history.h&gt;


            <A HREF="cuiwidget.html#CUIWIDGET-STRUCT">CuiWidget</A>;
void        <A HREF="cuiwidget.html#CUI-WIDGET-SET-NAME">cui_widget_set_name</A>             (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             const gchar *name);
gchar*      <A HREF="cuiwidget.html#CUI-WIDGET-GET-NAME">cui_widget_get_name</A>             (<A HREF="cuiwidget.html">CuiWidget</A> *widget);
void        <A HREF="cuiwidget.html#CUI-WIDGET-SET-ACTIVE">cui_widget_set_active</A>           (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             gboolean active);
gboolean    <A HREF="cuiwidget.html#CUI-WIDGET-GET-ACTIVE">cui_widget_get_active</A>           (<A HREF="cuiwidget.html">CuiWidget</A> *widget);
void        <A HREF="cuiwidget.html#CUI-WIDGET-SET-DIRECTORY">cui_widget_set_directory</A>        (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             const gchar *directory);
gchar*      <A HREF="cuiwidget.html#CUI-WIDGET-GET-DIRECTORY">cui_widget_get_directory</A>        (<A HREF="cuiwidget.html">CuiWidget</A> *widget);
void        <A HREF="cuiwidget.html#CUI-WIDGET-SET-BACKGROUND">cui_widget_set_background</A>       (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             const <A HREF="cuiterm-background.html#BACKGROUND">Background</A> *background);
<A HREF="cuiterm-background.html#BACKGROUND">Background</A>* <A HREF="cuiwidget.html#CUI-WIDGET-GET-BACKGROUND">cui_widget_get_background</A>       (<A HREF="cuiwidget.html">CuiWidget</A> *widget);
void        <A HREF="cuiwidget.html#CUI-WIDGET-SET-TERMINAL">cui_widget_set_terminal</A>         (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             const <A HREF="cuiterm-terminal.html#TERMINAL">Terminal</A> *terminal);
<A HREF="cuiterm-terminal.html#TERMINAL">Terminal</A>*   <A HREF="cuiwidget.html#CUI-WIDGET-GET-TERMINAL">cui_widget_get_terminal</A>         (<A HREF="cuiwidget.html">CuiWidget</A> *widget);
void        <A HREF="cuiwidget.html#CUI-WIDGET-SET-APPBAR">cui_widget_set_appbar</A>           (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             GtkWidget *appbar);
void        <A HREF="cuiwidget.html#CUI-WIDGET-SET-TOOLTIP">cui_widget_set_tooltip</A>          (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             const gchar *tooltip);
void        <A HREF="cuiwidget.html#CUI-WIDGET-SET-ACTIVE-STYLE">cui_widget_set_active_style</A>     (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             const gchar *style);
void        <A HREF="cuiwidget.html#CUI-WIDGET-ADD-TAG-BY-NAME">cui_widget_add_tag_by_name</A>      (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             const gchar *tag);
void        <A HREF="cuiwidget.html#CUI-WIDGET-SET-AREA">cui_widget_set_area</A>             (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             const GdkRectangle *rectangle);
void        <A HREF="cuiwidget.html#CUI-WIDGET-MOVE">cui_widget_move</A>                 (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             gint dx,
                                             gint dy);
void        <A HREF="cuiwidget.html#CUI-WIDGET-SET-AREA-BY-COORD">cui_widget_set_area_by_coord</A>    (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             gint x,
                                             gint y,
                                             gint dx,
                                             gint dy);
void        <A HREF="cuiwidget.html#CUI-WIDGET-SET-AREA-BY-MARKS">cui_widget_set_area_by_marks</A>    (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             GtkTextMark *begin,
                                             GtkTextMark *end);
void        <A HREF="cuiwidget.html#CUI-WIDGET-SET-WIDTH-BY-PERCENT">cui_widget_set_width_by_percent</A> (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             gdouble percent);
void        <A HREF="cuiwidget.html#CUI-WIDGET-SET-START-AND-STOP-BY-PERCENT">cui_widget_set_start_and_stop_by_percent</A>
                                            (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             gdouble start,
                                             gdouble stop);
void        <A HREF="cuiwidget.html#CUI-WIDGET-SET-AREA-BY-ITER">cui_widget_set_area_by_iter</A>     (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             GtkTextIter *iter);
GdkRectangle* <A HREF="cuiwidget.html#CUI-WIDGET-GET-AREA">cui_widget_get_area</A>           (<A HREF="cuiwidget.html">CuiWidget</A> *widget);
GdkRectangle* <A HREF="cuiwidget.html#CUI-WIDGET-GET-AREA-WINDOW-COORDS">cui_widget_get_area_window_coords</A>
                                            (<A HREF="cuiwidget.html">CuiWidget</A> *widget);
gint        <A HREF="cuiwidget.html#CUI-WIDGET-GET-SIZE">cui_widget_get_size</A>             (<A HREF="cuiwidget.html">CuiWidget</A> *widget);
gboolean    <A HREF="cuiwidget.html#CUI-WIDGET-IS-MOUSE-OVER">cui_widget_is_mouse_over</A>        (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             gint x,
                                             gint y);
void        <A HREF="cuiwidget.html#CUI-WIDGET-MOUSE-ENTER">cui_widget_mouse_enter</A>          (<A HREF="cuiwidget.html">CuiWidget</A> *widget);
void        <A HREF="cuiwidget.html#CUI-WIDGET-MOUSE-LEAVE">cui_widget_mouse_leave</A>          (<A HREF="cuiwidget.html">CuiWidget</A> *widget);
            <A HREF="cuiwidget.html#CUICOMMAND">CuiCommand</A>;
void        <A HREF="cuiwidget.html#CUI-WIDGET-APPEND-FILE-COMMAND">cui_widget_append_file_command</A>  (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             <A HREF="cuigenerator.html#CUICOMMANDOPCODE">CuiCommandOpcode</A> opcode,
                                             <A HREF="cuifilename.html">CuiFilename</A> *file_arg);
void        <A HREF="cuiwidget.html#CUI-WIDGET-APPEND-FILE-COMMAND-WITH-ARG">cui_widget_append_file_command_with_arg</A>
                                            (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             <A HREF="cuigenerator.html#CUICOMMANDOPCODE">CuiCommandOpcode</A> opcode,
                                             <A HREF="cuifilename.html">CuiFilename</A> *file_arg,
                                             gpointer arg);
void        <A HREF="cuiwidget.html#CUI-WIDGET-APPEND-WINDOW-COMMAND">cui_widget_append_window_command</A>
                                            (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             <A HREF="cuigenerator.html#CUICOMMANDOPCODE">CuiCommandOpcode</A> opcode,
                                             gpointer window);
void        <A HREF="cuiwidget.html#CUI-WIDGET-APPEND-WINDOW-COMMAND-WITH-ARG">cui_widget_append_window_command_with_arg</A>
                                            (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             <A HREF="cuigenerator.html#CUICOMMANDOPCODE">CuiCommandOpcode</A> opcode,
                                             gpointer window,
                                             gpointer arg);
void        <A HREF="cuiwidget.html#CUI-WIDGET-ACTIVATE">cui_widget_activate</A>             (<A HREF="cuiwidget.html">CuiWidget</A> *widget);</PRE></DIV><DIV CLASS="REFSECT1"><A NAME="AEN1948"></A><H2>Object Hierarchy</H2><PRE CLASS="SYNOPSIS">&#13;  GObject
   +----CuiWidget
         +----<A HREF="cuiactionarea.html">CuiActionArea</A>
         +----<A HREF="cuipixmap.html">CuiPixmap</A>
         +----<A HREF="cuientry.html">CuiEntry</A>
         +----<A HREF="cuicalendar.html">CuiCalendar</A>
         +----<A HREF="cuipopupmenu.html">CuiPopupMenu</A>
         +----<A HREF="cuirectangle.html">CuiRectangle</A></PRE></DIV><DIV CLASS="REFSECT1"><A NAME="AEN1958"></A><H2>Properties</H2><PRE CLASS="SYNOPSIS">&#13;  &quot;<A HREF="cuiwidget.html#CUIWIDGET--ACTIVE">active</A>&quot;               gboolean              : Read / Write
  &quot;<A HREF="cuiwidget.html#CUIWIDGET--ACTIVE-STYLE">active-style</A>&quot;         gchararray            : Read / Write
  &quot;<A HREF="cuiwidget.html#CUIWIDGET--APPBAR">appbar</A>&quot;               gpointer              : Read / Write
  &quot;<A HREF="cuiwidget.html#CUIWIDGET--AREA">area</A>&quot;                 gpointer              : Read / Write
  &quot;<A HREF="cuiwidget.html#CUIWIDGET--BACKGROUND">background</A>&quot;           gpointer              : Read / Write
  &quot;<A HREF="cuiwidget.html#CUIWIDGET--DIRECTORY">directory</A>&quot;            gchararray            : Read / Write
  &quot;<A HREF="cuiwidget.html#CUIWIDGET--NAME">name</A>&quot;                 gchararray            : Read / Write
  &quot;<A HREF="cuiwidget.html#CUIWIDGET--TERMINAL">terminal</A>&quot;             gpointer              : Read / Write
  &quot;<A HREF="cuiwidget.html#CUIWIDGET--TOOLTIP">tooltip</A>&quot;              gchararray            : Read / Write</PRE></DIV><DIV CLASS="REFSECT1"><A NAME="AEN1979"></A><H2>Description</H2><P></P></DIV><DIV CLASS="REFSECT1"><A NAME="AEN1982"></A><H2>Details</H2><DIV CLASS="REFSECT2"><A NAME="AEN1984"></A><H3><A NAME="CUIWIDGET-STRUCT"></A>CuiWidget</H3><PRE CLASS="PROGRAMLISTING">typedef struct {
	gchar            *name;        
	gchar            *groupname; 
	GdkRectangle     *area; 
	gboolean          active;    
	gchar            *tooltip;     
	gchar            *directory;   
	Background       *background;
	Terminal         *terminal; 
	GtkWidget        *appbar;  
	gboolean          visible;
	GList            *commands;
	GdkCursor        *mouse_cursor_active;
	GdkCursor        *mouse_cursor_inactive;
	gboolean          mouse_is_over;

	GtkTextMark      *begin_mark;
	GtkTextMark      *end_mark;
	gchar            *active_style;
} CuiWidget;</PRE><P>This is a base class for the widgets in the CUI environment.
Currently I'm marking some fields as public since I didn't write the
accessing functions for them.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN1993"><SPAN STYLE="white-space: nowrap">gchar&nbsp;*<CODE CLASS="STRUCTFIELD">name</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the name of the widget instance if any</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN1999"><SPAN STYLE="white-space: nowrap">gchar&nbsp;*<CODE CLASS="STRUCTFIELD">groupname</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the name of the group if any</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2005"><SPAN STYLE="white-space: nowrap">GdkRectangle&nbsp;*<CODE CLASS="STRUCTFIELD">area</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P>  the location and the size of the widget</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2011"><SPAN STYLE="white-space: nowrap">gboolean&nbsp;<CODE CLASS="STRUCTFIELD">active</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> if the widget can be activated</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2017"><SPAN STYLE="white-space: nowrap">gchar&nbsp;*<CODE CLASS="STRUCTFIELD">tooltip</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> some descriptive text for the user</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2023"><SPAN STYLE="white-space: nowrap">gchar&nbsp;*<CODE CLASS="STRUCTFIELD">directory</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the working directory of the command</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2029"><SPAN STYLE="white-space: nowrap"><A HREF="cuiterm-background.html#BACKGROUND">Background</A>&nbsp;*<CODE CLASS="STRUCTFIELD">background</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P>  the background this widgets belongs to</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2035"><SPAN STYLE="white-space: nowrap"><A HREF="cuiterm-terminal.html#TERMINAL">Terminal</A>&nbsp;*<CODE CLASS="STRUCTFIELD">terminal</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the terminal to send the commands to</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2041"><SPAN STYLE="white-space: nowrap">GtkWidget&nbsp;*<CODE CLASS="STRUCTFIELD">appbar</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> for the tooltip information</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2047"><SPAN STYLE="white-space: nowrap">gboolean&nbsp;<CODE CLASS="STRUCTFIELD">visible</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> if the widget is currently visible (FIXME: do we use this?)</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2053"><SPAN STYLE="white-space: nowrap">GList&nbsp;*<CODE CLASS="STRUCTFIELD">commands</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> The list with the commands we want to execite when the widget 
 is activated. </P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2059"><SPAN STYLE="white-space: nowrap">GdkCursor&nbsp;*<CODE CLASS="STRUCTFIELD">mouse_cursor_active</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> The mouse cursor we want to see over the widget.</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2065"><SPAN STYLE="white-space: nowrap">GdkCursor&nbsp;*<CODE CLASS="STRUCTFIELD">mouse_cursor_inactive</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> The mouse cursor we want to see when the mouse 
 leaves the widget.</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2071"><SPAN STYLE="white-space: nowrap">gboolean&nbsp;<CODE CLASS="STRUCTFIELD">mouse_is_over</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> This field is TRUE if the mouse cursor is currently over 
 the widget.</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2077"><SPAN STYLE="white-space: nowrap">GtkTextMark&nbsp;*<CODE CLASS="STRUCTFIELD">begin_mark</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2083"><SPAN STYLE="white-space: nowrap">GtkTextMark&nbsp;*<CODE CLASS="STRUCTFIELD">end_mark</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2089"><SPAN STYLE="white-space: nowrap">gchar&nbsp;*<CODE CLASS="STRUCTFIELD">active_style</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P></P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2095"></A><H3><A NAME="CUI-WIDGET-SET-NAME"></A>cui_widget_set_name ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_set_name             (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             const gchar *name);</PRE><P>Sets the name for this widget instance. The name appears in messages, help
texts and several other places.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2107"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2114"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">name</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the name of the widget</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2119"></A><H3><A NAME="CUI-WIDGET-GET-NAME"></A>cui_widget_get_name ()</H3><PRE CLASS="PROGRAMLISTING">gchar*      cui_widget_get_name             (<A HREF="cuiwidget.html">CuiWidget</A> *widget);</PRE><P>Gets the name of this widget instance. The returned string 
should be freed.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2130"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2137"><SPAN STYLE="white-space: nowrap"><SPAN CLASS="emphasis"><I CLASS="EMPHASIS">Returns</I></SPAN>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a newly allocated string</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2142"></A><H3><A NAME="CUI-WIDGET-SET-ACTIVE"></A>cui_widget_set_active ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_set_active           (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             gboolean active);</PRE><P>Sets is the widget can be activated by the mouse.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2154"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2161"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">active</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> sets if the widget is an active one</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2166"></A><H3><A NAME="CUI-WIDGET-GET-ACTIVE"></A>cui_widget_get_active ()</H3><PRE CLASS="PROGRAMLISTING">gboolean    cui_widget_get_active           (<A HREF="cuiwidget.html">CuiWidget</A> *widget);</PRE><P>Gets if the widget can be activated by the mouse.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2177"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2184"><SPAN STYLE="white-space: nowrap"><SPAN CLASS="emphasis"><I CLASS="EMPHASIS">Returns</I></SPAN>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> TRUE if the widget can be activated</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2189"></A><H3><A NAME="CUI-WIDGET-SET-DIRECTORY"></A>cui_widget_set_directory ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_set_directory        (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             const gchar *directory);</PRE><P>Sets the directory for this widget instance. The directory shows what was the
working directory when this widget has been created.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2201"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2208"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">directory</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the working directory of the widget's creator</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2213"></A><H3><A NAME="CUI-WIDGET-GET-DIRECTORY"></A>cui_widget_get_directory ()</H3><PRE CLASS="PROGRAMLISTING">gchar*      cui_widget_get_directory        (<A HREF="cuiwidget.html">CuiWidget</A> *widget);</PRE><P>Gets the working directory of this widget instance.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2224"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2231"><SPAN STYLE="white-space: nowrap"><SPAN CLASS="emphasis"><I CLASS="EMPHASIS">Returns</I></SPAN>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a newly allocated string</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2236"></A><H3><A NAME="CUI-WIDGET-SET-BACKGROUND"></A>cui_widget_set_background ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_set_background       (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             const <A HREF="cuiterm-background.html#BACKGROUND">Background</A> *background);</PRE><P>Sets the background for this widget instance. The background is the place
where we show the widget. This function also registers the widget calling
<A HREF="cuiterm-background.html#CUI-BACKGROUND-APPEND-WIDGET"><SPAN CLASS="TYPE">cui_background_append_widget</SPAN></A>.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2250"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2257"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">background</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the background this widget belongs to</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2262"></A><H3><A NAME="CUI-WIDGET-GET-BACKGROUND"></A>cui_widget_get_background ()</H3><PRE CLASS="PROGRAMLISTING"><A HREF="cuiterm-background.html#BACKGROUND">Background</A>* cui_widget_get_background       (<A HREF="cuiwidget.html">CuiWidget</A> *widget);</PRE><P>Gets the background this widget instance appears on.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2273"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2280"><SPAN STYLE="white-space: nowrap"><SPAN CLASS="emphasis"><I CLASS="EMPHASIS">Returns</I></SPAN>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a pointer to the background </P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2285"></A><H3><A NAME="CUI-WIDGET-SET-TERMINAL"></A>cui_widget_set_terminal ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_set_terminal         (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             const <A HREF="cuiterm-terminal.html#TERMINAL">Terminal</A> *terminal);</PRE><P>Sets the terminal for this widget instance. The terminal is a <A HREF="cuiterm-terminal.html#TERMINAL"><SPAN CLASS="TYPE">Terminal</SPAN></A>
object we send the commands to execute.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2299"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2306"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">terminal</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the terminal we use to send the commands to the shell</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2311"></A><H3><A NAME="CUI-WIDGET-GET-TERMINAL"></A>cui_widget_get_terminal ()</H3><PRE CLASS="PROGRAMLISTING"><A HREF="cuiterm-terminal.html#TERMINAL">Terminal</A>*   cui_widget_get_terminal         (<A HREF="cuiwidget.html">CuiWidget</A> *widget);</PRE><P>Gets the terminal of this widget. The terminal is a <A HREF="cuiterm-terminal.html#TERMINAL"><SPAN CLASS="TYPE">Terminal</SPAN></A> object we use
to send the command to the shell.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2324"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2331"><SPAN STYLE="white-space: nowrap"><SPAN CLASS="emphasis"><I CLASS="EMPHASIS">Returns</I></SPAN>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a pointer to the background </P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2336"></A><H3><A NAME="CUI-WIDGET-SET-APPBAR"></A>cui_widget_set_appbar ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_set_appbar           (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             GtkWidget *appbar);</PRE><P>Sets the appbar for this widget instance. The appbar is a widget 
where we send tooltip text when needed.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2348"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2355"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">appbar</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the application bar we send the tooltip text</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2360"></A><H3><A NAME="CUI-WIDGET-SET-TOOLTIP"></A>cui_widget_set_tooltip ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_set_tooltip          (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             const gchar *tooltip);</PRE><P>Sets the tooltip text for this widget instance. The tooltip text is a short
remainder appears in a different <SPAN CLASS="TYPE">GtkWidget</SPAN>.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2374"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2381"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">tooltip</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the tooltip text of the widget</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2386"></A><H3><A NAME="CUI-WIDGET-SET-ACTIVE-STYLE"></A>cui_widget_set_active_style ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_set_active_style     (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             const gchar *style);</PRE><P>Sets the active style name text for this widget instance. The active style is
a text style used when the mouse is over the widget.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2398"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2405"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">style</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the active style text of the widget</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2410"></A><H3><A NAME="CUI-WIDGET-ADD-TAG-BY-NAME"></A>cui_widget_add_tag_by_name ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_add_tag_by_name      (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             const gchar *tag);</PRE><P>Convinient utility function to highlight the text belongs to the widget.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2422"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A> widget</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2429"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">tag</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the name of the tag to apply</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2434"></A><H3><A NAME="CUI-WIDGET-SET-AREA"></A>cui_widget_set_area ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_set_area             (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             const GdkRectangle *rectangle);</PRE><P>Sets the activation area for this widget instance. This function will copy
the <SPAN CLASS="TYPE">GdkRectangle</SPAN> to an allocated memory, so it can be freed.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2448"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2455"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">rectangle</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the rectangle of the activation area for this widget</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2460"></A><H3><A NAME="CUI-WIDGET-MOVE"></A>cui_widget_move ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_move                 (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             gint dx,
                                             gint dy);</PRE><P>Moves the widget by modifying its coordinates.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2473"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the widget to move</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2478"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">dx</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> movement on the x axis</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2483"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">dy</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> movement on the y axis</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2488"></A><H3><A NAME="CUI-WIDGET-SET-AREA-BY-COORD"></A>cui_widget_set_area_by_coord ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_set_area_by_coord    (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             gint x,
                                             gint y,
                                             gint dx,
                                             gint dy);</PRE><P>Sets the activation area for this widget instance.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2503"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2510"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">x</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the x coordinate </P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2515"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">y</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the y coordinate </P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2520"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">dx</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the width </P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2525"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">dy</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the height</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2530"></A><H3><A NAME="CUI-WIDGET-SET-AREA-BY-MARKS"></A>cui_widget_set_area_by_marks ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_set_area_by_marks    (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             GtkTextMark *begin,
                                             GtkTextMark *end);</PRE><P>Sets the activation area for this widget instance. This function copy the
marks so they can be eliminated.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2543"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2550"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">begin</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the <SPAN CLASS="TYPE">GtkTextMark</SPAN> of the upper left corner</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2557"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">end</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the <SPAN CLASS="TYPE">GtkTextMark</SPAN> of the lower right corner</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2564"></A><H3><A NAME="CUI-WIDGET-SET-WIDTH-BY-PERCENT"></A>cui_widget_set_width_by_percent ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_set_width_by_percent (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             gdouble percent);</PRE><P>Sets the width of the widget as the fraction of the background text window.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2576"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2583"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">percent</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the new width of the widget as a fraction of 100</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2588"></A><H3><A NAME="CUI-WIDGET-SET-START-AND-STOP-BY-PERCENT"></A>cui_widget_set_start_and_stop_by_percent ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_set_start_and_stop_by_percent
                                            (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             gdouble start,
                                             gdouble stop);</PRE><P>Sets the left and right coordinates of the widget as the fraction of the 
background text window.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2601"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2608"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">start</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2613"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">stop</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P>&#13;</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2618"></A><H3><A NAME="CUI-WIDGET-SET-AREA-BY-ITER"></A>cui_widget_set_area_by_iter ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_set_area_by_iter     (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             GtkTextIter *iter);</PRE><P>Sets the activation area of the widgets using a <SPAN CLASS="TYPE">GtkTextIter</SPAN> to find a
character. This function is usefull to create action areas for one given 
character on the user interface.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2632"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A> to set</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2639"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">iter</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the <SPAN CLASS="TYPE">GtkTextIter</SPAN> storing the place of the char</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2646"></A><H3><A NAME="CUI-WIDGET-GET-AREA"></A>cui_widget_get_area ()</H3><PRE CLASS="PROGRAMLISTING">GdkRectangle* cui_widget_get_area           (<A HREF="cuiwidget.html">CuiWidget</A> *widget);</PRE><P>Gets the activation area of this widget. The return value should not be
modified or freed.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2657"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2664"><SPAN STYLE="white-space: nowrap"><SPAN CLASS="emphasis"><I CLASS="EMPHASIS">Returns</I></SPAN>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the rectangular area of the widget</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2669"></A><H3><A NAME="CUI-WIDGET-GET-AREA-WINDOW-COORDS"></A>cui_widget_get_area_window_coords ()</H3><PRE CLASS="PROGRAMLISTING">GdkRectangle* cui_widget_get_area_window_coords
                                            (<A HREF="cuiwidget.html">CuiWidget</A> *widget);</PRE><P>Gets the activation area of this widget relative to the text_view this
widget is in. Note that the <A HREF="cuiterm-background.html#BACKGROUND"><SPAN CLASS="TYPE">Background</SPAN></A> of the widget must be valid
and the <SPAN CLASS="TYPE">GtkTextView</SPAN> of the <A HREF="cuiterm-background.html#BACKGROUND"><SPAN CLASS="TYPE">Background</SPAN></A> also must be set.</P><P>The return value of the function is a dinamically allocated area which
should be freed.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2687"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2694"><SPAN STYLE="white-space: nowrap"><SPAN CLASS="emphasis"><I CLASS="EMPHASIS">Returns</I></SPAN>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the rectangular area of the widget relative to the text_view</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2699"></A><H3><A NAME="CUI-WIDGET-GET-SIZE"></A>cui_widget_get_size ()</H3><PRE CLASS="PROGRAMLISTING">gint        cui_widget_get_size             (<A HREF="cuiwidget.html">CuiWidget</A> *widget);</PRE><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2709"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2714"><SPAN STYLE="white-space: nowrap"><SPAN CLASS="emphasis"><I CLASS="EMPHASIS">Returns</I></SPAN>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P>&#13;</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2719"></A><H3><A NAME="CUI-WIDGET-IS-MOUSE-OVER"></A>cui_widget_is_mouse_over ()</H3><PRE CLASS="PROGRAMLISTING">gboolean    cui_widget_is_mouse_over        (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             gint x,
                                             gint y);</PRE><P>Checks if the mouse is over the given widget, that is the given coordinates
are inside the activation area.</P><P>This function gets x and y coordinate in the widget coordinate system. Use #
gtk_text_view_window_to_buffer_coords to convert mouse coordinates to this
coordinate system.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2733"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2740"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">x</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the x coordinate of the mouse</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2745"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">y</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the y coordinate of the mouse</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2750"><SPAN STYLE="white-space: nowrap"><SPAN CLASS="emphasis"><I CLASS="EMPHASIS">Returns</I></SPAN>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> TRUE if the given coordinates are inside the activation area</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2755"></A><H3><A NAME="CUI-WIDGET-MOUSE-ENTER"></A>cui_widget_mouse_enter ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_mouse_enter          (<A HREF="cuiwidget.html">CuiWidget</A> *widget);</PRE><P>This function must be called when the mouse enters the area of the widget.
I'm sure there is a better solution, but I have not found yet... yep, found
we should use signals of course. FIXME: we really should use signals.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2766"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A> widget</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2773"></A><H3><A NAME="CUI-WIDGET-MOUSE-LEAVE"></A>cui_widget_mouse_leave ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_mouse_leave          (<A HREF="cuiwidget.html">CuiWidget</A> *widget);</PRE><P>This function must be called when the mouse leaves the area of the widget.
I'm sure there is a better solution, but I have not found yet...</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2784"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A> widget</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2791"></A><H3><A NAME="CUICOMMAND"></A>CuiCommand</H3><PRE CLASS="PROGRAMLISTING">typedef struct {
	CuiCommandType     type;
	CuiCommandOpcode   opcode;
	gpointer           parg1;
	gpointer 	   parg2;
} CuiCommand;</PRE><P></P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2800"><SPAN STYLE="white-space: nowrap"><A HREF="cuigenerator.html#CUICOMMANDTYPE">CuiCommandType</A>&nbsp;<CODE CLASS="STRUCTFIELD">type</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the type of the command used to decide how to perform</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2806"><SPAN STYLE="white-space: nowrap"><A HREF="cuigenerator.html#CUICOMMANDOPCODE">CuiCommandOpcode</A>&nbsp;<CODE CLASS="STRUCTFIELD">opcode</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the operation code (what to do)</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2812"><SPAN STYLE="white-space: nowrap">gpointer&nbsp;<CODE CLASS="STRUCTFIELD">parg1</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a pointer argument </P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2818"><SPAN STYLE="white-space: nowrap">gpointer&nbsp;<CODE CLASS="STRUCTFIELD">parg2</CODE>;</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> an optional second argument</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2824"></A><H3><A NAME="CUI-WIDGET-APPEND-FILE-COMMAND"></A>cui_widget_append_file_command ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_append_file_command  (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             <A HREF="cuigenerator.html#CUICOMMANDOPCODE">CuiCommandOpcode</A> opcode,
                                             <A HREF="cuifilename.html">CuiFilename</A> *file_arg);</PRE><P>The functions appends a new command to the widget. The commands are
instructions we have to execute when the user activates the widget. As it is
obvious I'm not exactly sure how we have to develop this command feature, 
but it is essential to send lines to the shell.</P><P>This function handles only commands used to handle files.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2838"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2845"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">opcode</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the code of this operation</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2850"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">file_arg</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the <A HREF="cuifilename.html"><SPAN CLASS="TYPE">CuiFilename</SPAN></A> argument of the command</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2857"></A><H3><A NAME="CUI-WIDGET-APPEND-FILE-COMMAND-WITH-ARG"></A>cui_widget_append_file_command_with_arg ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_append_file_command_with_arg
                                            (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             <A HREF="cuigenerator.html#CUICOMMANDOPCODE">CuiCommandOpcode</A> opcode,
                                             <A HREF="cuifilename.html">CuiFilename</A> *file_arg,
                                             gpointer arg);</PRE><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2870"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2875"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">opcode</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2880"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">file_arg</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2885"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">arg</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P>&#13;</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2890"></A><H3><A NAME="CUI-WIDGET-APPEND-WINDOW-COMMAND"></A>cui_widget_append_window_command ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_append_window_command
                                            (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             <A HREF="cuigenerator.html#CUICOMMANDOPCODE">CuiCommandOpcode</A> opcode,
                                             gpointer window);</PRE><P>Appends a new window command to the widget.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2903"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2910"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">opcode</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the opcode of the command</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2915"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">window</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwindow.html"><SPAN CLASS="TYPE">CuiWindow</SPAN></A></P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2922"></A><H3><A NAME="CUI-WIDGET-APPEND-WINDOW-COMMAND-WITH-ARG"></A>cui_widget_append_window_command_with_arg ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_append_window_command_with_arg
                                            (<A HREF="cuiwidget.html">CuiWidget</A> *widget,
                                             <A HREF="cuigenerator.html#CUICOMMANDOPCODE">CuiCommandOpcode</A> opcode,
                                             gpointer window,
                                             gpointer arg);</PRE><P>Appends a new window command to the widget.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2936"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2943"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">opcode</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the opcode of the command</P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2948"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">window</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwindow.html"><SPAN CLASS="TYPE">CuiWindow</SPAN></A></P></TD></TR><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2955"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">arg</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> the argument</P></TD></TR></TBODY></TABLE></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2960"></A><H3><A NAME="CUI-WIDGET-ACTIVATE"></A>cui_widget_activate ()</H3><PRE CLASS="PROGRAMLISTING">void        cui_widget_activate             (<A HREF="cuiwidget.html">CuiWidget</A> *widget);</PRE><P>Emits the commands associated with the widget. This function should be 
called when the user activates the widget.</P><P></P><P></P><TABLE CLASS="variablelist" BORDER="0" CELLSPACING="0" CELLPADDING="4"><TBODY><TR><TD ALIGN="LEFT" VALIGN="TOP"><A NAME="AEN2971"><SPAN STYLE="white-space: nowrap"><CODE CLASS="PARAMETER">widget</CODE>&nbsp;:</SPAN></TD><TD ALIGN="LEFT" VALIGN="TOP"><P> a <A HREF="cuiwidget.html"><SPAN CLASS="TYPE">CuiWidget</SPAN></A></P></TD></TR></TBODY></TABLE></DIV></DIV><DIV CLASS="REFSECT1"><A NAME="AEN2978"></A><H2>Properties</H2><DIV CLASS="REFSECT2"><A NAME="AEN2980"></A><H3><A NAME="CUIWIDGET--ACTIVE"></A>The &quot;<TT CLASS="LITERAL">active</TT>&quot; property</H3><PRE CLASS="PROGRAMLISTING">  &quot;active&quot;               gboolean              : Read / Write</PRE><P>If this widget is shown and working.</P><P>Default value: TRUE</P></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2988"></A><H3><A NAME="CUIWIDGET--ACTIVE-STYLE"></A>The &quot;<TT CLASS="LITERAL">active-style</TT>&quot; property</H3><PRE CLASS="PROGRAMLISTING">  &quot;active-style&quot;         gchararray            : Read / Write</PRE><P>Text style for the active state if any.</P><P>Default value: ""</P></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN2996"></A><H3><A NAME="CUIWIDGET--APPBAR"></A>The &quot;<TT CLASS="LITERAL">appbar</TT>&quot; property</H3><PRE CLASS="PROGRAMLISTING">  &quot;appbar&quot;               gpointer              : Read / Write</PRE><P>The GtkWidget to send the tooltip information.</P></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN3003"></A><H3><A NAME="CUIWIDGET--AREA"></A>The &quot;<TT CLASS="LITERAL">area</TT>&quot; property</H3><PRE CLASS="PROGRAMLISTING">  &quot;area&quot;                 gpointer              : Read / Write</PRE><P>The place and the size of the widget.</P></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN3010"></A><H3><A NAME="CUIWIDGET--BACKGROUND"></A>The &quot;<TT CLASS="LITERAL">background</TT>&quot; property</H3><PRE CLASS="PROGRAMLISTING">  &quot;background&quot;           gpointer              : Read / Write</PRE><P>The background containing this widget.</P></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN3017"></A><H3><A NAME="CUIWIDGET--DIRECTORY"></A>The &quot;<TT CLASS="LITERAL">directory</TT>&quot; property</H3><PRE CLASS="PROGRAMLISTING">  &quot;directory&quot;            gchararray            : Read / Write</PRE><P>The working directory of the creator command.</P><P>Default value: ""</P></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN3025"></A><H3><A NAME="CUIWIDGET--NAME"></A>The &quot;<TT CLASS="LITERAL">name</TT>&quot; property</H3><PRE CLASS="PROGRAMLISTING">  &quot;name&quot;                 gchararray            : Read / Write</PRE><P>The name of this widget instance.</P><P>Default value: "unknown name"</P></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN3033"></A><H3><A NAME="CUIWIDGET--TERMINAL"></A>The &quot;<TT CLASS="LITERAL">terminal</TT>&quot; property</H3><PRE CLASS="PROGRAMLISTING">  &quot;terminal&quot;             gpointer              : Read / Write</PRE><P>The terminal we send the commands to.</P></DIV><HR><DIV CLASS="REFSECT2"><A NAME="AEN3040"></A><H3><A NAME="CUIWIDGET--TOOLTIP"></A>The &quot;<TT CLASS="LITERAL">tooltip</TT>&quot; property</H3><PRE CLASS="PROGRAMLISTING">  &quot;tooltip&quot;              gchararray            : Read / Write</PRE><P>Some descriptive text.</P><P>Default value: ""</P></DIV></DIV><TABLE CLASS="navigation" WIDTH="100%" SUMMARY="Navigation footer" CELLPADDING="2" CELLSPACING="2"><TR VALIGN="middle"><TD ALIGN="left"><A ACCESSKEY="p" HREF="cuiterm-program.html"><B>&lt;&lt;&lt;&nbsp;program</B></A></TD><TD ALIGN="right"><A ACCESSKEY="n" HREF="cuirectangle.html"><B>CuiRectangle&nbsp;&gt;&gt;&gt;</B></A></TD></TR></TABLE></BODY></HTML>