gok-feedback

## gok-feedback gok-feedback |

## Synopsis

    GokFeedback *       gok_feedback_new                    (void);
    void                gok_feedback_free                   (GokFeedback *pFeedback);
    gboolean            gok_feedback_open                   (void);
    void                gok_feedback_close                  (void);
    GokFeedback *       gok_feedback_get_first_feedback     (void);
    GokFeedback *       gok_feedback_find_feedback          (gchar *NameFeedback,
                                                             gboolean bDisplayName);
    void                gok_feedback_add_feedback           (GokFeedback *pFeedbackNew);
    void                gok_feedback_delete_feedback        (GokFeedback *pFeedbackDelete);
    void                gok_feedback_backup                 (GokFeedback *pFeedback);
    gboolean            gok_feedback_revert                 (GokFeedback *pFeedback);

## Description

## Details

### gok_feedback_new ()

    GokFeedback *       gok_feedback_new                    (void);

Allocates memory for a new GokFeedback and initializes its attributes to default values. Please free the returned GokFeedback using gok_feedback_free.

Returns : | A pointer to a new GokFeedback.

### gok_feedback_free ()

    void                gok_feedback_free                   (GokFeedback *pFeedback);

Frees a GokFeedback and associated resources.

`pFeedback` : | Pointer to the feedback that will be freed.

### gok_feedback_open ()

    gboolean            gok_feedback_open                   (void);

Initializes the gok feedbacks and reads them from GConf.

Returns : | TRUE if the feedbacks were initialized, FALSE if not.

### gok_feedback_close ()

    void                gok_feedback_close                  (void);

Closes the gok feedbacks and saves them in GConf.

### gok_feedback_get_first_feedback ()

    GokFeedback *       gok_feedback_get_first_feedback     (void);

Returns : | A pointer to the first feedback in the list of feedbacks.

### gok_feedback_find_feedback ()

    GokFeedback *       gok_feedback_find_feedback          (gchar *NameFeedback,
                                                             gboolean bDisplayName);

Finds the feedback from within our list of feedbacks.

`NameFeedback` : | Name of the feedback you're trying to find.
`bDisplayName` : | This should be set TRUE if you are passing in the display name of the feedback. It should be set FALSE if passing in the actual name of the feedback.
Returns : | A pointer to the feedback, NULL if not found.

### gok_feedback_add_feedback ()

    void                gok_feedback_add_feedback           (GokFeedback *pFeedbackNew);

Adds a new feedback to our list of feedbacks.

`pFeedbackNew` : | Pointer to an feedback that gets added to our list of feedbacks.

### gok_feedback_delete_feedback ()

    void                gok_feedback_delete_feedback        (GokFeedback *pFeedbackDelete);

Deletes the given feedback and unhooks it from our list of feedbacks.

`pFeedbackDelete` : | Pointer to the feedback that will be deleted.

### gok_feedback_backup ()

    void                gok_feedback_backup                 (GokFeedback *pFeedback);

Creates a copy of all the data stored on the feedback.

`pFeedback` : | Pointer to the feedback that will be backed up.

### gok_feedback_revert ()

    gboolean            gok_feedback_revert                 (GokFeedback *pFeedback);

Moves the backup data to the current data on the feedback.

`pFeedback` : | Pointer to the feedback that will be reverted.
Returns : | TRUE if any of the reverted settings are different from the current settings. Returns FALSE if the reverted settings are the same as the current settings.