GtranslatorPo

GtranslatorPo

Synopsis

                    GtranslatorPoPrivate;
                    GtranslatorPo;
#define             GTR_PO_ERROR
enum                GtranslatorPoState;
GQuark              gtranslator_po_error_quark          (void);
GType               gtranslator_po_register_type        (GTypeModule *module);
GtranslatorPo *     gtranslator_po_new                  (void);
void                gtranslator_po_parse                (GtranslatorPo *po,
                                                         GFile *filename,
                                                         GError **error);
void                gtranslator_po_save_header_in_msg   (GtranslatorPo *po,
                                                         GtranslatorHeader *header);
void                gtranslator_po_save_file            (GtranslatorPo *po,
                                                         GError **error);
GtranslatorPoState  gtranslator_po_get_state            (GtranslatorPo *po);
void                gtranslator_po_set_state            (GtranslatorPo *po,
                                                         GtranslatorPoState state);
GFile *             gtranslator_po_get_location         (GtranslatorPo *po);
void                gtranslator_po_set_location         (GtranslatorPo *po,
                                                         GFile *location);
gboolean            gtranslator_po_get_write_perms      (GtranslatorPo *po);
GList *             gtranslator_po_get_messages         (GtranslatorPo *po);
void                gtranslator_po_set_messages         (GtranslatorPo *po,
                                                         GList *messages);
GList *             gtranslator_po_get_current_message  (GtranslatorPo *po);
GList *             gtranslator_po_get_domains          (GtranslatorPo *po);
po_file_t           gtranslator_po_get_po_file          (GtranslatorPo *po);
GList *             gtranslator_po_get_next_fuzzy       (GtranslatorPo *po);
GList *             gtranslator_po_get_prev_fuzzy       (GtranslatorPo *po);
GList *             gtranslator_po_get_next_untrans     (GtranslatorPo *po);
GList *             gtranslator_po_get_prev_untrans     (GtranslatorPo *po);
GList *             gtranslator_po_get_next_fuzzy_or_untrans
                                                        (GtranslatorPo *po);
GList *             gtranslator_po_get_prev_fuzzy_or_untrans
                                                        (GtranslatorPo *po);
GList *             gtranslator_po_get_msg_from_number  (GtranslatorPo *po,
                                                         gint number);
GtranslatorHeader * gtranslator_po_get_header           (GtranslatorPo *po);
void                gtranslator_po_set_header           (GtranslatorPo *po,
                                                         GtranslatorHeader *header);
gint                gtranslator_po_get_translated_count (GtranslatorPo *po);
gint                gtranslator_po_get_fuzzy_count      (GtranslatorPo *po);
gint                gtranslator_po_get_untranslated_count
                                                        (GtranslatorPo *po);
gint                gtranslator_po_get_messages_count   (GtranslatorPo *po);
gint                gtranslator_po_get_message_position (GtranslatorPo *po);
gchar *             gtranslator_po_check_po_file        (GtranslatorPo *po);
void                _gtranslator_po_increase_decrease_translated
                                                        (GtranslatorPo *po,
                                                         gboolean increase);

Description

Details

GtranslatorPoPrivate

typedef struct _GtranslatorPoPrivate GtranslatorPoPrivate;


GtranslatorPo

typedef struct {
  GObject parent_instance;
} GtranslatorPo;


GTR_PO_ERROR

#define GTR_PO_ERROR gtranslator_po_error_quark()


enum GtranslatorPoState

typedef enum
{
  GTR_PO_STATE_SAVED,
  GTR_PO_STATE_MODIFIED
} GtranslatorPoState;


gtranslator_po_error_quark ()

GQuark              gtranslator_po_error_quark          (void);

Returns :


gtranslator_po_register_type ()

GType               gtranslator_po_register_type        (GTypeModule *module);

module :

Returns :


gtranslator_po_new ()

GtranslatorPo *     gtranslator_po_new                  (void);

Creates a new GtranslatorPo.

Returns :

a new GtranslatorPo object

gtranslator_po_parse ()

void                gtranslator_po_parse                (GtranslatorPo *po,
                                                         GFile *filename,
                                                         GError **error);

Parses all things related to the GtranslatorPo and initilizes all neccessary variables.

po :

a GtranslatorPo

filename :

error :

a variable to store the errors

gtranslator_po_save_header_in_msg ()

void                gtranslator_po_save_header_in_msg   (GtranslatorPo *po,
                                                         GtranslatorHeader *header);

It saves the header's values into the msgstr

po :

a GtranslatorPo

header :


gtranslator_po_save_file ()

void                gtranslator_po_save_file            (GtranslatorPo *po,
                                                         GError **error);

It saves the po file and if there are any problem it stores the error in error.

po :

a GtranslatorPo

error :

a GError to manage the exceptions

gtranslator_po_get_state ()

GtranslatorPoState  gtranslator_po_get_state            (GtranslatorPo *po);

po :

a GtranslatorPo

Returns :

the GtranslatorPoState value of the po.

gtranslator_po_set_state ()

void                gtranslator_po_set_state            (GtranslatorPo *po,
                                                         GtranslatorPoState state);

Sets the state for a GtranslatorPo

po :

a GtranslatorPo

