User Documentation
RAVL, Recognition And Vision Library
DEVELOP HOME PAGE CLASS LIST CONTENTS
 

namespace RavlGUIN
Created: 23/03/1999
User Level:Default
Library: RavlGUI
Example: exCanvas.cc

Comments:

This file is part of RAVL, Recognition And Vision Library Copyright (C) 2001, University of Surrey This code may be redistributed under the terms of the GNU Lesser General Public License (LGPL). See the lgpl.licence file for details or see http://www.gnu.org/copyleft/lesser.html file-header-ends-here ////////////////////////////////////////////////////////////

Child Classes:

#include "Ravl/GUI/Window.hh"

WindowC Window handle.
#include "Ravl/GUI/Manager.hh"

ManagerC GUI Manager class
#include "Ravl/GUI/Widget.hh"

WidgetC Base Widget handle.
#include "Ravl/GUI/Menu.hh"

MenuC Pixmap
#include "Ravl/GUI/SignalInfo.hh"

GTKSignalInfoC Signal info
#include "Ravl/GUI/Cursor.hh"

CursorC Cursor handle
#include "Ravl/GUI/MouseEvent.hh"

MouseEventC Mouse event information.
CListEventC Print description of mouse event to stream.
#include "Ravl/GUI/Button.hh"

ButtonC Button handle.
#include "Ravl/GUI/Pixmap.hh"

PixmapC Pixmap
#include "Ravl/GUI/ToolTips.hh"

ToolTipsC Tool tip set handle.
#include "Ravl/GUI/CWidget.hh"

ContainerWidgetC Container Widget
#include "Ravl/GUI/OneChild.hh"

OneChildC Base class for all widgets with exactly one child.
#include "Ravl/GUI/PackInfo.hh"

PackInfoC Packing info widget.
#include "Ravl/GUI/Menu.hh"

MenuItemC Menu item
MenuBarC Pixmap
#include "Ravl/GUI/Label.hh"

LabelC Label
#include "Ravl/GUI/LBox.hh"

LBoxC Layout box
#include "Ravl/GUI/FileSelector.hh"

FileSelectorC FileSelector
#include "Ravl/GUI/TextEntry.hh"

TextEntryC TextEntry
#include "Ravl/GUI/Slider.hh"

SliderC Slider
#include "Ravl/GUI/ScrolledArea.hh"

ScrolledAreaC ScrolledArea handle.
#include "Ravl/GUI/Fixed.hh"

FixedWidgetC Fixed layout widget.
#include "Ravl/GUI/EventBox.hh"

EventBoxC Event box.
#include "Ravl/GUI/Frame.hh"

FrameC Put a frame around some other widgets.
#include "Ravl/GUI/ToggleButton.hh"

ToggleButtonC Toggle Button handle.
CheckButtonC Check Button handle.
#include "Ravl/GUI/StatusBar.hh"

StatusBarC Status bar.
#include "Ravl/GUI/Combo.hh"

ComboC Combo handle.
#include "Ravl/GUI/List.hh"

ListC List handle.
#include "Ravl/GUI/MenuCheck.hh"

MenuCheckItemC Menu item
#include "Ravl/GUI/RawCanvas.hh"

RawCanvasC RawCanvas handle.
#include "Ravl/GUI/Table.hh"

TableC Table.
#include "Ravl/GUI/Tree.hh"

TreeC Tree
TreeItemC Leaf of tree.
#include "Ravl/GUI/Separator.hh"

SeparatorC Vertical or horizontal separator.
#include "Ravl/GUI/Ruler.hh"

RulerC Ruler .
#include "Ravl/GUI/Bitmap.hh"

BitmapC Bitmap.
#include "Ravl/GUI/Notebook.hh"

NotebookC Notebook
#include "Ravl/GUI/CList.hh"

CListCellC Cell info.
CListC CList widget.
#include "Ravl/GUI/VLabel.hh"

