gntwidget.h File Reference

Widget API. More...

#include <stdio.h>
#include <glib.h>
#include <ncurses.h>
#include "gntbindable.h"

Include dependency graph for gntwidget.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  _GntWidgetPriv
struct  _GntWidget
struct  _GntWidgetClass

Defines

#define GNT_TYPE_WIDGET   (gnt_widget_get_gtype())
#define GNT_WIDGET(obj)   (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_WIDGET, GntWidget))
#define GNT_WIDGET_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_WIDGET, GntWidgetClass))
#define GNT_IS_WIDGET(obj)   (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_WIDGET))
#define GNT_IS_WIDGET_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_WIDGET))
#define GNT_WIDGET_GET_CLASS(obj)   (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_WIDGET, GntWidgetClass))
#define GNT_WIDGET_FLAGS(obj)   (GNT_WIDGET(obj)->priv.flags)
#define GNT_WIDGET_SET_FLAGS(obj, flags)   (GNT_WIDGET_FLAGS(obj) |= flags)
#define GNT_WIDGET_UNSET_FLAGS(obj, flags)   (GNT_WIDGET_FLAGS(obj) &= ~(flags))
#define GNT_WIDGET_IS_FLAG_SET(obj, flags)   (GNT_WIDGET_FLAGS(obj) & (flags))

Typedefs

typedef _GntWidget GntWidget
typedef _GntWidgetPriv GntWidgetPriv
typedef _GntWidgetClass GntWidgetClass
typedef enum _GntWidgetFlags GntWidgetFlags
typedef enum _GntMouseEvent GntMouseEvent
typedef enum _GntParamFlags GntParamFlags

Enumerations

enum  _GntWidgetFlags {
  GNT_WIDGET_DESTROYING = 1 << 0, GNT_WIDGET_CAN_TAKE_FOCUS = 1 << 1, GNT_WIDGET_MAPPED = 1 << 2, GNT_WIDGET_NO_BORDER = 1 << 3,
  GNT_WIDGET_NO_SHADOW = 1 << 4, GNT_WIDGET_HAS_FOCUS = 1 << 5, GNT_WIDGET_DRAWING = 1 << 6, GNT_WIDGET_URGENT = 1 << 7,
  GNT_WIDGET_GROW_X = 1 << 8, GNT_WIDGET_GROW_Y = 1 << 9, GNT_WIDGET_INVISIBLE = 1 << 10, GNT_WIDGET_TRANSIENT = 1 << 11,
  GNT_WIDGET_DISABLE_ACTIONS = 1 << 12
}
enum  _GntMouseEvent {
  GNT_LEFT_MOUSE_DOWN = 1, GNT_RIGHT_MOUSE_DOWN, GNT_MIDDLE_MOUSE_DOWN, GNT_MOUSE_UP,
  GNT_MOUSE_SCROLL_UP, GNT_MOUSE_SCROLL_DOWN
}
enum  _GntParamFlags { GNT_PARAM_SERIALIZABLE = 1 << G_PARAM_USER_SHIFT }

Functions

G_BEGIN_DECLS GType gnt_widget_get_gtype (void)
 
Returns:

void gnt_widget_destroy (GntWidget *widget)
 
Parameters:
widget 

void gnt_widget_show (GntWidget *widget)
 
Parameters:
widget 

void gnt_widget_draw (GntWidget *widget)
 
Parameters:
widget 

void gnt_widget_expose (GntWidget *widget, int x, int y, int width, int height)
 
Parameters:
widget 

void gnt_widget_hide (GntWidget *widget)
 
Parameters:
widget 

void gnt_widget_get_position (GntWidget *widget, int *x, int *y)
 
Parameters:
widget 

void gnt_widget_set_position (GntWidget *widget, int x, int y)
 
Parameters:
widget 

void gnt_widget_size_request (GntWidget *widget)
 
Parameters:
widget 

void gnt_widget_get_size (GntWidget *widget, int *width, int *height)
 
Parameters:
widget 

gboolean gnt_widget_set_size (GntWidget *widget, int width, int height)
 
Parameters:
widget 

gboolean gnt_widget_confirm_size (GntWidget *widget, int width, int height)
 
Parameters:
widget 

gboolean gnt_widget_key_pressed (GntWidget *widget, const char *keys)
 
