---

VDKObject Class Reference

#include <vdkobj.h>

Inheritance diagram for VDKObject:

List of all members.

Public Methods

• VDKRgb GetBackground (GtkStateType state=GTK_STATE_NORMAL)
• VDKRgb GetForeground (GtkStateType state=GTK_STATE_NORMAL)
• VDKObject (VDKForm *owner=NULL)
• VDKObject (VDKForm *owner, GtkWidget *widget)
• virtual ~VDKObject ()
• bool Destroy ()
• virtual int isA ()
• VDKForm * Owner ()
• virtual GtkWidget * Widget ()
• GtkWidget * ConnectingWidget ()
• GtkWidget * WrappedWidget ()
• virtual void SetFont (VDKFont *f)
• VDKFont * GetFont ()
• void SetVisible (bool visible)
• bool GetVisible ()
• void SetCursor (VDKCursorType)
• VDKCursorType GetCursor ()
• virtual void SetForeground (VDKRgb color, GtkStateType state=GTK_STATE_NORMAL)
• virtual void SetBackground (VDKRgb color, GtkStateType state=GTK_STATE_NORMAL)
• void SetSize (int w, int h)
• void SetUsize (VDKPoint s)
• virtual void SetTip (char *)
• virtual void Add (VDKObject *obj, int justify=l_justify, int expand=TRUE, int fill=TRUE, int padding=0)
• ItemList & Items ()
• void Draw (GdkRectangle *area=NULL)
• virtual void Setup ()
• void SignalEmit (int signal)
• void SignalEmit (char *sig)
• void SignalEmitParent (int signal)
• void SignalEmitParent (char *sig)
• void GrabFocus ()
• VDKObject * Parent (VDKObject *p=NULL)
• int SignalConnect (VDKObject *obj, char *signal, bool(VDKObject::*method)(VDKObject *), bool gtk=true, bool after=false)
• int SignalConnect (char *signal, bool(VDKObject::*method)(VDKObject *), bool gtk=true, bool after=false)
• bool SignalDisconnect (int connection)
• int EventConnect (VDKObject *obj, char *event, bool(VDKObject::*method)(VDKObject *, GdkEvent *), bool after=false)
• int EventConnect (char *, bool(VDKObject::*)(VDKObject *, GdkEvent *), bool after=false)
• bool EventDisconnect (int connection)

Public Attributes

• VDKReadWriteValueProp< VDKObject,
  VDKRgb > NormalBackground
• VDKReadWriteValueProp< VDKObject,
  VDKFont * > Font
• SizeObjectProp Usize
• VDKReadWriteValueProp< VDKObject,
  bool > Enabled
• VDKReadWriteValueProp< VDKObject,
  VDKCursorType > Cursor
• VDKReadWriteValueProp< VDKObject,
  bool > Visible
• VDKRawEventSignal OnRawEvent

  The signal for raw GdkEvents*.
  
  

• VDKButtonSignal OnButtonEvent

  The signal responsible for button events.
  
  

• VDKKeySignal OnKeyEvent

  The signal responsible for keystroke events.
  
  

• VDKKeyFocusSignal OnKeyFocusEvent

  The signal responsible for changes in key focus.
  
  

• VDKPointerFocusSignal OnPointerFocusEvent

  The signal responsible for changes in pointer focus.
  
  

• VDKPointerSignal OnPointerEvent

  The signal responsible for pointer (mouse) events.
  
  

• VDKMapSignal OnMapEvent

  The signal responsible for map events.
  
  

• VDKGeometrySignal OnGeometryEvent

  The signal responsible for geometry events.
  
  

• VDKPaintSignal OnPaintEvent

  The signal responsible for paint events.
  
  

Protected Attributes

• VDKObjectSignal s_clicked
• VDKObjectSignal s_pressed
• VDKObjectSignal s_released
• VDKObjectSignal s_enter
• VDKObjectSignal s_leave
• VDKObjectSignal s_list_select
• VDKObjectSignal s_list_unselect
• VDKObjectSignal s_list_click_column
• VDKObjectSignal s_realize
• VDKObjectSignal s_toggled
• VDKObjectSignal s_value_changed
• VDKObjectSignal s_child_attached
• VDKObjectSignal s_child_detached
• GtkWidget * widget
• GtkWidget * sigwid
• VDKObject * parent

Friends

• class VDKRawObject

---

Detailed Description

This class is the base class of a wide hierarchy, provides common functionalities to all derived classe

---

Constructor & Destructor Documentation

VDKObject::VDKObject (  VDKForm *    owner = NULL )

Constructor, make an object that belongs to <owner> form.

VDKObject::VDKObject (  VDKForm *    owner, GtkWidget *    widget )

Contructor, makes an object instance from an already gtk+ created object.

VDKObject::~VDKObject (    )  [virtual]

Destructor

---

Member Function Documentation

void VDKObject::Add (  VDKObject *    obj, int    justify = l_justify, int    expand = TRUE, int    fill = TRUE, int    padding = 0 )  [virtual]