VLabelC Vertical Label.
#include "Ravl/GUI/SpinButton.hh"

SpinButtonC Spin button body.
#include "Ravl/GUI/RadioButton.hh"

RadioButtonC Radio button
#include "Ravl/GUI/ProgressBar.hh"

ProgressBarC Vertical or horizontal separator.
#include "Ravl/GUI/TextBox.hh"

TextBoxC TextBox
#include "Ravl/GUI/DragAndDrop.hh"

PositionTimeC Position and time of an event.
DNDDataInfoC Drag and drop info.
#include "Ravl/GUI/Paned.hh"

PanedC Base class for all widgets with exactly one child.
#include "Ravl/GUI/Canvas.hh"

CanvasC Widget in which graphics can be rendered.
#include "Ravl/GUI/Canvas3D.hh"

Canvas3DC 3D Canvas Widget.
#include "Ravl/GUI/DObject3D.hh"

DObject3DC Handle to basic object in a 3d world.
DOpenGLC OpenGL code invokation class.
DObjectSet3DC Handle to basic object in a 3d world.
#include "Ravl/GUI/DLight3D.hh"

DLight3DC Draw some lines.
#include "Ravl/GUI/DViewPoint3D.hh"

DViewPoint3DC Setup a view point in the 3D world.
#include "Ravl/GUI/DCube3D.hh"

DCube3DC Handle to basic object in a 3d world.
#include "Ravl/GUI/Util.hh"

DTransform3DC Transform objects
#include "Ravl/GUI/DTriMesh3D.hh"

DTriMesh3DC Draw a TriMesh
#include "Ravl/GUI/DPointSet3D.hh"

DPointSet3DBodyC
DPointSet3DC
#include "Ravl/GUI/DPWindow.hh"

DPWindowC DP Window.
#include "Ravl/GUI/DPDisplayObj.hh"

DPDisplayObjC Display object.
#include "Ravl/GUI/DPDisplayImage.hh"

DPDisplayImageRGBC DPDisplayObj to handle images.
DPDisplayImageRealC DPDisplayObj to handle images.
DPDisplayImageByteC DPDisplayObj to handle images.
#include "Ravl/GUI/DPWindowOPort.hh"

DPWindowOPortC Window OPort.
#include "Ravl/GUI/DPWindowFormat.hh"

DPWindowFormatBodyC
DPWindowFormatC
#include "Ravl/GUI/DPDisplayView.hh"

DPDisplayViewC Widget for displaying DPDisplayObjC's.
#include "Ravl/VPlay/PlayControl.hh"
PlayControlC Play Control GUI interface.
Enumerated types:

#include "Ravl/GUI/ProgressBar.hh"
enum ProgBarOrientationT { GUIPROGBAR_LEFT_TO_RIGHT, GUIPROGBAR_RIGHT_TO_LEFT, GUIPROGBAR_BOTTOM_TO_TOP, GUIPROGBAR_TOP_TO_BOTTOM } ;

Typedefs:

#include "Ravl/GUI/RadioButton.hh"
typedef DListC<RadioButtonBodyC *> RadioButtonGroupT;
Radio button

Methods:

#include "Ravl/GUI/Widget.hh"
DListC<WidgetC> operator +(DListC<WidgetC> lst,const WidgetC & widge)
Add a widget into a widget list.

#include "Ravl/GUI/MouseEvent.hh"
ostream & operator <<(ostream &,const MouseEventC & me)
Print description of mouse event to stream.
///// CListEventC ////////////////////////////////////////////////

#include "Ravl/GUI/Button.hh"
ButtonC Button(const char * label,const char * tooltip = 0)
Create a button with no function attached.
here just for consistancy.

ButtonC Button(const char * label,bool (*func)(DataT & dat) ,const DataT & dat)

ButtonC Button(const char * label,bool (*func)(Data1T &,Data2T &) ,const Data1T & dat1,const Data2T & dat2)

