path: root/shell/e-folder.c

/* -*- Mode: C; indent-tabs-mode: t; c-basic-offset: 8; tab-width: 8 -*- */
/* e-folder.c
 *
 * Copyright (C) 2000  Helix Code, Inc.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public
 * License along with this program; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * Author: Ettore Perazzoli
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <gtk/gtksignal.h>

#include <gal/util/e-util.h>

#include "e-folder.h"


#define PARENT_TYPE GTK_TYPE_OBJECT
static GtkObjectClass *parent_class = NULL;

struct _EFolderPrivate {
    char *name;
    char *type;
    char *description;
    char *physical_uri;
    gboolean self_highlight;
    int child_highlight;
};

#define EF_CLASS(obj) \
    E_FOLDER_CLASS (GTK_OBJECT (obj)->klass)


enum {
    CHANGED,
    LAST_SIGNAL
};

static guint signals[LAST_SIGNAL] = { 0 };


/* EFolder methods.  */

static gboolean
save_info (EFolder *folder)
{
    g_warning ("`%s' does not implement `EFolder::save_info()'",
           gtk_type_name (GTK_OBJECT_TYPE (folder)));
    return FALSE;
}

static gboolean
load_info (EFolder *folder)
{
    g_warning ("`%s' does not implement `EFolder::load_info()'",
           gtk_type_name (GTK_OBJECT_TYPE (folder)));
    return FALSE;
}

static gboolean
remove (EFolder *folder)
{
    g_warning ("`%s' does not implement `EFolder::remove()'",
           gtk_type_name (GTK_OBJECT_TYPE (folder)));
    return FALSE;
}

static const char *
get_physical_uri (EFolder *folder)
{
    return folder->priv->physical_uri;
}


/* GtkObject methods.  */

static void
destroy (GtkObject *object)
{
    EFolder *folder;
    EFolderPrivate *priv;

    folder = E_FOLDER (object);
    priv = folder->priv;

    g_free (priv->name);
    g_free (priv->type);
    g_free (priv->description);
    g_free (priv->physical_uri);

    g_free (priv);

    (* GTK_OBJECT_CLASS (parent_class)->destroy) (object);
}


static void
class_init (EFolderClass *klass)
{
    GtkObjectClass *object_class;

    parent_class = gtk_type_class (gtk_object_get_type ());

    object_class = GTK_OBJECT_CLASS (klass);
    object_class->destroy = destroy;

    signals[CHANGED] = gtk_signal_new ("changed",
                       GTK_RUN_FIRST,
                       object_class->type,
                       GTK_SIGNAL_OFFSET (EFolderClass, changed),
                       gtk_marshal_NONE__NONE,
                       GTK_TYPE_NONE, 0);

    gtk_object_class_add_signals (object_class, signals, LAST_SIGNAL);

    klass->save_info    = save_info;
    klass->load_info    = load_info;
    klass->remove       = remove;
    klass->get_physical_uri = get_physical_uri;
}

static void
init (EFolder *folder)
{
    EFolderPrivate *priv;

    priv = g_new (EFolderPrivate, 1);
    priv->type            = NULL;
    priv->name            = NULL;
    priv->description     = NULL;
    priv->physical_uri    = NULL;
    priv->self_highlight  = FALSE;
    priv->child_highlight = 0;

    folder->priv = priv;
}


void
e_folder_construct (EFolder *folder,
            const char *name,
            const char *type,
            const char *description)
{
    EFolderPrivate *priv;

    g_return_if_fail (folder != NULL);
    g_return_if_fail (E_IS_FOLDER (folder));
    g_return_if_fail (name != NULL);
    g_return_if_fail (type != NULL);

    GTK_OBJECT_UNSET_FLAGS (GTK_OBJECT (folder), GTK_FLOATING);

    priv = folder->priv;

    priv->name        = g_strdup (name);
    priv->type        = g_strdup (type);
    priv->description = g_strdup (description);
}