Add on abiect to the object. Parameters: obj  the object to be added justify  where the object wil be added, can be: l_justify packed to end (appended) r_justify packed to start (prepended) Parameters: expand  if true object will expand fill  if true object will fill all available space padding  how many pixels are left around object Reimplemented in VDKBox, VDKEventBox, VDKFixed, VDKForm, VDKFrame, VDKHandleBox, VDKMenu, VDKMenubar, VDKNotebook, VDKPaned, VDKRadioButtonGroup, VDKScrolled, VDKTable, VDKToolbar, and VDKObjectContainer.

GtkWidget * VDKObject::ConnectingWidget (    )

Same as WrappedWidget().

bool VDKObject::Destroy (    )

Explicitely destroy an object freeing associated memory. Tip: never use delete operator otherwise garbage collection will fail and program probably will crash. Reimplemented in VDKForm.

void VDKObject::Draw (  GdkRectangle *    area = NULL )

Draw an object

int VDKObject::EventConnect (  char *   , bool(VDKObject::*   )(VDKObject *, GdkEvent *), bool    after = false )  [inline]

Placeholder for subclasses, at this level does nothing. connects an <this>-event to a <this> method Parameters: event  event to be connected method  class method that answers to signal after  (default is false) if set to true connect signal in the "after" slot.

int VDKObject::EventConnect (  VDKObject *    obj, char *    event, bool(VDKObject::*    method)(VDKObject *, GdkEvent *), bool    after = false )  [inline]

Placeholder for subclasses, at this level does nothing. connects an object-event to a <this> method Parameters: obj  connected object event  event to be connected method  class method that answers to signal after  (default is false) if set to true connect signal in the "after" slot.

bool VDKObject::EventDisconnect (  int    connection )  [inline]

disconnect this from connection Parameters: connection  must be achieved with a previous EventConnect() call

VDKRgb VDKObject::GetBackground (  GtkStateType    state = GTK_STATE_NORMAL )

Gets object background color

VDKCursorType VDKObject::GetCursor (    )  [inline]

Gets object assigned cursor

VDKFont* VDKObject::GetFont (    )  [inline]

Gets object font

VDKRgb VDKObject::GetForeground (  GtkStateType    state = GTK_STATE_NORMAL )

Gets object foreground color

bool VDKObject::GetVisible (    )  [inline]

Returns object visibility Reimplemented in VDKForm.

void VDKObject::GrabFocus (    )

Grab the focus to itself

virtual int VDKObject::isA (    )  [inline, virtual]

returns an enum id (incomplete and not so useful) Reimplemented in VDKChart, VDKLineChart, VDKScatteredChart, VDKBarChart, and VDKForm.

ItemList& VDKObject::Items (    )  [inline]

Return contained objects list

VDKForm* VDKObject::Owner (    )  [inline]

Returns object owner form. Reimplemented in VDKForm.

VDKObject* VDKObject::Parent (  VDKObject *    p = NULL )  [inline]

Sets object parenthood

void VDKObject::SetBackground (  VDKRgb    color, GtkStateType    state = GTK_STATE_NORMAL )  [virtual]

Sets object background Parameters: color  a VDKRgb object state  can be one of the gtk+ widget states Reimplemented in VDKCanvas, VDKCombo, VDKEntry, VDKSpinButton, VDKCustom, VDKDrawingArea, VDKEditor, and VDKTextView.

void VDKObject::SetCursor (  VDKCursorType    )

Sets object assigned cursor

void VDKObject::SetFont (  VDKFont *    f )  [virtual]

Sets object font Reimplemented in VDKAbstractButton, VDKCanvas, VDKCheckButton, VDKEntry, VDKMenu, VDKMenuItem, VDKMenubar, VDKOptionMenu, VDKCustom, VDKCustomButton, VDKDrawingArea, VDKEditor, and VDKTextView.

void VDKObject::SetForeground (  VDKRgb    color, GtkStateType    state = GTK_STATE_NORMAL )  [virtual]

Sets object foreground Parameters: color  a VDKRgb object state  can be one of the gtk+ widget states Reimplemented in VDKAbstractButton, VDKCanvas, VDKCheckButton, VDKEntry, VDKSpinButton, VDKCustom, VDKCustomButton, VDKDrawingArea, VDKEditor, and VDKTextView.

void VDKObject::SetSize (  int    w, int    h )  [inline]

Sets object minimum size Parameters: w  width h  height

void VDKObject::SetTip (  char *    )  [virtual]

Sets object tip. Reimplemented in VDKTooltip.

virtual void VDKObject::Setup (  void    )  [inline, virtual]

placeholder for subclasses. This method is called whenever an object is added to a container. Reimplemented in VDKFileDialog, VDKFileSel, VDKForm, and VDKFileIconDialog.

void VDKObject::SetUsize (  VDKPoint    s )  [inline]

Sets object minimum size Parameters: s, a  VDKPoint object

void VDKObject::SetVisible (  bool    visible )

Set object visibility Parameters: visible  either true or false Reimplemented in VDKForm.

int VDKObject::SignalConnect (  char *    signal, bool(VDKObject::*    method)(VDKObject *), bool    gtk = true, bool    after = false )  [inline]