ButtonC Button(const char * label,const ObjT & obj,bool (*func)(DataT & dat) ,const DataT & dat)

ButtonC ButtonR(const char * label,ObjT & obj,bool (*func)(DataT & dat) ,const DataT & dat)
Create button that calls a function.
This does NOT make a reference to obj.

ButtonC Button(const char * label,const char * tooltip,const ObjT & obj,bool (*func)(DataT & dat) ,const DataT & dat)

ButtonC Button(const char * label,const ObjT & obj,bool (*func)() )
Create button that calls a function.

ButtonC ButtonR(const char * label,ObjT & obj,bool (*func)() )
Create button that calls a function.
This does NOT make a reference to obj.

ButtonC Button(const char * label,const char * tooltip,const ObjT & obj,bool (*func)() )

ButtonC ButtonR(const char * label,const char * tooltip,ObjT & obj,bool (*func)() )

ButtonC Button(const PixmapC & pix,const ObjT & obj,bool (*func)() )

#include "Ravl/GUI/Menu.hh"
MenuItemC MenuItem(const StringC & label,bool (*func)(Data1T &,Data2T &) ,const Data1T & dat1,const Data2T & dat2)
Create new menu item, connect to a function.

MenuItemC MenuItem(const StringC & label,bool (*func)(Data1T &) ,const Data1T & dat1)
Create new menu item, connect to a function.

MenuItemC MenuItem(const StringC & label,bool (*func)(MenuItemC &,DataT & ref) ,const DataT & dat)
Create new menu item, connect to a function.

MenuItemC MenuItem(const StringC & label,const DataT & dat,bool (*func)() )
Create new menu item, connect to a function.

MenuItemC MenuItemR(const StringC & label,DataT & dat,bool (*func)() )
Create new menu item, connect to a function.
This does NOT hold a reference to item 'dat'

MenuItemC MenuItem(const StringC & label,const ObjT & obj,bool (*func)(DataT &) ,const DataT & dat)
Create new menu item, connect to a function.

MenuItemC MenuItemR(const StringC & label,ObjT & obj,bool (*func)(DataT &) ,const DataT & dat = DataT ())
Create new menu item, connect to a function.
This does NOT hold a reference to item 'dat'

MenuItemC MenuItem(const StringC & label,const ObjT & obj,bool (*func)(Data1T &,Data2T &) ,const Data1T & dat1,const Data2T & dat2)
Create new menu item, connect to a function.

MenuItemC MenuItemR(const StringC & label,ObjT & obj,bool (*func)(Data1T &,Data2T &) ,const Data1T & dat1 = Data1T (),const Data2T & dat2 = Data2T ())
Create new menu item, connect to a function.

MenuItemC MenuItem(const StringC & label)
Do nothing...

MenuItemC MenuItemSeparator()
Do nothing...

MenuItemC MenuItem(const StringC & label,bool (*func)() )
Simply call a function.

MenuItemC MenuItemShow(const StringC & label,const WidgetC & widge)
Send 'Show' request to a widget, from a menu item.
Calls 'show' of another widget when menu item is selected.

