ListallerMessageObject

ListallerMessageObject — Class providing basic message handling

Synopsis

#define             LISTALLER_TYPE_MESSAGE_OBJECT
void                listaller_message_object_set_error_hint_str
                                                        (ListallerMessageObject *self,
                                                         const gchar *str);
void                listaller_message_object_connect_with_object
                                                        (ListallerMessageObject *self,
                                                         ListallerMessageObject *other_obj,
                                                         ListallerObjConnectFlags flags);
void                listaller_message_object_connect_with_object_all
                                                        (ListallerMessageObject *self,
                                                         ListallerMessageObject *other_obj);
struct              ListallerMessageObject;
struct              ListallerMessageObjectClass;
enum                ListallerObjConnectFlags;

Object Hierarchy

  GObject
   +----ListallerMessageObject
         +----ListallerKeyManager
         +----ListallerManager
         +----ListallerSetup
         +----ListallerUpdater
  GEnum
   +----ListallerObjConnectFlags

Signals

  "error-code"                                     : Run Last
  "message"                                        : Run Last
  "progress"                                       : Run Last

Description

Base class for all Listaller classes which want to send messages to each other. (Used e.g. for GUI stuff and in the public API)

Details

LISTALLER_TYPE_MESSAGE_OBJECT

#define LISTALLER_TYPE_MESSAGE_OBJECT (listaller_message_object_get_type ())

The type for ListallerMessageObject.


listaller_message_object_set_error_hint_str ()

void                listaller_message_object_set_error_hint_str
                                                        (ListallerMessageObject *self,
                                                         const gchar *str);

self :

the ListallerMessageObject instance

str :

 

listaller_message_object_connect_with_object ()

void                listaller_message_object_connect_with_object
                                                        (ListallerMessageObject *self,
                                                         ListallerMessageObject *other_obj,
                                                         ListallerObjConnectFlags flags);

self :

the ListallerMessageObject instance

other_obj :

 

flags :

 

listaller_message_object_connect_with_object_all ()

void                listaller_message_object_connect_with_object_all
                                                        (ListallerMessageObject *self,
                                                         ListallerMessageObject *other_obj);

self :

the ListallerMessageObject instance

other_obj :

 

struct ListallerMessageObject

struct ListallerMessageObject;

Class providing basic message handling

Base class for all Listaller classes which want to send messages to each other. (Used e.g. for GUI stuff and in the public API)


struct ListallerMessageObjectClass

struct ListallerMessageObjectClass {
	GObjectClass parent_class;
	void (*emit_message) (ListallerMessageObject* self, const gchar* msg);
	void (*emit_warning) (ListallerMessageObject* self, const gchar* msg);
	void (*emit_error) (ListallerMessageObject* self, ListallerErrorEnum id, const gchar* details);
	void (*change_progress) (ListallerMessageObject* self, gint prog_value);
	void (*change_item_progress) (ListallerMessageObject* self, const gchar* id, guint item_progress);
};

The class structure for LISTALLER_TYPE_MESSAGE_OBJECT. All the fields in this structure are private and should never be accessed directly.

GObjectClass parent_class;

the parent class structure

emit_message ()

emit_warning ()

emit_error ()

change_progress ()

change_item_progress ()


enum ListallerObjConnectFlags

typedef enum {
	LISTALLER_OBJ_CONNECT_FLAGS_NONE,
	LISTALLER_OBJ_CONNECT_FLAGS_PROGRESS_TO_SUBPROGRESS,
	LISTALLER_OBJ_CONNECT_FLAGS_IGNORE_PROGRESS,
	LISTALLER_OBJ_CONNECT_FLAGS_IGNORE_ERROR_CODE
} ListallerObjConnectFlags;

Signal Details

The "error-code" signal

void                user_function                      (ListallerMessageObject *message_object,
                                                        ListallerErrorItem     *error,
                                                        gpointer                user_data)           : Run Last

message_object :

the ListallerMessageObject instance that received the signal

error :

 

user_data :

user data set when the signal handler was connected.

The "message" signal

void                user_function                      (ListallerMessageObject *message_object,
                                                        ListallerMessageItem   *message,
                                                        gpointer                user_data)           : Run Last

message_object :

the ListallerMessageObject instance that received the signal

message :

 

user_data :

user data set when the signal handler was connected.

The "progress" signal

void                user_function                      (ListallerMessageObject *message_object,
                                                        ListallerProgressItem  *prog,
                                                        gpointer                user_data)           : Run Last

message_object :

the ListallerMessageObject instance that received the signal

prog :

 

user_data :

user data set when the signal handler was connected.