Parameters:
widget 

gboolean gnt_widget_clicked (GntWidget *widget, GntMouseEvent event, int x, int y)
 
Parameters:
widget 

gboolean gnt_widget_set_focus (GntWidget *widget, gboolean set)
 
Parameters:
widget 

void gnt_widget_activate (GntWidget *widget)
 
Parameters:
widget 

void gnt_widget_set_name (GntWidget *widget, const char *name)
 
Parameters:
widget 

const char * gnt_widget_get_name (GntWidget *widget)
void gnt_widget_queue_update (GntWidget *widget)
 
Parameters:
widget 

void gnt_widget_set_take_focus (GntWidget *widget, gboolean set)
 
Parameters:
widget 

void gnt_widget_set_visible (GntWidget *widget, gboolean set)
 
Parameters:
widget 

gboolean gnt_widget_has_shadow (GntWidget *widget)
 
Parameters:
widget 


Detailed Description

Widget API.

Definition in file gntwidget.h.


Enumeration Type Documentation

enum _GntMouseEvent

Enumerator:
GNT_LEFT_MOUSE_DOWN 
GNT_RIGHT_MOUSE_DOWN 
GNT_MIDDLE_MOUSE_DOWN 
GNT_MOUSE_UP 
GNT_MOUSE_SCROLL_UP 
GNT_MOUSE_SCROLL_DOWN 

Definition at line 72 of file gntwidget.h.

enum _GntParamFlags

Enumerator:
GNT_PARAM_SERIALIZABLE 

Definition at line 83 of file gntwidget.h.

enum _GntWidgetFlags

Enumerator:
GNT_WIDGET_DESTROYING 
GNT_WIDGET_CAN_TAKE_FOCUS 
GNT_WIDGET_MAPPED 
GNT_WIDGET_NO_BORDER 
GNT_WIDGET_NO_SHADOW 
GNT_WIDGET_HAS_FOCUS 
GNT_WIDGET_DRAWING 
GNT_WIDGET_URGENT 
GNT_WIDGET_GROW_X 
GNT_WIDGET_GROW_Y 
GNT_WIDGET_INVISIBLE 
GNT_WIDGET_TRANSIENT 
GNT_WIDGET_DISABLE_ACTIONS 

Definition at line 52 of file gntwidget.h.


Function Documentation

gboolean gnt_widget_clicked ( GntWidget widget,
GntMouseEvent  event,
int  x,
int  y 
)

Parameters:
widget 

Parameters:
event 
x 
y 
Returns:

gboolean gnt_widget_confirm_size ( GntWidget widget,
int  width,
int  height 
)

Parameters:
widget 

Parameters:
width 
height 
Returns:

void gnt_widget_expose ( GntWidget widget,
int  x,
int  y,
int  width,
int  height 
)

Parameters:
widget 

Parameters:
x 
y 
width 
height 

void gnt_widget_get_position ( GntWidget widget,
int *  x,
int *  y 
)

Parameters:
widget 

Parameters:
x 
y 

void gnt_widget_get_size ( GntWidget widget,
int *  width,
int *  height 
)

Parameters:
widget 

Parameters:
width 
height 

gboolean gnt_widget_has_shadow ( GntWidget widget  ) 

Parameters:
widget 

Returns:

gboolean gnt_widget_key_pressed ( GntWidget widget,
const char *  keys 
)

Parameters:
widget 

Parameters:
keys 
Returns:

gboolean gnt_widget_set_focus ( GntWidget widget,
gboolean  set 
)

Parameters:
widget 

Parameters:
set 
Returns:

void gnt_widget_set_name ( GntWidget widget,
const char *  name 
)

Parameters:
widget 

Parameters:
name 

void gnt_widget_set_position ( GntWidget widget,
int  x,
int  y 
)

Parameters:
widget 

Parameters:
x 
y 

gboolean gnt_widget_set_size ( GntWidget widget,
int  width,
int  height 
)

Parameters:
widget 

Parameters:
width 
height 
Returns:

void gnt_widget_set_take_focus ( GntWidget widget,
gboolean  set 
)

Parameters:
widget 

Parameters:
set 

void gnt_widget_set_visible ( GntWidget widget,
gboolean  set 
)

Parameters:
widget 

Parameters:
set