GLUI_Checkbox Class Reference

#include <glui.h>

Inheritance diagram for GLUI_Checkbox:

Inheritance graph
[legend]
Collaboration diagram for GLUI_Checkbox:

Collaboration graph
[legend]

List of all members.

Public Member Functions

int mouse_down_handler (int local_x, int local_y)
int mouse_up_handler (int local_x, int local_y, bool inside)
int mouse_held_down_handler (int local_x, int local_y, bool inside)
int key_handler (unsigned char key, int modifiers)
void update_size (void)
void draw (int x, int y)
void draw_active_area (void)
void draw_empty_box (void)
void set_int_val (int new_val)
 GLUI_Checkbox (GLUI_Node *parent, const char *name, int *value_ptr=NULL, int obj_id=-1, GLUI_CB callback=GLUI_CB())
 GLUI_Checkbox (void)

Public Attributes

int orig_value
bool currently_inside
int text_x_offset

Protected Member Functions

void common_init (void)

Detailed Description

A checkbox, which can be checked on or off. Can be linked to an int value, which gets 1 for on and 0 for off.

Definition at line 1005 of file glui.h.

Constructor & Destructor Documentation

GLUI_Checkbox::GLUI_Checkbox ( GLUI_Node *  parent,
const char *  name,
int *  value_ptr = NULL,
int  obj_id = -1,
GLUI_CB  callback = GLUI_CB() 
)

Create a new checkbox object.

Parameters:
parent The panel our object is inside; or the main GLUI object.
name Label next to our checkbox.
value_ptr Optional integer value to attach to this checkbox. When the checkbox is checked or unchecked, *value_ptr will also be changed. ("Live Vars").
obj_id Optional ID number, to pass to the optional callback function.
callback Optional callback function, taking either the int ID or control.

GLUI_Checkbox::GLUI_Checkbox ( void   )  [inline]

Definition at line 1037 of file glui.h.

Member Function Documentation

int GLUI_Checkbox::mouse_down_handler ( int  local_x,
int  local_y 
) [virtual]

Reimplemented from GLUI_Control.

int GLUI_Checkbox::mouse_up_handler ( int  local_x,
int  local_y,
bool  inside 
) [virtual]

Reimplemented from GLUI_Control.

int GLUI_Checkbox::mouse_held_down_handler ( int  local_x,
int  local_y,
bool  inside 
) [virtual]

Reimplemented from GLUI_Control.

int GLUI_Checkbox::key_handler ( unsigned char  key,
int  modifiers 
) [virtual]

Reimplemented from GLUI_Control.

void GLUI_Checkbox::update_size ( void   )  [virtual]

Reimplemented from GLUI_Control.

void GLUI_Checkbox::draw ( int  x,
int  y 
) [virtual]

Implements GLUI_Control.

void GLUI_Checkbox::draw_active_area ( void   ) 

void GLUI_Checkbox::draw_empty_box ( void   ) 

void GLUI_Checkbox::set_int_val ( int  new_val  )  [virtual]

Reimplemented from GLUI_Control.

void GLUI_Checkbox::common_init ( void   )  [inline, protected]

Definition at line 1040 of file glui.h.

Member Data Documentation

int GLUI_Checkbox::orig_value

Definition at line 1008 of file glui.h.

bool GLUI_Checkbox::currently_inside

Definition at line 1009 of file glui.h.

int GLUI_Checkbox::text_x_offset

Definition at line 1010 of file glui.h.

The documentation for this class was generated from the following file:
Generated on Thu Aug 30 11:04:40 2007 for SPRING Mac by  doxygen 1.5.3