CuiActionArea

Name

CuiActionArea -- 

Synopsis


#include <history.h>


            CuiActionArea;
CuiWidget*  cui_action_area_new             (void);
CuiWidget*  cui_action_area_new_for_filename
                                            (CuiWindow *window,
                                             Background *background,
                                             CuiFilename *file,
                                             GtkTextMark *begin,
                                             GtkTextMark *end);
void        cui_action_area_new_for_mode_owner
                                            (CuiWindow *window,
                                             Background *background,
                                             CuiFilename *file,
                                             GtkTextMark *begin,
                                             GtkTextMark *end);
void        cui_action_area_new_for_mode_group
                                            (CuiWindow *window,
                                             Background *background,
                                             CuiFilename *file,
                                             GtkTextMark *begin,
                                             GtkTextMark *end);
void        cui_action_area_new_for_mode_others
                                            (CuiWindow *window,
                                             Background *background,
                                             CuiFilename *file,
                                             GtkTextMark *begin,
                                             GtkTextMark *end);
void        cui_action_area_new_for_mode    (CuiWindow *window,
                                             Background *background,
                                             CuiFilename *file,
                                             GtkTextMark *begin,
                                             GtkTextMark *end);
gboolean    cui_action_area_redraw          (CuiActionArea *area,
                                             gint debug);

Object Hierarchy


  GObject
   +----CuiWidget
         +----CuiActionArea

Signal Prototypes


"expose"    gboolean    user_function      (CuiActionArea *cuiactionarea,
                                            gint arg1,
                                            gpointer user_data);

Description

Details

CuiActionArea

typedef struct _CuiActionArea CuiActionArea;


cui_action_area_new ()

CuiWidget*  cui_action_area_new             (void);

Creates a newly allocated action area, a rectangular box on the CUI which can be activated with a double click by the user.

Returns :

A newly allocated and initialized action area


cui_action_area_new_for_filename ()

CuiWidget*  cui_action_area_new_for_filename
                                            (CuiWindow *window,
                                             Background *background,
                                             CuiFilename *file,
                                             GtkTextMark *begin,
                                             GtkTextMark *end);

Creates a new ActionArea for the filename. This action area is used to open a file in an application or show the contents of a directory. The function registrates the new area in the background, so the return value is not needed to use it.

window :

the embedded window for this action area

background :

The Background where the CuiActionArea will appear.

file :

The file the area will open.

begin :

The starting point of the filename on the user interface.

end :

The end point of the filename.

Returns :

A new CuiActionArea


cui_action_area_new_for_mode_owner ()

void        cui_action_area_new_for_mode_owner
                                            (CuiWindow *window,
                                             Background *background,
                                             CuiFilename *file,
                                             GtkTextMark *begin,
                                             GtkTextMark *end);

Creates some action areas for changing the mode of a file on the user rights string which is a three character long string (eg. "rwx").

window :

a CuiWindow containing the mode string

background :

a Background where the action area goes

file :

a CuiFile of this mode string

begin :

the start point of the string

end :

the end point of the string


cui_action_area_new_for_mode_group ()

void        cui_action_area_new_for_mode_group
                                            (CuiWindow *window,
                                             Background *background,
                                             CuiFilename *file,
                                             GtkTextMark *begin,
                                             GtkTextMark *end);

Creates some action areas for changing the mode of a file on the group rights string which is a three character long string (eg. "rwx").

window :

a CuiWindow containing the mode string

background :

a Background where the action area goes

file :

a CuiFile of this mode string

begin :

the start point of the string

end :

the end point of the string


cui_action_area_new_for_mode_others ()

void        cui_action_area_new_for_mode_others
                                            (CuiWindow *window,
                                             Background *background,
                                             CuiFilename *file,
                                             GtkTextMark *begin,
                                             GtkTextMark *end);

Creates some action areas for changing the mode of a file on the others rights string which is a three character long string (eg. "rwx").

window :

a CuiWindow containing the mode string

background :

a Background where the action area goes

file :

a CuiFile of this mode string

begin :

the start point of the string

end :

the end point of the string


cui_action_area_new_for_mode ()

void        cui_action_area_new_for_mode    (CuiWindow *window,
                                             Background *background,
                                             CuiFilename *file,
                                             GtkTextMark *begin,
                                             GtkTextMark *end);

Creates some action areas for changing the mode of a file on the mode string which is a ten cahracter long string with the file type (eg. "-rwxr-----"). This function also handles the + sign at the end of the mode string showing that there is at least one ACL entry for the file (eg. -rwxrw-r--+).

window :

a CuiWindow containing the mode string

background :

a Background where the action area goes

file :

a CuiFile of this mode string

begin :

the start point of the string

end :

the end point of the string


cui_action_area_redraw ()

gboolean    cui_action_area_redraw          (CuiActionArea *area,
                                             gint debug);

Emits the expose event for the widget to redraw the screen.

area :

the CuiActionArea to redraw

debug :

if this argument is not 0 the area will be highlighted

Returns :

the return value of the signal handler

Signals

The "expose" signal

gboolean    user_function                  (CuiActionArea *cuiactionarea,
                                            gint arg1,
                                            gpointer user_data);

user_data :

user data set when the signal handler was connected.

Returns :