PrevUpHomeCuiterm Reference ManualNext

CuiPixmap

Name

CuiPixmap -- 

Synopsis


#include <history.h>


            CuiPixmap;
CuiWidget*  cui_pixmap_new_empty            (void);
CuiWidget*  cui_pixmap_new_from_package_file
                                            (const gchar *filename);
CuiWidget*  cui_pixmap_new_thumbnail        (CuiFilename *file);
void        cui_pixmap_set_xy               (CuiPixmap *cui_pixmap,
                                             gint x,
                                             gint y);
gboolean    cui_pixmap_redraw               (CuiPixmap *pixmap,
                                             gint debug);

Object Hierarchy


  GObject
   +----CuiWidget
         +----CuiPixmap

Signal Prototypes


"expose"    gboolean    user_function      (CuiPixmap *cuipixmap,
                                            gint arg1,
                                            gpointer user_data);

Description

Details

CuiPixmap

typedef struct _CuiPixmap CuiPixmap;

A widget capaple of showing icons and other graphical elements on the CUI area.

cui_pixmap_new_empty ()

CuiWidget*  cui_pixmap_new_empty            (void);

Returns :

a new emty CuiPixmap

cui_pixmap_new_from_package_file ()

CuiWidget*  cui_pixmap_new_from_package_file
                                            (const gchar *filename);

Creates a new CuiPixmap loading pixel and size information from a file. This function searches the graphic file in the application pixmap directory.

filename :

the name of the file containing pixel information

Returns :

a new CuiPixmap

cui_pixmap_new_thumbnail ()

CuiWidget*  cui_pixmap_new_thumbnail        (CuiFilename *file);

Creates a thumbnail for the given file. The thumbnail will represent the content of the given file if the file is local and can be opened for read. FIXME: This function must be completed.

file :

we create the thumbnail for this file

Returns :

a new pixmap as a widget

cui_pixmap_set_xy ()

void        cui_pixmap_set_xy               (CuiPixmap *cui_pixmap,
                                             gint x,
                                             gint y);

Sets the place where the pixmap will appear without tampering with the size of the widget.

cui_pixmap :

a CuiPixmap to set the coordinates for

x :

the new x coordinate

y :

the new y coordinate

cui_pixmap_redraw ()

gboolean    cui_pixmap_redraw               (CuiPixmap *pixmap,
                                             gint debug);

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

pixmap :

the CuiPixmap 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                  (CuiPixmap *cuipixmap,
                                            gint arg1,
                                            gpointer user_data);

user_data :

user data set when the signal handler was connected.

Returns :

<<< CuiActionAreaCuiEntry >>>