state :

a GtranslatorPoState

gtranslator_po_get_location ()

GFile *             gtranslator_po_get_location         (GtranslatorPo *po);

po :

Returns :


gtranslator_po_set_location ()

void                gtranslator_po_set_location         (GtranslatorPo *po,
                                                         GFile *location);

Sets the GFile location within the GtranslatorPo object.

po :

a GtranslatorPo

location :

The GFile to set to the GtranslatorPo

gtranslator_po_get_write_perms ()

gboolean            gtranslator_po_get_write_perms      (GtranslatorPo *po);

po :

Returns :


gtranslator_po_get_messages ()

GList *             gtranslator_po_get_messages         (GtranslatorPo *po);

po :

a GtranslatorPo

Returns :

a pointer to the messages list

gtranslator_po_set_messages ()

void                gtranslator_po_set_messages         (GtranslatorPo *po,
                                                         GList *messages);

Sets an updated list of messages.

po :

a GtranslatorPo

messages :

a pointer to a new messages list.

gtranslator_po_get_current_message ()

GList *             gtranslator_po_get_current_message  (GtranslatorPo *po);

po :

a GtranslatorPo

Returns :

a pointer to the current message

gtranslator_po_get_domains ()

GList *             gtranslator_po_get_domains          (GtranslatorPo *po);

po :

a GtranslatorPo

Returns :

a pointer to the domains list

gtranslator_po_get_po_file ()

po_file_t           gtranslator_po_get_po_file          (GtranslatorPo *po);

po :

a GtranslatorPo

Returns :

the gettext file

gtranslator_po_get_next_fuzzy ()

GList *             gtranslator_po_get_next_fuzzy       (GtranslatorPo *po);

po :

a GtranslatorPo

Returns :

a pointer to the next fuzzy message

gtranslator_po_get_prev_fuzzy ()

GList *             gtranslator_po_get_prev_fuzzy       (GtranslatorPo *po);

po :

a GtranslatorPo

Returns :

a pointer to the previously fuzzy message

gtranslator_po_get_next_untrans ()

GList *             gtranslator_po_get_next_untrans     (GtranslatorPo *po);

po :

a GtranslatorPo

Returns :

a pointer to the next untranslated message

gtranslator_po_get_prev_untrans ()

GList *             gtranslator_po_get_prev_untrans     (GtranslatorPo *po);

po :

a GtranslatorPo

Returns :

a pointer to the previously untranslated message or NULL if there are not previously untranslated message.

gtranslator_po_get_next_fuzzy_or_untrans ()

GList *             gtranslator_po_get_next_fuzzy_or_untrans
                                                        (GtranslatorPo *po);

po :

a GtranslatorPo

Returns :

a pointer to the next fuzzy or untranslated message or NULL if there is not next fuzzy or untranslated message.

gtranslator_po_get_prev_fuzzy_or_untrans ()

GList *             gtranslator_po_get_prev_fuzzy_or_untrans
                                                        (GtranslatorPo *po);

po :

a GtranslatorPo

Returns :

a pointer to the previously fuzzy or untranslated message or NULL if there is not previously fuzzy or untranslated message.

gtranslator_po_get_msg_from_number ()

GList *             gtranslator_po_get_msg_from_number  (GtranslatorPo *po,
                                                         gint number);

Gets the message at the given position.

po :

a GtranslatorPo

number :

the message to jump

Returns :


gtranslator_po_get_header ()

GtranslatorHeader * gtranslator_po_get_header           (GtranslatorPo *po);

po :

a GtranslatorPo

Returns :

The GtranslatorHeader of the po.

gtranslator_po_set_header ()

void                gtranslator_po_set_header           (GtranslatorPo *po,
                                                         GtranslatorHeader *header);

po :

header :


gtranslator_po_get_translated_count ()

gint                gtranslator_po_get_translated_count (GtranslatorPo *po);

po :

a GtranslatorPo

Returns :

the count of the translated messages.

gtranslator_po_get_fuzzy_count ()

gint                gtranslator_po_get_fuzzy_count      (GtranslatorPo *po);

po :

a GtranslatorPo

Returns :

the count of the fuzzy messages.

gtranslator_po_get_untranslated_count ()

gint                gtranslator_po_get_untranslated_count
                                                        (GtranslatorPo *po);

po :

a GtranslatorPo

Returns :

the count of the untranslated messages.

gtranslator_po_get_messages_count ()

gint                gtranslator_po_get_messages_count   (GtranslatorPo *po);

po :

a GtranslatorPo

Returns :

the number of messages messages.

gtranslator_po_get_message_position ()

gint                gtranslator_po_get_message_position (GtranslatorPo *po);

po :

a GtranslatorPo

Returns :

the number of the current message.

gtranslator_po_check_po_file ()

gchar *             gtranslator_po_check_po_file        (GtranslatorPo *po);

Test whether an entire PO file is valid, like msgfmt does it.

po :

a GtranslatorPo

Returns :

If it is invalid, returns the error. The return value must be freed with g_free.

_gtranslator_po_increase_decrease_translated ()

void                _gtranslator_po_increase_decrease_translated
                                                        (GtranslatorPo *po,
                                                         gboolean increase);

po :

increase :