Placeholder for subclasses, at this level does nothing. Connects <this>-signal to a <this> method Parameters: signal  signal to be connected method  class method that answers to signal gtk  (default is true) if you set this arg to false no real connection is made with gtk+ signal system and signal is handled internally by vdk. This allow to define and use your own signals without register them to gtk+ after  (default is false) if set to true connect signal in the "after" slot, meaninigfull only if previous <gtk> arg is set to true.

int VDKObject::SignalConnect (  VDKObject *    obj, char *    signal, bool(VDKObject::*    method)(VDKObject *), bool    gtk = true, bool    after = false )  [inline]

Placeholder for subclasses, at this level does nothing. Connects an object-signal to a <this> method Parameters: obj  connected object signal  signal to be connected method  class method that answers to signal gtk  (default is true) if you set this arg to false no real connection is made with gtk+ signal system and signal is handled internally by vdk. This allow to define and use your own signals without register them to gtk+ after  (default is false) if set to true connect signal in the "after" slot, meaninigfull only if previous <gtk> arg is set to true.

bool VDKObject::SignalDisconnect (  int    connection )  [inline]

disconnect this from connection Parameters: connection  must be achieved with a previous SignalConnect() call

void VDKObject::SignalEmit (  char *    sig )

Emit a signal (dynamic tables) Parameters: signal

void VDKObject::SignalEmit (  int    signal )

Emit a signal (static tables) Parameters: signal

void VDKObject::SignalEmitParent (  char *    sig )

Emit a signal directly to parent (dynamic tables) Parameters: signal

void VDKObject::SignalEmitParent (  int    signal )  [inline]

Emit a signal directly to parent (static tables) Parameters: signal

GtkWidget * VDKObject::Widget (    )  [virtual]

Returns underlying GTK+ widget.

GtkWidget * VDKObject::WrappedWidget (    )

Returns underlying wrapped Gtk+ widget, useful in those cases when VDKObject is a composite one. Happens in many composite widgets, i.e a container with some inner widgets, that underlaying widget isn't which answers to signals. In this case the container is the <widget> and one of the inner widgets is the <sigwid>, wich is responsible to answers signal/event.You have to connect with the last one. An example is VDKText where Widget() return packing box not text itself. Tip: In doubt use always WrappedWidget() instead of Widget(), is always safer.

---

Member Data Documentation

VDKReadWriteValueProp<VDKObject,VDKCursorType> VDKObject::Cursor

Setting this property will set/get object cursor type.

VDKReadWriteValueProp<VDKObject,bool> VDKObject::Enabled

Setting this property will set/get object sensitivity.

VDKReadWriteValueProp<VDKObject,VDKFont*> VDKObject::Font

Setting this property will set the object font. i.e.: obj->Font = new VDKFont(obj,"X-font-string-chock-full-o-dashes-goes-in-here");

VDKReadWriteValueProp<VDKObject,VDKRgb> VDKObject::NormalBackground

Setting one of these this properties will set/get object background color. Naming convention follows Gtk+ one. Example: form->NormalBackground = VDKRgb(255,0,0); (Tip: VDKRgb is a structure defined in vdkutils.h. Remember that some objects are transparent, so if you want to set the background color, you actually have to set the background color of the parent, VDKLabel is an example.

VDKObject* VDKObject::parent [protected]

Object parent, where the signal flows if not stopped

VDKObjectSignal VDKObject::s_child_attached [protected]

stock connected signal

VDKObjectSignal VDKObject::s_child_detached [protected]

stock connected signal

VDKObjectSignal VDKObject::s_clicked [protected]

stock connected signal

VDKObjectSignal VDKObject::s_enter [protected]

stock connected signal

VDKObjectSignal VDKObject::s_leave [protected]

stock connected signal

VDKObjectSignal VDKObject::s_list_click_column [protected]

stock connected signal

VDKObjectSignal VDKObject::s_list_select [protected]

stock connected signal

VDKObjectSignal VDKObject::s_list_unselect [protected]

stock connected signal

VDKObjectSignal VDKObject::s_pressed [protected]

stock connected signal

VDKObjectSignal VDKObject::s_realize [protected]

stock connected signal

VDKObjectSignal VDKObject::s_released [protected]

stock connected signal

VDKObjectSignal VDKObject::s_toggled [protected]

stock connected signal

VDKObjectSignal VDKObject::s_value_changed [protected]

stock connected signal

GtkWidget* VDKObject::sigwid [protected]

underlaying gtk+ widget widget and sigwid could be different, e.g into composite widget made of a container with some inner widget. See Widget() and WrappedWidget()

SizeObjectProp VDKObject::Usize

Setting this property will set/get object minimum size.

VDKReadWriteValueProp<VDKObject,bool> VDKObject::Visible

Setting this property will show/hide or get object visibility Reimplemented in VDKForm.

GtkWidget* VDKObject::widget [protected]

underlaying gtk+ widget

---

The documentation for this class was generated from the following files:

• vdkobj.h
• vdkobj.cc

---