Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages

GTaskFile


Data Structures

struct  _GTaskFile
struct  _GTaskFileClass
struct  _GTaskFilePrivate

Defines

#define GTASK_FILE_TYPE   (gtask_file_get_type())
#define GTASK_FILE(obj)
#define GTASK_FILE_CLASS(klass)
#define GTASK_IS_FILE(obj)
#define GTASK_IS_FILE_CLASS(klass)
#define GTASK_FILE_GET_CLASS(obj)

Typedefs

typedef _GTaskFile GTaskFile
typedef _GTaskFilePrivate GTaskFilePrivate
typedef _GTaskFileClass GTaskFileClass

Enumerations

enum  {
  C_PROP_0, C_PROP_URI, C_PROP_MIME_TYPE, C_PROP_THUMBNAIL_URI,
  C_PROP_DESCRIPTION, C_PROP_COMPLETED
}

Functions

void gtask_file_class_init (GTaskFileClass *klass)
void gtask_file_init (GTaskFile *gtask)
void gtask_file_finalize (GObject *obj)
void gtask_file_set_property (GObject *object, guint param_id, const GValue *value, GParamSpec *pspec)
void gtask_file_get_property (GObject *object, guint param_id, GValue *value, GParamSpec *pspec)
GType gtask_file_get_type ()
GTaskFile * gtask_file_new ()
 creates a new GTaskFile

GTaskFile * gtask_file_new_with_properties (const char *uri, const char *mime_type, const char *thumbnail_uri, const char *description)
 creates a new GTaskFile with some happy properties.

void gtask_file_set_uri (GTaskFile *file, const char *uri)
 Sets the uri of the GTaskFile.

const char * gtask_file_get_uri (GTaskFile *file)
 Gets the uri of the GTaskFile.

void gtask_file_set_thumbnail_uri (GTaskFile *file, const char *thumbnail_uri)
 Sets the thumbnail uri of the GTaskFile.

const char * gtask_file_get_thumbnail_uri (GTaskFile *file)
 Gets the thumbnail uri of the GTaskFile.

void gtask_file_set_mime_type (GTaskFile *file, const char *mime_type)
 Sets the mime type of the GTaskFile.

const char * gtask_file_get_mime_type (GTaskFile *file)
 Gets the mime type of the GTaskFile.

void gtask_file_set_description (GTaskFile *file, const char *description)
 Sets the description of the GTaskFile. This should generally be a short title, no lengthy orations please.

const char * gtask_file_get_description (GTaskFile *file)
 Gets the description of the GTaskFile.

void gtask_file_set_completed (GTaskFile *file, gboolean completed)
 Sets whether or not the GTaskFile is completed.

gboolean gtask_file_get_completed (GTaskFile *file)
 Gets whether or not the GTaskFile is completed.


Variables

gpointer parent_class

Define Documentation

#define GTASK_FILE (  obj   ) 
 

Value:

(G_TYPE_CHECK_INSTANCE_CAST( (obj), \
                                            GTASK_FILE_TYPE, \
                                            GTaskFile))
casts the passed in object to a GTaskFile

Definition at line 19 of file gtask-file.h.

#define GTASK_FILE_CLASS (  klass   ) 
 

Value:

(G_TYPE_CHECK_CLASS_CAST( (klass), \
                                            GTASK_FILE_TYPE, \
                                            GTaskFileClass ))
casts the passed in object to a GTaskFileClass

Definition at line 24 of file gtask-file.h.

#define GTASK_FILE_GET_CLASS (  obj   ) 
 

Value:

(G_TYPE_INSTANCE_GET_CLASS( (obj), \
                                            GTASK_FILE_TYPE, \
                                            GTaskGenericClass ))

Definition at line 42 of file gtask-file.h.

#define GTASK_FILE_TYPE   (gtask_file_get_type())
 

returns a GType of GTaskFile

Definition at line 16 of file gtask-file.h.

#define GTASK_IS_FILE (  obj   ) 
 

Value:

(G_TYPE_CHECK_INSTANCE_TYPE( (obj), \
                                            GTASK_FILE_TYPE ))
returns TRUE if the passed in object is a GTaskFile, FALSE otherwise

Definition at line 32 of file gtask-file.h.

#define GTASK_IS_FILE_CLASS (  klass   ) 
 

Value:

(G_TYPE_CHECK_CLASS_TYPE( (klass), \
                                            GTASK_FILE_TYPE ))
returns TRUE if the passed in object is a GTaskFileClass, FALSE otherwise

Definition at line 39 of file gtask-file.h.

Typedef Documentation

typedef struct _GTaskFile GTaskFile
 

Definition at line 11 of file gtask-file.h.

typedef struct _GTaskFileClass GTaskFileClass
 

Definition at line 13 of file gtask-file.h.

typedef struct _GTaskFilePrivate GTaskFilePrivate
 

