Presentation

Presentation — A whole presentation, including slide, themes etc.

Synopsis




struct      CriaPresentation;
struct      CriaPresentationClass;
struct      CriaPresentationPrivate;
void        cria_presentation_add_theme     (CriaPresentation *self,
                                             CriaTheme *theme);
void        cria_presentation_append_slide  (CriaPresentation *self,
                                             CriaSlide *slide);
const gchar* cria_presentation_get_filename (CriaPresentation *self);
CriaSlide*  cria_presentation_get_slide     (CriaPresentation *self,
                                             guint index);
const GoPoint* cria_presentation_get_slide_size
                                            (CriaPresentation *self);
CriaTheme*  cria_presentation_get_theme     (CriaPresentation *self,
                                             const char *theme);
const gchar* cria_presentation_get_title    (CriaPresentation *self);
guint       cria_presentation_n_slides      (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);
gint        cria_presentation_get_slide_index
                                            (CriaPresentation *self,
                                             CriaSlide const	*slide);
const GnomeVFSURI* cria_presentation_get_uri
                                            (CriaPresentation *self);

Object Hierarchy


  GObject
   +----CriaPresentation

Properties


  "title"                gchararray           : Read / Write / Construct
  "uri"                  gpointer             : Read / Write / Construct

Description

Details

struct CriaPresentation

struct CriaPresentation;


struct CriaPresentationClass

struct CriaPresentationClass {

	GObjectClass	  base_class;

	/* signals */
	/*void (*signal)	       (CriaPresentation	* self,
				const	gchar	* string);*/
};


struct CriaPresentationPrivate

struct CriaPresentationPrivate;


cria_presentation_add_theme ()

void        cria_presentation_add_theme     (CriaPresentation *self,
                                             CriaTheme *theme);

Adds the theme to presentation references by self.

self : a CriaPresentation
theme : a CriaTheme

cria_presentation_append_slide ()

void        cria_presentation_append_slide  (CriaPresentation *self,
                                             CriaSlide *slide);

self :
slide :

cria_presentation_get_filename ()

const gchar* cria_presentation_get_filename (CriaPresentation *self);

...

self : ...
Returns :...

cria_presentation_get_slide ()

CriaSlide*  cria_presentation_get_slide     (CriaPresentation *self,
                                             guint index);

self :
index :
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,
                                             const char *theme);

self :
theme :
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, NULL otherwise

cria_presentation_n_slides ()

guint       cria_presentation_n_slides      (CriaPresentation *self);

self :
Returns :

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_slide_index ()

gint        cria_presentation_get_slide_index
                                            (CriaPresentation *self,
                                             CriaSlide const	*slide);

Get the index of a slide in a presentation.

self : The presentation to search in
slide : The slide to be found
Returns :the index of the slide if found, -1 otherwise

cria_presentation_get_uri ()

const 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

Properties

"title" (gchararray : Read / Write / Construct)

The title of the presentation.

"uri" (gpointer : Read / Write / Construct)

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