/* $Id: tooltips.gen_h,v 1.45 2001/07/15 13:33:39 murrayc Exp $ */


/* tooltips.h
 *
 * Copyright (C) 1998-1999 The Gtk-- Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include <gtk--/data.h>
#include <gtk--/widget.h>
#include <gtk/gtktooltips.h>


namespace Gtk {

//: Tooltip group
//- Tooltips are the messages that appear next to a widget when the mouse pointer
//- is held over it for a short amount of time. They are especially helpful
//- for adding more verbose description of things such as buttons in a toolbar.
//-
//- An individual tooltip belongs to a group of tooltips. Every tooltip in the
//- group can then be turned off with a call to {disable()} and enabled with
//- {enable()}.
//-
//- The length of time the user must keep the mouse over a widget before the tip
//- is shown, can be altered with {set_delay()}. This is set on a 'per group of
//- tooltips' basis.
//-
//- To assign a tip to a particular {Gtk::Widget::}, {set_tip()} is used.
//-
//- {\b Note:} Tooltips can only be set on widgets which have their own X window.
//- To add a tooltip to a widget that doesn't have its own window, place the widget inside a
//- {Gtk::EventBox::} and add a tooltip to that instead.
//-
//- The default appearance of all tooltips in a program is determined by the current
//- gtk theme that the user has selected.
//-
//- Information about the tooltip (if any) associated with an arbitrary widget can be
//- retrieved using {data_get()}.
class Tooltips : public Data
{


public:
  typedef Tooltips          CppObjectType;
  typedef GtkTooltips            BaseObjectType;

public:
  //: Returns the underlaying gtk+ object.
  GtkTooltips* gtkobj();
  const GtkTooltips* gtkobj() const;

  //: Returns true if object is this type.
  static bool isA(Gtk::Object *object);

  virtual ~Tooltips();

private:

public:
  Tooltips();



  //: Enable this tooltip group.


  void enable();

  //: Disable this tooltip group.


  void disable();

  //: Set the time before tooltips are displayed.
  //- {\var delay} is in seconds.


  void set_delay(guint delay);

  //: Set a tip for a widget.




  void set_tip(const Gtk::Widget& widget,const nstring& tip_text=0,const nstring& tip_private=0);

  //: This function is unimplemented because tooltip colors are instead determined by the theme.


  void set_colors(const Gdk_Color& background,const Gdk_Color& foreground);

protected:
  //: get tips data from a widget {\i (internal)}


  static GtkTooltipsData* data_get(Gtk::Widget& widget);

public:


  void force_window();




protected:
  // impl functions

};


//+ PROPERTIES(Gtk_ToolTips)
//. name: tip_window
//. type: Gtk_Widget*
//. get:
//. set:
//. desc:

//. name: active_tips_data
//. type: GtkTooltipsData*
//. get:
//. set:
//. desc:

//. name: tips_data_list
//. type: GList*
//. get:
//. set:
//. desc:

//. name: gc
//. type: GdkGC*
//. get:
//. set:
//. desc:

//. name: foreground
//. type: GdkColor*
//. get:
//. set:
//. desc:

//. name: background
//. type: GdkColor*
//. get:
//. set:
//. desc:

//. name: delay
//. type: guint:30
//. get:
//. set:
//. desc:

//. name: enabled
//. type: guint:1
//. get:
//. set:
//. desc:

//. name: timer_tag
//. type: gint
//. get:
//. set:
//. desc:

}