qulogic/libgnt

merge of 'c50ebc981dfd53b324bda90352fa95c50fa66579'
release-2.x.y v2.10.1 v2.10.2 v2.10.3 v2.10.4 v2.10.5 v2.10.6
2011-10-21, Ethan Blanton
d124d77505f0
merge of 'c50ebc981dfd53b324bda90352fa95c50fa66579'
and 'a39856c5a2a34ac019f2a63470f970bba019e945'
/**
* @file gntws.h Workspace API
* @ingroup gnt
*/
/*
* GNT - The GLib Ncurses Toolkit
*
* GNT is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This library 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., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef GNTWS_H
#define GNTWS_H
#include "gntwidget.h"
#include <panel.h>
#define GNT_TYPE_WS (gnt_ws_get_gtype())
#define GNT_WS(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_WS, GntWS))
#define GNT_IS_WS(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_WS))
#define GNT_IS_WS_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_WS))
#define GNT_WS_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_WS, GntWSClass))
typedef struct _GntWS GntWS;
struct _GntWS
{
GntBindable inherit;
char *name;
GList *list;
GList *ordered;
gpointer ui_data;
void *res1;
void *res2;
void *res3;
void *res4;
};
typedef struct _GntWSClass GntWSClass;
struct _GntWSClass
{
GntBindableClass parent;
void (*draw_taskbar)(GntWS *ws, gboolean );
void (*res1)(void);
void (*res2)(void);
void (*res3)(void);
void (*res4)(void);
};
G_BEGIN_DECLS
/**
* @return The GType for GntWS.
*
* @since 2.0.0 (gnt), 2.1.0 (pidgin)
*/
GType gnt_ws_get_gtype(void);
/**
* Create a new workspace with the specified name.
*
* @param name The desired name of the workspace, or @c NULL.
*
* @return The newly created workspace.
*
* @since 2.0.0 (gnt), 2.1.0 (pidgin)
*/
GntWS *gnt_ws_new(const char *name);
/**
* Set the name of a workspace.
*
* @param ws The workspace to rename.
* @param name The new name of the workspace.
*
* @since 2.0.0 (gnt), 2.1.0 (pidgin)
*/
void gnt_ws_set_name(GntWS *ws, const gchar *name);
/**
* Add a widget to a workspace.
*
* @param ws The workspace.
* @param widget The widget to add.
*
* @since 2.0.0 (gnt), 2.1.0 (pidgin)
*/
void gnt_ws_add_widget(GntWS *ws, GntWidget *widget);
/**
* Remove a widget from a workspace.
*
* @param ws The workspace
* @param widget The widget to remove from the workspace.
*
* @since 2.0.0 (gnt), 2.1.0 (pidgin)
*/
void gnt_ws_remove_widget(GntWS *ws, GntWidget *widget);
/**
* Hide a widget in a workspace.
*
* @param widget The widget to hide.
* @param nodes A hashtable containing information about the widgets.
*
* @since 2.0.0 (gnt), 2.1.0 (pidgin)
*/
void gnt_ws_widget_hide(GntWidget *widget, GHashTable *nodes);
/**
* Show a widget in a workspace.
*
* @param widget The widget to show.
* @param nodes A hashtable containing information about the widgets.
*
* @since 2.0.0 (gnt), 2.1.0 (pidgin)
*/
void gnt_ws_widget_show(GntWidget *widget, GHashTable *nodes);
/**
* Draw the taskbar in a workspace.
*
* @param ws The workspace.
* @param reposition Whether the workspace should reposition the taskbar.
*
* @since 2.0.0 (gnt), 2.1.0 (pidgin)
*/
void gnt_ws_draw_taskbar(GntWS *ws, gboolean reposition);
/**
* Hide a workspace.
*
* @param ws The workspace to hide.
* @param table A hashtable containing information about the widgets.
*
* @since 2.0.0 (gnt), 2.1.0 (pidgin)
*/
void gnt_ws_hide(GntWS *ws, GHashTable *table);
/**
* Show a workspace.
*
* @param ws The workspace to hide.
* @param table A hashtable containing information about the widgets.
*
* @since 2.0.0 (gnt), 2.1.0 (pidgin)
*/
void gnt_ws_show(GntWS *ws, GHashTable *table);
/**
* Get the name of a workspace.
*
* @param ws The workspace.
* @return The name of the workspace (can be @c NULL).
*
* @since 2.0.0 (gnt), 2.1.0 (pidgin)
*/
const char * gnt_ws_get_name(GntWS *ws);
#endif