GUICanvasFBodyC<class DataT> - Widget in which graphics can be rendered.

Developer Documentation

Centre for Vision, Speech & Signal Processing

Parent Classes:

GUICanvasBodyC

Typedefs:

typedef ScopePath (*)(FuncArgList) FuncT;: Function ptr.

Variables:

FuncT func;
DataT dat;

Methods:

GUICanvasFBodyC(int x,int y,FuncT nfunc,const DataT & ndat): Constructor.
void MouseEvent(const GUIMouseEventC & me): Call back for user.

#include "amma/GUI/Canvas.hh"

BooleanT Create(): Create the widget.
BooleanT Service(): Service render request.
BooleanT Put(const GUIRenderC & r): Put render instructon into pipe.
void PutEOS(): Put End Of Stream marker.
BooleanT IsPutReady() const: Is port ready for data ?
void MouseEvent(const GUIMouseEventC & me): Call back for user.
void SetMouseEventMask(BooleanT getMove,BooleanT getPress,BooleanT getRelease): Setup which events will be given to 'MouseEvent()'
GtkWidget * DDrawArea(): Direct draw area.
GdkPixmap *& Pixmap(): Pixmap.
GdkDrawable * DrawArea(): Get draw area.
GdkColor & GetColour(int n): Access colour.
GUI thread only.
BooleanT Resize(int nsx,int nsy): Resize canvas.
The canvas will be resized on the next render event.
void GUIResize(int & nsx,int & nsy): Resize canvas.
GUI Thread only
void GUIRender(GUIRenderC & r): Resize canvas.
GUI Thread only
BooleanT & ConfigDone(): Flag configure as done.
GdkGC * DrawGC(): Drawing context.
void DoSomeSetup(): Don't call!!
void SetupEvents(): Setup the events we want to process.
can only be called after the widget has been created.
void SetupColours(): Setup colour table.

#include "amma/DP/Port.hh"

BooleanT Put(const GUIRenderC &): Put data.
This function MUST be provided by client class.
IntT PutArray(const SArray1dC<GUIRenderC> & data): Put an array of data to stream.
returns number of elements processed. NB. This need NOT be overridden in client classes unless fast handling of arrays of data elements is required.
const type_info & OutputType() const: Input type.
BooleanT Save(ostream & out) const: Save to ostream.

#include "amma/GUI/Widget.hh"

BooleanT Create(): Create the widget.
BooleanT Service(): Service request.
Used to send signals from other threads to the program.
GtkWidget * Widget(): Access widget.
int WidgetID() const: Get widget id.
StringC WidgetName() const: Get widget's name.
Call only from GUI thread.
StringC Name() const: Get name of widget.
Defaults to WidgetName(), but may be differnt for Lables etc.
BooleanT GUIShow(): Show widget to the world.
Call only from GUI thread.
BooleanT GUIHide(): Hide widget from the world.
Call only from GUI thread.
void Show(): Show widget to the world.
Thread safe.
void Hide(): Hide widget from the world.
Thread safe.
PixelC Position() const: Widget position within its parent window.
PixelC Size() const: Access Size of wiget.
void GUISetUSize(IntT x,IntT y): Set size of widget.
GUI thread only.
IndexRectangleC Rectangle() const: Widget position and extent within its parent window.
void SetState(GtkStateType state): Set state
void WidgetDestroy(): Called when the underlying widget it destroyed.
The default version of this method simpily 0's the widget ptr.
Signal0C & Signal(const char *): Get handle for named signal.
See handle class for description.
void SetToolTip(const char * text,const char * ctxt = 0): Set the tool tip for the widget.
NB. Not all widgets can display tooltips.
void AddEventMask(IntT event): Add to the event mask.
void DelEventMask(IntT event): Remove from the event mask.
void ShapeCombineMask(GdkBitmap & mask,int off_x = 0,int off_y = 0): Make a shape mask for the widget.
void Destroy(): Undo all refrences.
Used to avoid problems with circluar refrences. This should undo all refrences to AMMA and GUI objects which are not in the destroy tree. The function is called by the root window in its destructor.
BooleanT ReqService(): Request call by GUI thread to 'Service()' method of this widget.
This call is thread safe.
void ConnectSignals(): Connect the default signals to the underly widget.
void ConnectUp(const char * nm,Signal0C & sig): Connect up a signal.
GTKSignalInfoC & SigInfo(const char * nm): Get information about a named signal.
int gtkDestroy(GtkWidget * widget,GUIWidgetBodyC * data)
int gtkEvent(GtkWidget * widget,GdkEvent * event,Signal0C * data)
int gtkEventMouseButton(GtkWidget * widget,GdkEvent * event,Signal0C * data)
int gtkEventMouseMotion(GtkWidget * widget,GdkEvent * event,Signal0C * data)
int gtkGeneric(GtkWidget * widget,Signal0C * data)
int gtkString(GtkWidget * widget,Signal0C * data)
int gtkCListSelect(GtkWidget * widget,IntT row,IntT column,GdkEventButton * event,Signal0C * data)
int gtkCListCol(GtkWidget * widget,IntT column,Signal0C * data)

