libgnomeuimm-2.6-dev 2.28.0-1 / usr / include / libgnomeuimm-2.6 / libgnomeuimm / appbar.h

// -*- c++ -*-
// Generated by gtkmmproc -- DO NOT MODIFY!
#ifndef _LIBGNOMEUIMM_APPBAR_H
#define _LIBGNOMEUIMM_APPBAR_H


#include <glibmm.h>

// -*- C++ -*-
/* $Id: appbar.hg,v 1.11 2002/09/15 12:12:37 murrayc Exp $ */

/* appbar.h
 * 
 * Copyright (C) 1998 EMC Capital Management Inc.
 * Developed by Havoc Pennington <hp@pobox.com>
 *
 * Copyright (C) 1999 The Gtk-- Development Team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free
 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#include <libgnomeui/gnome-appbar.h>
#include <gtkmm/box.h>
#include <gtkmm/progressbar.h>


#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _GnomeAppBar GnomeAppBar;
typedef struct _GnomeAppBarClass GnomeAppBarClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */


namespace Gnome
{

namespace UI
{ class AppBar_Class; } // namespace UI

} // namespace Gnome
namespace Gnome
{

namespace UI
{


/** @addtogroup libgnomeuimmEnums Enums and Flags */

/**
 * @ingroup libgnomeuimmEnums
 */
enum PreferencesType
{
  PREFERENCES_NEVER,
  PREFERENCES_USER,
  PREFERENCES_ALWAYS
};

} // namespace UI

} // namespace Gnome


#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{

template <>
class Value<Gnome::UI::PreferencesType> : public Glib::Value_Enum<Gnome::UI::PreferencesType>
{
public:
  static GType value_type() G_GNUC_CONST;
};

} // namespace Glib
#endif /* DOXYGEN_SHOULD_SKIP_THIS */


namespace Gnome
{

namespace UI
{


class AppBar : public Gtk::HBox
{
   public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef AppBar CppObjectType;
  typedef AppBar_Class CppClassType;
  typedef GnomeAppBar BaseObjectType;
  typedef GnomeAppBarClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

  virtual ~AppBar();

#ifndef DOXYGEN_SHOULD_SKIP_THIS

private:
  friend class AppBar_Class;
  static CppClassType appbar_class_;

  // noncopyable
  AppBar(const AppBar&);
  AppBar& operator=(const AppBar&);

protected:
  explicit AppBar(const Glib::ConstructParams& construct_params);
  explicit AppBar(GnomeAppBar* castitem);

#endif /* DOXYGEN_SHOULD_SKIP_THIS */

public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  static GType get_type()      G_GNUC_CONST;


  static GType get_base_type() G_GNUC_CONST;
#endif

  ///Provides access to the underlying C GtkObject.
  GnomeAppBar*       gobj()       { return reinterpret_cast<GnomeAppBar*>(gobject_); }

  ///Provides access to the underlying C GtkObject.
  const GnomeAppBar* gobj() const { return reinterpret_cast<GnomeAppBar*>(gobject_); }


public:
  //C++ methods used to invoke GTK+ virtual functions:
#ifdef GLIBMM_VFUNCS_ENABLED
#endif //GLIBMM_VFUNCS_ENABLED

protected:
  //GTK+ Virtual Functions (override these to change behaviour):
#ifdef GLIBMM_VFUNCS_ENABLED
#endif //GLIBMM_VFUNCS_ENABLED

  //Default Signal Handlers::
#ifdef GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED
  virtual void on_clear_prompt();
  virtual void on_user_response();
#endif //GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED


private:

public:

  explicit AppBar(bool has_progress = false, bool has_status = true, PreferencesType interactivity = PREFERENCES_NEVER);

  
  Gtk::ProgressBar* get_progress();

  
  Gtk::Widget* get_status();
  
  const Gtk::Widget* get_status() const;

  
  void set_default(const Glib::ustring& default_status);
  
  void set_status(const Glib::ustring& status);
  
  void push(const Glib::ustring& status);
  
  void pop();
  
  void clear_stack();
  
  void set_progress_percentage(gfloat percentage);
  
  void refresh();
  
  void prompt(const Glib::ustring& message, bool modal = true);
  
  void clear_prompt();
  
  Glib::ustring get_response() const;

  
  /**
   * @par Prototype:
   * <tt>void on_my_%clear_prompt()</tt>
   */

  Glib::SignalProxy0< void > signal_clear_prompt();

  
  /**
   * @par Prototype:
   * <tt>void on_my_%user_response()</tt>
   */

  Glib::SignalProxy0< void > signal_user_response();


};

} /* namespace UI */
} /* namespace Gnome */


namespace Glib
{
  /** A Glib::wrap() method for this object.
   * 
   * @param object The C instance.
   * @param take_copy False if the result should take ownership of the C instance. True if it should take a new copy or ref.
   * @result A C++ instance that wraps this C instance.
   *
   * @relates Gnome::UI::AppBar
   */
  Gnome::UI::AppBar* wrap(GnomeAppBar* object, bool take_copy = false);
} //namespace Glib


#endif /* _LIBGNOMEUIMM_APPBAR_H */