CriaPresentation

CriaPresentation —

Synopsis




            CriaPresentation;
            CriaPresentationClass;
gchar*      cria_presentation_get_filename  (CriaPresentation *self);
const GOPoint* cria_presentation_get_slide_size
                                            (CriaPresentation *self);
CriaTheme*  cria_presentation_get_theme     (CriaPresentation *self);
const gchar* cria_presentation_get_title    (CriaPresentation *self);
CriaPresentation* cria_presentation_new_from_file
                                            (const gchar *filename,
                                             GError **error);
void        cria_presentation_set_title     (CriaPresentation *self,
                                             const char *title);
void        cria_presentation_set_uri       (CriaPresentation *self,
                                             GnomeVFSURI *uri);
CriaPresentation* cria_presentation_new_default
                                            (void);
CriaPresentation* cria_presentation_new_from_text_uri
                                            (const gchar *text_uri,
                                             GError **error);
GnomeVFSURI* cria_presentation_get_uri      (CriaPresentation *self);

Object Hierarchy


  GObject
   +----CriaPresentation

Implemented Interfaces

CriaPresentation implements CriaSlideList.

Properties


  "auto-switch"          gboolean              : Read / Write / Construct
  "loop"                 gboolean              : Read / Write / Construct
  "slide-delay"          gdouble               : Read / Write / Construct
  "theme"                CriaTheme             : Read / Write
  "title"                gchararray            : Read / Write / Construct
  "uri"                  gpointer              : Read / Write / Construct

Signals


"inserted-slide"
            void        user_function      (CriaPresentation *criapresentation,
                                            gint              arg1,
                                            CriaSlide        *arg2,
                                            gpointer          user_data)             : Run last
"slide-deleted"
            void        user_function      (CriaPresentation *criapresentation,
                                            gint              arg1,
                                            gpointer          user_data)             : Run last

Description

Details

CriaPresentation

typedef struct _CriaPresentation CriaPresentation;


CriaPresentationClass

typedef struct {
	GObjectClass	  base_class;

	/* signals */
	void (*slide_deleted)          (CriaPresentation* self,
					gint		  old_position);
	void (*inserted_slide)	       (CriaPresentation* self,
					gint		  new_position,
					CriaSlide	* new_slide);
} CriaPresentationClass;


cria_presentation_get_filename ()

gchar*      cria_presentation_get_filename  (CriaPresentation *self);

self :
Returns :

cria_presentation_get_slide_size ()

const GOPoint* cria_presentation_get_slide_size
                                            (CriaPresentation *self);

Get the slide size for this presentation (in Master Coordinates, 576dpi). Don't free it, it's internal data from the presentation.

self : The presentation to query
Returns : the size of a slide

cria_presentation_get_theme ()

CriaTheme*  cria_presentation_get_theme     (CriaPresentation *self);

self :
Returns :

cria_presentation_get_title ()

const gchar* cria_presentation_get_title    (CriaPresentation *self);

Get the title of the presentation.

self : The presentation to get the title from
Returns : the title of the presentation, of one is set, an empty string otherwise.

cria_presentation_new_from_file ()

CriaPresentation* cria_presentation_new_from_file
                                            (const gchar *filename,
                                             GError **error);

Creates a new presentation by parsing a file. filename needs to be given relative to the working directory. This function is used only for parsing command line arguments.

filename : the name of the file to open
error : a location to return a GError, if this is
Returns : the new presentation or NULL if an error occured

cria_presentation_set_title ()

void        cria_presentation_set_title     (CriaPresentation *self,
                                             const char *title);

Sets a new title for the presentation. The title is only changed if both titles are different, so we prevent recursive loops with title entry elements.

self : the presentation to set the title for
title : the new title for the presentation

cria_presentation_set_uri ()

void        cria_presentation_set_uri       (CriaPresentation *self,
                                             GnomeVFSURI *uri);

self :
uri :

cria_presentation_new_default ()

CriaPresentation* cria_presentation_new_default
                                            (void);

Creates a simple untitled presentation containing one empty slide.

Returns : a new presentation

cria_presentation_new_from_text_uri ()

CriaPresentation* cria_presentation_new_from_text_uri
                                            (const gchar *text_uri,
                                             GError **error);

Create a new presentation by parsing the file given by the text_uri.

text_uri : the text representation of a URI, e.g. ftp://userhost/path/to/file.ext
error : a pointer to return a GError
Returns : a new presentation

cria_presentation_get_uri ()

GnomeVFSURI* cria_presentation_get_uri      (CriaPresentation *self);

Get information about the path of a presentation.

self : the presentation to get the uri from
Returns : a GnomeVFSURI defining the path and filename of a presentation, NULL if none is set. If you want to use it, don't forget to gnome_vfs_uri_ref()

Property Details

The "auto-switch" property

  "auto-switch"          gboolean              : Read / Write / Construct

Specifies whether this presentation should automatically switch between slides.

Default value: FALSE


The "loop" property

  "loop"                 gboolean              : Read / Write / Construct

Restart presentation after the last slide.

Default value: FALSE


The "slide-delay" property

  "slide-delay"          gdouble               : Read / Write / Construct

The time that a slide is shown in auto-switch mode by default (in seconds).

Allowed values: >= 0

Default value: 5


The "theme" property

  "theme"                CriaTheme             : Read / Write

Theme.


The "title" property

  "title"                gchararray            : Read / Write / Construct

The title of the presentation.

Default value: "untitled"


The "uri" property

  "uri"                  gpointer              : Read / Write / Construct

The URI this file can be located at, NULL if newly created.

Signal Details

The "inserted-slide" signal

void        user_function                  (CriaPresentation *criapresentation,
                                            gint              arg1,
                                            CriaSlide        *arg2,
                                            gpointer          user_data)             : Run last

criapresentation : the object which received the signal.
arg1 :
arg2 :
user_data : user data set when the signal handler was connected.

The "slide-deleted" signal

void        user_function                  (CriaPresentation *criapresentation,
                                            gint              arg1,
                                            gpointer          user_data)             : Run last

criapresentation : the object which received the signal.
arg1 :
user_data : user data set when the signal handler was connected.