#include "amma/DP/Port.hh"

void PutEOS(): Put End Of Stream marker.
BooleanT IsPutReady() const: Is port ready for data ?
const type_info & OutputType() const: Output type.
BooleanT Save(ostream & out) const: Save to ostream.

#include "amma/DP/Entity.hh"

BooleanT Save(ostream & out) const: Save to ostream.
BodyRefCounterVC & Copy() const: Creat a copy of this object.

#include "amma/DP/Port.hh"

BooleanT IsAsync() const: Does port work asynchronously ?
BooleanT Save(ostream & out) const: Save to ostream.
DPPortC ConnectedTo() const: Is this port connected to another ?
If not returns invalid handle.
BooleanT GetAttr(const StringC & attrName,StringC & attrValue): Get a stream attribute.
Returns false if the attribute name is unknown. This is for handling stream attributes such as frame rate, and compression ratios.
BooleanT SetAttr(const StringC & attrName,const StringC & attrValue): Set a stream attribute.
Returns false if the attribute name is unknown. This is for handling stream attributes such as frame rate, and compression ratios.

#include "amma/BRefCntV.hh"

BodyRefCounterVC & Copy() const: Creat a copy of this object.
BooleanT operator==(const BodyRefCounterVC & oth) const: Compair identitys.
BooleanT operator!=(const BodyRefCounterVC & oth) const: Compair identitys.
BooleanT Save(ostream & out) const: Save to ostream.

#include "amma/DP/Entity.hh"

BooleanT Save(ostream & out) const: Save to ostream.
BodyRefCounterVC & Copy() const: Creat a copy of this object.

#include "amma/BRefCnt.hh"

void AddReference(): Another reference to the object has been created.
void RemoveReference(): One reference to the object was deleted.
Locking scheme -------------- The object is possible to lock (to make constant). The scheme assumes that the object is created, it can be locked, after that it can only be destroyed. The locked object cannot be unlocked. This locking scheme is very useful during debugging, using assert() function, when it is necassary to check that object is treated as constant and the constancy is not violated by any casting or passing through the copy constructor of shared objects.
void SetConst(void) const: This locks the object.
Often objects you wish to lock are already const.
void SetConst(void): This locks the object.
BooleanT IsConst(void) const: Returns TRUE if the object is locked, ie. it is assumed to be constant.
BooleanT IsNotConst(void) const: Returns TRUE if the object is unlocked.
ie. there is no special information if the object is constant or not. Counter state information -------------------------
BooleanT ToBeDeleted() const: Returns TRUE if there is only one reference to the object and the whole object or its reference counting part can be deleted.
BooleanT ToBeDeletedRemoveIgnoreNoRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object.
BooleanT ToBeDeletedRemove(): Decrement refrence by 1 return true if this leaves no refrences to the object. This also checks the NoRemove flag.
BooleanT BodyMightBeDeleted() const: Returns TRUE if the reference counted part of the object can be deleted, ie. flag NOREMOVE is false .
BooleanT IsCountZero() const: Are there any refrences left ?
BooleanT BRCPtrCanDeleteObject() const: Used by BRRCPtrC to establish if an object has ZERO refrences and can be deleted.
IntT Count() const: Returns the current state of the counter, ie. how many references to this object exist.
const BodyRefCounterC & operator=(const BodyRefCounterC & b): It has not meaning to assign object 'b' to this object because it would destroy a history of the object which is counted. So this is a dummy function.
BooleanT IsValidObject() const: Test if object is valid.
When amma check is disabled this always returns true.
BooleanT UserBitTest(IntT x) const: Test user flag.
void UserBitSet(IntT x,BooleanT setit = TRUE): Test user flag.
void UserBitZero(IntT x): Set bit to zero.
void ReportBRCError(char * Msg): Report error, used in BRCPtrC.
UIntT Hash() const: Hash on address of object.
void SetUndeletable(): Make object undeletable.
Usefull to prevent recursive deleting in graph structures. Only hackers need this function.
void ReportInvalidObject(char * Msg = 0) const: Tell user about validation failure.

#include "amma/RefCBase.hh"

LabelT Label() const: Returns the label of this reference counter.
The member function is useful mainly to recognize objects during debugging. The value of the label is uniquely defined pointer.

Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001

GUICanvasFBodyC<class DataT>

Widget in which graphics can be rendered.

include	"amma/GUI/CanvasF.hh"
User Level:	Default
Library:	GUI
Example:	exMenu.cc
Section:	GUI.Widget
In Scope:	std