caption.h

Go to the documentation of this file.

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


#include <glibmm.h>

/* $Id: caption.hg,v 1.10 2005/02/15 10:52:44 murrayc Exp $ */

/* caption.h
 *
 * Copyright (C) 1998-2005 The gtkmm 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 <gtkmm/eventbox.h>
#include <gtkmm/sizegroup.h>


#ifndef DOXYGEN_SHOULD_SKIP_THIS
typedef struct _HildonCaption HildonCaption;
typedef struct _HildonCaptionClass HildonCaptionClass;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */


namespace Hildon
{ class Caption_Class; } // namespace Hildon
namespace Hildon
{

enum CaptionStatus
{
  CAPTION_OPTIONAL,
  CAPTION_MANDATORY
};

} // namespace Hildon


#ifndef DOXYGEN_SHOULD_SKIP_THIS
namespace Glib
{

template <>
class Value<Hildon::CaptionStatus> : public Glib::Value_Enum<Hildon::CaptionStatus>
{
public:
  static GType value_type() G_GNUC_CONST;
};

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


namespace Hildon
{


class Caption : public Gtk::EventBox
{
  public:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
  typedef Caption CppObjectType;
  typedef Caption_Class CppClassType;
  typedef HildonCaption BaseObjectType;
  typedef HildonCaptionClass BaseClassType;
#endif /* DOXYGEN_SHOULD_SKIP_THIS */

  virtual ~Caption();

#ifndef DOXYGEN_SHOULD_SKIP_THIS

private:
  friend class Caption_Class;
  static CppClassType caption_class_;

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

protected:
  explicit Caption(const Glib::ConstructParams& construct_params);
  explicit Caption(HildonCaption* 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

  HildonCaption*       gobj()       { return reinterpret_cast<HildonCaption*>(gobject_); }

  const HildonCaption* gobj() const { return reinterpret_cast<HildonCaption*>(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_activate();
#endif //GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED


private:

public:
  Caption(Gtk::SizeGroup& group, const Glib::ustring& value,
          Gtk::Widget& child, Gtk::Widget& icon,
          CaptionStatus flag = CAPTION_OPTIONAL);
  

  //Ignore deprecated functions:
  

  bool is_mandatory() const;

  
  void set_status(CaptionStatus flag);

  
  CaptionStatus get_status() const;

//TODO: Is this really any Widget?
  
  void set_icon_image(Gtk::Widget& icon);

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

  
  void set_label(const Glib::ustring& label);

  
  Glib::ustring get_label() const;

  
  void set_separator(const Glib::ustring& separator);
  
  Glib::ustring get_separator() const;

  
  void set_label_alignment(float alignment);
  
  float get_label_alignment() const;

  /* Deprecated */
  

  void set_child_expand(bool expand = true);
  
  bool get_child_expand() const;

  
  Glib::SignalProxy0< void > signal_activate();
 

  #ifdef GLIBMM_PROPERTIES_ENABLED

  Glib::PropertyProxy<Glib::ustring> property_label() ;
#endif //#GLIBMM_PROPERTIES_ENABLED

#ifdef GLIBMM_PROPERTIES_ENABLED

  Glib::PropertyProxy_ReadOnly<Glib::ustring> property_label() const;
#endif //#GLIBMM_PROPERTIES_ENABLED

  #ifdef GLIBMM_PROPERTIES_ENABLED

  Glib::PropertyProxy<Gtk::Widget*> property_icon() ;
#endif //#GLIBMM_PROPERTIES_ENABLED

#ifdef GLIBMM_PROPERTIES_ENABLED

  Glib::PropertyProxy_ReadOnly<Gtk::Widget*> property_icon() const;
#endif //#GLIBMM_PROPERTIES_ENABLED

  #ifdef GLIBMM_PROPERTIES_ENABLED

  Glib::PropertyProxy<CaptionStatus> property_status() ;
#endif //#GLIBMM_PROPERTIES_ENABLED

#ifdef GLIBMM_PROPERTIES_ENABLED

  Glib::PropertyProxy_ReadOnly<CaptionStatus> property_status() const;
#endif //#GLIBMM_PROPERTIES_ENABLED

  #ifdef GLIBMM_PROPERTIES_ENABLED

  Glib::PropertyProxy<Glib::ustring> property_separator() ;
#endif //#GLIBMM_PROPERTIES_ENABLED

#ifdef GLIBMM_PROPERTIES_ENABLED

  Glib::PropertyProxy_ReadOnly<Glib::ustring> property_separator() const;
#endif //#GLIBMM_PROPERTIES_ENABLED

  #ifdef GLIBMM_PROPERTIES_ENABLED

  Glib::PropertyProxy<Gtk::SizeGroup*> property_size_group() ;
#endif //#GLIBMM_PROPERTIES_ENABLED

#ifdef GLIBMM_PROPERTIES_ENABLED

  Glib::PropertyProxy_ReadOnly<Gtk::SizeGroup*> property_size_group() const;
#endif //#GLIBMM_PROPERTIES_ENABLED


};

} // namespace Hildon


namespace Glib
{
  Hildon::Caption* wrap(HildonCaption* object, bool take_copy = false);
} //namespace Glib


#endif /* _HILDON_LIBSMM_CAPTION_H */

---