EFolder *
e_folder_new (const char *name,
          const char *type,
          const char *description)
{
    EFolder *folder;

    g_return_val_if_fail (name != NULL, NULL);
    g_return_val_if_fail (type != NULL, NULL);
    g_return_val_if_fail (description != NULL, NULL);

    folder = gtk_type_new (E_TYPE_FOLDER);

    e_folder_construct (folder, name, type, description);

    return folder;
}


const char *
e_folder_get_name (EFolder *folder)
{
    g_return_val_if_fail (folder != NULL, NULL);
    g_return_val_if_fail (E_IS_FOLDER (folder), NULL);

    return folder->priv->name;
}

const char *
e_folder_get_type_string (EFolder *folder)
{
    g_return_val_if_fail (folder != NULL, NULL);
    g_return_val_if_fail (E_IS_FOLDER (folder), NULL);

    return folder->priv->type;
}

const char *
e_folder_get_description (EFolder *folder)
{
    g_return_val_if_fail (folder != NULL, NULL);
    g_return_val_if_fail (E_IS_FOLDER (folder), NULL);

    return folder->priv->description;
}

const char *
e_folder_get_physical_uri (EFolder *folder)
{
    g_return_val_if_fail (folder != NULL, NULL);
    g_return_val_if_fail (E_IS_FOLDER (folder), NULL);

    return folder->priv->physical_uri;
}

gboolean
e_folder_get_highlighted (EFolder *folder)
{
    g_return_val_if_fail (folder != NULL, FALSE);
    g_return_val_if_fail (E_IS_FOLDER (folder), FALSE);

    return folder->priv->self_highlight || folder->priv->child_highlight;
}


void
e_folder_set_name (EFolder *folder,
           const char *name)
{
    g_return_if_fail (folder != NULL);
    g_return_if_fail (E_IS_FOLDER (folder));
    g_return_if_fail (name != NULL);

    g_free (folder->priv->name);
    folder->priv->name = g_strdup (name);

    gtk_signal_emit (GTK_OBJECT (folder), signals[CHANGED]);
}

void
e_folder_set_type_string (EFolder *folder,
              const char *type)
{
    g_return_if_fail (folder != NULL);
    g_return_if_fail (E_IS_FOLDER (folder));
    g_return_if_fail (type != NULL);

    g_free (folder->priv->type);
    folder->priv->type = g_strdup (type);

    gtk_signal_emit (GTK_OBJECT (folder), signals[CHANGED]);
}

void
e_folder_set_description (EFolder *folder,
              const char *description)
{
    g_return_if_fail (folder != NULL);
    g_return_if_fail (E_IS_FOLDER (folder));
    g_return_if_fail (description != NULL);

    g_free (folder->priv->description);
    folder->priv->description = g_strdup (description);

    gtk_signal_emit (GTK_OBJECT (folder), signals[CHANGED]);
}

void
e_folder_set_physical_uri (EFolder *folder,
               const char *physical_uri)
{
    g_return_if_fail (folder != NULL);
    g_return_if_fail (E_IS_FOLDER (folder));
    g_return_if_fail (physical_uri != NULL);

    g_free (folder->priv->physical_uri);
    folder->priv->physical_uri = g_strdup (physical_uri);

    gtk_signal_emit (GTK_OBJECT (folder), signals[CHANGED]);
}

void
e_folder_set_highlighted (EFolder *folder,
              gboolean highlighted)
{
    g_return_if_fail (folder != NULL);
    g_return_if_fail (E_IS_FOLDER (folder));

    folder->priv->self_highlight = highlighted;

    gtk_signal_emit (GTK_OBJECT (folder), signals[CHANGED]);
}

void
e_folder_set_child_highlight (EFolder *folder,
                  gboolean highlighted)
{
    g_return_if_fail (folder != NULL);
    g_return_if_fail (E_IS_FOLDER (folder));

    if (highlighted)
        folder->priv->child_highlight++;
    else
        folder->priv->child_highlight--;

    gtk_signal_emit (GTK_OBJECT (folder), signals[CHANGED]);
}


E_MAKE_TYPE (e_folder, "EFolder", EFolder, class_init, init, PARENT_TYPE)