#include "Ravl/GUI/Label.hh"
LabelC Label(const char * label,const char * tooltip = 0)
Create a text label.
With an optional tooltip. (Doesn't work at the moment...)

#include "Ravl/GUI/LBox.hh"
LBoxC VBox(const DListC<WidgetC> & widges,int boarder = 0,bool nhomogeneous = false,IntT nspacing = 0)
Layout widgets in a vertical box.
Helper function calls: LBoxC(widges,true,boarder,nhomogeneous,nspacing)

LBoxC VBox(const WidgetC & widge,int boarder = 0,bool nhomogeneous = false,IntT nspacing = 0)
Layout widgets in a vertical box.
Helper function calls: LBoxC(widges,true,boarder,nhomogeneous,nspacing)

LBoxC HBox(const DListC<WidgetC> & widges,int boarder = 0,bool nhomogeneous = false,IntT nspacing = 0)
Layout horzontal in a vertical box.
Helper function calls: LBoxC(widges,false,boarder,nhomogeneous,nspacing)

LBoxC HBox(const WidgetC & widge,int boarder = 0,bool nhomogeneous = false,IntT nspacing = 0)
Layout horzontal in a vertical box.
Helper function calls: LBoxC(widges,false,boarder,nhomogeneous,nspacing)

LBoxC Box(const WidgetC & widge,int boarder = 0,bool nhomogeneous = false,IntT nspacing = 0)
Put a boarder around a widget.
Helper function calls: LBoxC(widge,false,boarder,nhomogeneous,nspacing)

LBoxC Box(const DListC<WidgetC> & widges,int boarder = 0,bool nhomogeneous = false,IntT nspacing = 0)
Put a boarder around a list of widgets.
Helper function calls: LBoxC(widges,false,boarder,nhomogeneous,nspacing)

#include "Ravl/GUI/FileSelector.hh"
FileSelectorC FileSelector(const StringC & fsname,bool (*func)(StringC & filename,FileSelectorC &) ,const StringC & filename = StringC ())
Call a function.

FileSelectorC FileSelector(const StringC & fsname,bool (*func)(StringC & filename) ,const StringC & filename = StringC ())
Call a method.

FileSelectorC FileSelector(const StringC & fsname,const DataT & obj,bool (*func)(StringC & filename) ,const StringC & fn = StringC ())
Call a function.

FileSelectorC FileSelector(const StringC & fsname,const StringC & filename,bool (*func)(StringC & filename,FileSelectorC &,DataT & ref) ,const DataT & dat)
Call a method.
Hold only a reference to the destination class.

FileSelectorC FileSelectorR(const StringC & fsname,DataT & obj,bool (*func)(StringC & filename) ,const StringC & fn = StringC ())

#include "Ravl/GUI/TextEntry.hh"
TextEntryC TextEntry(const StringC & def,int maxLen = - 1)
Create a text entry.

TextEntryC TextEntry(const StringC & def,const DataT & dat,bool (*func)(StringC & ref) ,int maxLen = - 1,bool sigAllChanges = false)

TextEntryC TextEntryR(const StringC & def,DataT & dat,bool (*func)(StringC & ref) ,int maxLen = - 1,bool sigAllChanges = false)

TextEntryC TextEntry(const StringC & def,bool (*func)(StringC & ref,DataT & dat) ,const DataT & dat,int maxLen = - 1,bool sigAllChanges = false)

#include "Ravl/GUI/Slider.hh"
SliderC SliderV(RealT nvalue,RealT nlower,RealT nupper,RealT nstep_increment,const DataT & obj,bool (*func)(RealT & value) ,RealT defVal = 0)
Vertical slider with call back to class.

SliderC SliderV(RealT nvalue,RealT nlower,RealT nupper,RealT nstep_increment,bool (*func)(RealT & value,ParmT & par) ,const ParmT & pt = ParmT ())
Vertical slider with call back to function.

SliderC SliderH(RealT nvalue,RealT nlower,RealT nupper,RealT nstep_increment,const DataT & obj,bool (*func)(RealT & value) ,RealT defVal = 0)
Horizontal slider with call back to class.

SliderC SliderH(RealT nvalue,RealT nlower,RealT nupper,RealT nstep_increment,bool (*func)(RealT & value,ParmT & par) ,const ParmT & pt = ParmT ())
Horizontal slider with call back to function.

SliderC SliderV(RealT nvalue,RealT nlower,RealT nupper,RealT nstep_increment,bool (*func)(RealT & value,DataT & dat) ,const DataT & data = DataT ())
Veritical slider with call back to function.

SliderC SliderH(RealT nvalue,RealT nlower,RealT nupper,RealT nstep_increment,bool (*func)(RealT & value,DataT & dat) ,const DataT & data = DataT ())
Horizontal slider with call back to function.

SliderC SliderVR(RealT nvalue,RealT nlower,RealT nupper,RealT nstep_increment,DataT & obj,bool (*func)(RealT & value) ,RealT defVal = 0)
Vertical slider with reference call back to class.

SliderC SliderHR(RealT nvalue,RealT nlower,RealT nupper,RealT nstep_increment,DataT & obj,bool (*func)(RealT & value) ,RealT defVal = 0)
Horizontal slider with reference call back to class.

#include "Ravl/GUI/ToggleButton.hh"
ToggleButtonC ToggleButton(const char * label,bool initState)
Construct a toggle button.

ToggleButtonC ToggleButton(const char * label,bool initState,const ObjT & obj,bool (*func)(bool) )

ToggleButtonC CheckButton(const char * label,bool initState)

ToggleButtonC CheckButton(const char * label,bool initState,const ObjT & obj,bool (*func)(bool &) )

ToggleButtonC ToggleButton(const char * label,const char * tooltip,bool initState,const ObjT & obj,bool (*func)(bool) )

ToggleButtonC CheckButton(const char * label,const char * tooltip,bool initState,const ObjT & obj,bool (*func)(bool &) )
/// Reference //////////////////////////

ToggleButtonC ToggleButtonR(const char * label,bool initState,ObjT & obj,bool (*func)(bool &) )

ToggleButtonC ToggleButtonR(const char * label,bool initState,ObjT & obj,bool (*func)(bool &,DataT & dat) ,const DataT & dat)

ToggleButtonC CheckButtonR(const char * label,bool initState,ObjT & obj,bool (*func)(bool &) )

ToggleButtonC CheckButtonR(const char * label,bool initState,ObjT & obj,bool (*func)(bool &,DataT & dat) ,const DataT & dat)

ToggleButtonC ToggleButtonR(const char * label,const char * tooltip,bool initState,ObjT & obj,bool (*func)(bool) )

ToggleButtonC CheckButtonR(const char * label,const char * tooltip,bool initState,ObjT & obj,bool (*func)(bool &) )

#include "Ravl/GUI/Combo.hh"
ComboC Combo(const DListC<StringC> & lst,bool (*func)(ComboC &,DataT & ref) ,const DataT & dat = DataT (),bool editable = true)
Contruct a combo box, call back to function.

ComboC Combo(const DListC<StringC> & lst,const DataT & dat,bool (*func)(StringC & ref) ,bool editable = true)
Contruct a combo box, call back to method in class.

ComboC Combo(const DListC<StringC> & lst,const char * tooltip,const DataT & dat,bool (*func)(StringC & ref) ,bool editable = true)
Contruct a combo box, call back to method in class.
With tooltip.

ComboC ComboR(const DListC<StringC> & lst,DataT & dat,bool (*func)(StringC & ref) ,bool editable = true)
Contruct a combo box, call back to method in referenced class.

ComboC ComboR(const DListC<StringC> & lst,char * tooltip,const DataT & dat,bool (*func)(StringC & ref) ,bool editable = true)
Contruct a combo box, call back to method in referenced class.
With tooltip.

#include "Ravl/GUI/List.hh"
ListC List(const DListC<Tuple2C<IntT,StringC>> & lst,void (*func)(ListC &,DataT & ref) ,const DataT & dat = DataT ())

ListC List(const DListC<Tuple2C<IntT,StringC>> & lst,const DataT & dat,void (*func)(StringC & ref) )

#include "Ravl/GUI/MenuCheck.hh"
MenuCheckItemC MenuCheckItem(const StringC & label,bool (*func)(bool &,Data1T &) ,const Data1T & dat1 = Data1T ())

MenuCheckItemC MenuCheckItem(const StringC & label,const DataT & obj,bool (*func)(bool &) )

MenuCheckItemC MenuCheckItemR(const StringC & label,DataT & obj,bool (*func)(bool &) )
Menu check item, call referenced class's method.

MenuCheckItemC MenuCheckItem(const StringC & label,bool initActive,const DataT & obj,bool (*func)(bool &) )

MenuCheckItemC MenuCheckItemR(const StringC & label,bool initActive,DataT & obj,bool (*func)(bool &) )

#include "Ravl/GUI/Separator.hh"
SeparatorC Separator(bool vert)
Create a separator.

SeparatorC VSeparator()
Create a vertical separator.

SeparatorC HSeparator()
Create a horizontal separator.

#include "Ravl/GUI/VLabel.hh"
VLabelC VLabel(const char * label,const char * tooltip = 0)
Create a text label.
With an optional tooltip. (Doesn't work at the moment...)

#include "Ravl/GUI/SpinButton.hh"
SpinButtonC SpinButton(RealT nvalue,RealT nlower,RealT nupper,RealT nstep_increment,const DataT & obj,void (*func)(RealT & value) ,RealT defVal = 0)
Construct spin button with callback to class method.

SpinButtonC SpinButtonR(RealT nvalue,RealT nlower,RealT nupper,RealT nstep_increment,DataT & obj,void (*func)(RealT & value) ,RealT defVal = 0)
Construct spin button with callback to referenced class method.

#include "Ravl/GUI/RadioButton.hh"
RadioButtonC RadioButton(const char * label,const RadioButtonGroupT & group)
Create a radio button in 'group'

RadioButtonC RadioButton(const char * label,const RadioButtonGroupT & group,const ObjT & obj,bool (*func)(bool &) )
Create a radio button in 'group'

RadioButtonC RadioButton(const char * label,const RadioButtonGroupT & group,bool (*func)(bool &) )
Create a radio button in 'group'

RadioButtonC RadioButton(const char * label,const RadioButtonGroupT & group,bool (*func)(bool &,DataT &) ,const DataT & v)
Create a radio button in 'group'

RadioButtonC RadioButton(const char * label,const char * tooltip,const RadioButtonGroupT & group,const ObjT & obj,bool (*func)(bool) )
Create a radio button in 'group'

RadioButtonC RadioButtonR(const char * label,const RadioButtonGroupT & group,ObjT & obj,bool (*func)(bool &) )
Create a radio button in 'group'

RadioButtonC RadioButtonR(const char * label,const RadioButtonGroupT & group,ObjT & obj,bool (*func)(bool &,DataT & dat) ,const DataT & dat)
Create a radio button in 'group'

RadioButtonC RadioButtonR(const char * label,const char * tooltip,const RadioButtonGroupT & group,bool initState,ObjT & obj,bool (*func)(bool) )
Create a radio button in 'group'

#include "Ravl/GUI/ProgressBar.hh"
ProgressBarC ProgressBar(ProgBarTypeT ntype = GUIPROGBAR_CONTINUOUS,ProgBarOrientationT orient = GUIPROGBAR_LEFT_TO_RIGHT,int nblocks = 10)
Create a separator.

#include "Ravl/GUI/DObject3D.hh"
ostream & operator <<(ostream & strm,const DObject3DC &)

ostream & operator <<(ostream & strm,const DOpenGLC &)
Write an DOpenGLC to a stream.

ostream & operator <<(ostream & strm,const DObjectSet3DC &)
Write an object set to a stream.

istream & operator >>(istream & strm,DObjectSet3DC &)
Read an object set to a stream.

#include "Ravl/GUI/DTriMesh3D.hh"
ostream & operator <<(ostream & strm,const DTriMesh3DC &)

istream & operator >>(istream & strm,DTriMesh3DC &)

DPDisplayObj to handle images.

DPDisplayObj to handle images.


Documentation by CxxDoc: Tue Aug 13 09:59:28 2002