Definition at line 12 of file gtask-file.h.

Enumeration Type Documentation

anonymous enum
 

Enumeration values:
C_PROP_0 
C_PROP_URI 
C_PROP_MIME_TYPE 
C_PROP_THUMBNAIL_URI 
C_PROP_DESCRIPTION 
C_PROP_COMPLETED 

Definition at line 9 of file gtask-file.c.

Function Documentation

void gtask_file_class_init (  GTaskFileClass *  klass  )  [static]
 

Definition at line 81 of file gtask-file.c.

void gtask_file_finalize (  GObject *  obj  )  [static]
 

Definition at line 133 of file gtask-file.c.

gboolean gtask_file_get_completed (  GTaskFile *  file  ) 
 

Gets whether or not the GTaskFile is completed.

Parameters:
file a GTaskFile
Returns:
hether or not the file is completed

Definition at line 403 of file gtask-file.c.

const char * gtask_file_get_description (  GTaskFile *  file  ) 
 

Gets the description of the GTaskFile.

Attention:
The returned string should be considered read only.
Parameters:
file a GTaskFile
Returns:
the description

Definition at line 374 of file gtask-file.c.

const char * gtask_file_get_mime_type (  GTaskFile *  file  ) 
 

Gets the mime type of the GTaskFile.

Attention:
The returned string should be considered read only.
Parameters:
file a GTaskFile
Returns:
the mime type

Definition at line 341 of file gtask-file.c.

void gtask_file_get_property (  GObject *  object,
guint  param_id,
GValue *  value,
GParamSpec *  pspec
)  [static]
 

Definition at line 181 of file gtask-file.c.

const char * gtask_file_get_thumbnail_uri (  GTaskFile *  file  ) 
 

Gets the thumbnail uri of the GTaskFile.

Attention:
The returned string should be considered read only.
Parameters:
file a GTaskFile
Returns:
the thumbnail uri

Definition at line 309 of file gtask-file.c.

GType gtask_file_get_type (  void   ) 
 

Definition at line 42 of file gtask-file.c.

const char * gtask_file_get_uri (  GTaskFile *  file  ) 
 

Gets the uri of the GTaskFile.

Attention:
The returned string should be considered read only
Parameters:
file a GTaskFile
Returns:
the uri of the file

Definition at line 277 of file gtask-file.c.

void gtask_file_init (  GTaskFile *  gtask  )  [static]
 

Definition at line 68 of file gtask-file.c.

GTaskFile * gtask_file_new (  void   ) 
 

creates a new GTaskFile

Author:
Michael Henson
Returns:
the new GTaskFile

Definition at line 219 of file gtask-file.c.

GTaskFile * gtask_file_new_with_properties (  const char *  uri,
const char *  mime_type,
const char *  thumbnail_uri,
const char *  description
) 
 

creates a new GTaskFile with some happy properties.

Author:
Michael Henson
Parameters:
uri the URI of the file
mime_type the mime type of the file
thumbnail_uri the optional thumbnail uri of the file
description a human readable name for the file
Returns:
the new GTaskFile

Definition at line 236 of file gtask-file.c.

void gtask_file_set_completed (  GTaskFile *  file,
gboolean  completed
) 
 

Sets whether or not the GTaskFile is completed.

Parameters:
file a GTaskFile
completed whether or not the file is completed

Definition at line 387 of file gtask-file.c.

void gtask_file_set_description (  GTaskFile *  file,
const char *  description
) 
 

Sets the description of the GTaskFile. This should generally be a short title, no lengthy orations please.

Parameters:
file a GTaskFile
description the description

Definition at line 355 of file gtask-file.c.

void gtask_file_set_mime_type (  GTaskFile *  file,
const char *  mime_type
) 
 

Sets the mime type of the GTaskFile.

Parameters:
file a GTaskFile
mime_type the mime type of the file

Definition at line 322 of file gtask-file.c.

void gtask_file_set_property (  GObject *  object,
guint  param_id,
const GValue *  value,
GParamSpec *  pspec
)  [static]
 

Definition at line 152 of file gtask-file.c.

void gtask_file_set_thumbnail_uri (  GTaskFile *  file,
const char *  thumbnail_uri
) 
 

Sets the thumbnail uri of the GTaskFile.

Parameters:
file a GTaskFile
thumbnail_uri the uri of the thumbnail

Definition at line 290 of file gtask-file.c.

void gtask_file_set_uri (  GTaskFile *  file,
const char *  uri
) 
 

Sets the uri of the GTaskFile.

Parameters:
file a GTaskFile
uri the uri of the file

Definition at line 258 of file gtask-file.c.

Variable Documentation

gpointer parent_class [static]
 

Definition at line 18 of file gtask-file.c.

Generated on Mon Feb 2 21:26:17 2004 for libgtask by doxygen 1.3.4