d

# Programming with gtkmm2

Murray
Cumming
Bernhard
Rieder
Chapter on "Timeouts".
Jason
M'Sadoques
Chapter on "Drawing Area".
Ole
Laursen
Parts of chapter on "Internationalization".
Gene
Ruebsamen
Chapter on "Win32 Installation".
Cedric
Gustin
Chapter on "Win32 Installation".

Not all sections have been completed - some have not been started. Some chapters have been written, but not edited or proofread. Since they do contain helpful information, they have been included, and are marked "draft". We are working hard to make this helpful and accurate. We would very much appreciate any reports of inaccuracies or other errors in this document. Contributions are also most welcome. Post your suggestions, critiques or addenda to the gtkmm mailing list -- The gtkmm Development Team

2002
Murray Cumming

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You may obtain a copy of the GNU Free Documentation License from the Free Software Foundation by visiting their Web site or by writing to: Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

## Introduction

### This book

This book assumes a good understanding of C++, and how to create C++ programs.

This book attempts to explain key `gtkmm` concepts and introduce some of the more commonly used user interface elements ("widgets"). Although it mentions classes, constructors, and methods, it does not go into great detail. For full API information you should follow the links into the reference documentation.

This document is a work in progress. You can find updates on the gtkmm home page.

We would very much like to hear of any problems you have learning gtkmm with this document, and would appreciate input regarding improvements. Please see the Contributing section for further information.

### gtkmm

gtkmm is a C++ wrapper for GTK+, a library used to create graphical user interfaces. It is licensed using the LGPL license, so you can develop open software, free software, or even commercial non-free software using gtkmm without purchasing licenses.

gtkmm was originally named gtk-- because GTK+ already has a + in the name. However, as -- is not easily indexed by search engines the package generally went by the name gtkmm, and that's what we stuck with.

#### Why use gtkmm instead of GTK+?

gtkmm allows you to write code using normal C++ techniques such as encapsulation, derivation, and polymorphism. As a C++ programmer you probably already realise that this leads to clearer and better organised code.

gtkmm is more type-safe, so the compiler can detect errors that would only be detected at run time when using C. This use of specific types also makes the API clearer because you can see what types should be used just by looking at a method's declaration.

Inheritance can be used to derive new widgets. The derivation of new widgets in GTK+ C code is so complicated and error prone that almost no C coders do it. As a C++ developer you know that derivation is an essential Object Orientated technique.

Member instances can be used, simplifying memory management. All GTK+ C widgets are dealt with by use of pointers. As a C++ coder you know that pointers should be avoided where possible.

gtkmm involves less code compared to GTK+, which uses prefixed function names and lots of cast macros.

#### gtkmm compared to QT

Trolltech's QT is the closest competition to gtkmm, so it deserves discussion.

gtkmm developers tend to prefer gtkmm to QT because gtkmm does things in a more C++ way. QT originates from a time when C++ and the standard library were not standardised or well supported by compilers. It therefore duplicates a lot of stuff that is now in the standard library, such as containers and type information. Most significantly, Trolltech modified the C++ language to provide signals, so that QT classes can not be used easily with non-QT classes. gtkmm was able to use standard C++ to provide signals without changing the C++ language. See the FAQ for more detailed differences.

#### gtkmm is a wrapper

gtkmm is not a native C++ toolkit, but a C++ wrapper of a C toolkit. This separation of interface and implementation has advantages. The gtkmm developers spend most of their time talking about how gtkmm can present the clearest API, without awkward compromises due to obscure technical details. We contribute a little to the underlying GTK+ code base, but so do the C coders, and the Perl coders and the Python coders, etc. Therefore GTK+ benefits from a broader user base than language-specific toolkits - there are more implementers, more developers, more testers, and more users.

Microsoft's MFC has given GUI wrapper libraries a bad name, but gtkmm doesn't suffer from the same problems because GTK+ is written in high quality object-orientated C, with language-bindings in mind.

## Installation

gtkmm can be downloaded from .

Remember that you will probably need to be `root` to install software. The `su` command will allow you to enter the `root` password and have `root` status temporarily.

### Dependencies

Before installing gtkmm 2.4, you should first install these other packages.

- libsigc++ 2.0

- GTK+ 2.4

And GTK+ also requires these packages.

- pkg-config

- glib

- ATK

- Pango

### Unix and Linux

#### From Source

gtkmm and its dependencies can be built and installed with the following sequence of commands:

    # ./configure
    # make
    # make install

On some systems you will need to install to a different location. For instance, on Red Hat Linux systems you might use the `--prefix` option with configure, like so:

    # ./configure --prefix=/usr

The configure script will warn you if you have not installed any of the other packages that it needs.

#### Prebuilt Packages

##### Debian GNU/Linux

On Debian GNU/Linux, gtkmm 2.4 is available in unstable/sid. You can install gtkmm by typing this on the command-line:

    apt-get install libgtkmm2.4-dev

If you use stable/woody however, you'll have to compile gtkmm yourself.

##### Red Hat Linux

RedHat do not yet provide RPMs of gtkmm. We hope they will do this soon.

##### Mandrake Linux

TODO. gtkmm is in the betas.

### Microsoft Windows

GTK+ and gtkmm were designed to work well with Microsoft Windows, and the developers encourage its use on the win32 platform. However, Windows has no standard installation system for development libraries. Please see the Windows Installation appendix for win32-specific installation instructions and notes.

## Basics

This chapter will introduce some of the most important aspects of gtkmm coding. These will be demonstrated with simple working example code. However, this is just a taster, so you need to look at the other chapters for more substantial information.

Your existing knowledge of C++ will be help you with gtkmm as it would with any library. Unless we state otherwise, you can expect gtkmm classes to behave like any other C++ class, and you can expect to use your existing C++ techniques with gtkmm classes.

### Simple Example

To begin our introduction to gtkmm, we'll start with the simplest program possible. This program will create an empty 200 x 200 pixel window.

Source location: examples/base/base.cc

We will now explain each line of the example

    #include <gtkmm.h>

All gtkmm programs must include certain gtkmm headers; `gtkmm.h` includes the entire gtkmm kit, which is usually not a good idea, since it includes a megabyte or so of headers, but for simple programs, it suffices.

The next line:

    Gtk::Main kit(argc, argv);

creates a `Gtk::Main` object. This is needed in all gtkmm applications. The constructor for this object initializes gtkmm, and checks the arguments passed to your application on the command line, looking for standard options such as `-display`. It takes these from the argument list, leaving anything it does not recognize for your application to parse or ignore. This ensures that all gtkmm applications accept the same set of standard arguments.

The next two lines of code create and display a window:

      Gtk::Window window;

The last line shows the window and enters the gtkmm main processing loop, which will finish when the window is closed.

      Gtk::Main::run(window);

After putting the source code in `simple.cc` you can compile the above program with gcc using:

    g++ simple.cc -o simple `pkg-config gtkmm-2.4 --cflags --libs`

Note that you must surround the `pkg-config` invocation with backquotes. Backquotes cause the shell to execute the command inside them, and to use the command's output as part of the command line.

Although we have shown the compilation command for this simple example, you really should use the automake and autoconf tools, as described in "Autoconf, Automake, Libtool", by G. V. Vaughan et al. The examples used in this book are included in the gtkmm package, with appropriate build files, so we won't show the build commands in future. You'll just need to find the appropriate directory and type `make`.

To simplify compilation, we use `pkg-config`, which is present in all (properly installed) gtkmm installations. This program 'knows' what compiler switches are needed to compile programs that use gtkmm. The `--cflags` option causes `pkg-config` to output a list of include directories for the compiler to look in; the `--libs` option requests the list of libraries for the compiler to link with and the directories to find them in. Try running it from your shell-prompt to see the results on your system.

### Widgets

gtkmm applications consist of windows containing widgets, such as buttons and text boxes. In some other systems, widgets are called "controls". For each widget in your application's windows, there is a C++ object in your application's code. So you just need to call a method of the widget's class to affect the visible widget.

Widgets are arranged inside container widgets such as frames and notebooks, in a hierarchy of widgets within widgets. Some of these container widgets, such as Gtk::VBox, are not visible - they exist only to arrange other widgets. Here is some example code that adds 2 Gtk::Button widgets to a Gtk::VBox container widgets:

    m_box.pack_start(m_Button1);
    m_box.pack_start(m_Button2);

and here is how to add the Gtk::VBox, containing those buttons, to a Gtk::Frame, which has a visible frame and title:

    m_frame.add(m_box);

Most of the chapters in this book deal with specific widgets. See the Container Widgets section for more details about adding widgets to container widgets.

Although you can specify the layout and appearance of windows and widgets with C++ code, you will probably find it more convenient to design your user interfaces with `Glade` and load them at runtime with `libglademm`. See the Glade and libglademm chapter.

### Signals

gtkmm, like most GUI toolkits, is event-driven. When an event occurs, such as the press of a mouse button, the appropriate signal will be emitted by the Widget that was pressed. Each Widget has a different set of signals that it can emit. To make a button click result in an action, we set up a signal handler to catch the button's "clicked" signal.

gtkmm uses the libsigc++ library to implement signals. Here is an example line of code that connects a Gtk::Button's "clicked" signal with a signal handler called "on_button_clicked":

    m_button1.signal_clicked().connect( sigc::mem_fun(*this, &HelloWorld::on_button_clicked) );

For more detailed information about signals, see the appendix.

For information about implementing your own signals rather than just connecting to the existing gtkmm signals, see the appendix.

### Glib::ustring

You might be surprised to learn that gtkmm doesn't use std::string in it its interfaces. Instead it uses Glib::ustring, which is so similar and unobtrusive that you could actually pretend that each Glib::ustring is a std::string and ignore the rest of this section. But read on if you want to use languages other than English in your application.

std::string uses 8 bit per character, but 8 bits aren't enough to encode languages such as Arabic, Chinese, and Japanese. Although the encodings for these languages has now been specified by the Unicode Constortium, the C and C++ languages do not yet provide any standardised Unicode support. GTK+ and GNOME chose to implement Unicode using UTF-8, and that's what is wrapped by Glib::ustring. It provides almost exactly the same interface as std::string, along with automatic conversions to and from std::string.

One of the benefits of UTF-8 is that you don't need to use it unless you want to, so you don't need to retrofit all of your code at once. std::string will still work for 7-bit ASCII strings. But when you try to localize your application for languages like Chinese, for instance, you will start to see strange errors, and possible crashes. Then all you need to do is start using Glib::ustring instead.

Note that UTF-8 isn't compatible with 8-bit encodings like ISO-8859-1. For instance, German umlauts are not in the ASCII range and need more than 1 byte in the UTF-8 encoding. If your code contains 8-bit string literals, you have to convert them to UTF-8 (e.g. the Bavarian greeting "Grüß Gott" would be "Gr\xC3\xBC\xC3\x9F Gott").

You should avoid C-style pointer arithmetic, and functions such as strlen(). In UTF-8, each character might need anywhere from 1 to 6 bytes, so it's not possible to assume that the next byte is another character. Glib::ustring worries about the details of this for you so you can use methods such as Glib::ustring::substr() while still thinking in terms of characters instead of bytes.

Unlike the Windows UCS-2 Unicode solution, this does not require any special compiler options to process string literals, and it does not result in Unicode executables and libraries which are incompatible with ASCII ones.

Reference

See the Internationalization section for information about providing the UTF-8 string literals.

### Intermediate types

Some parts of the `gtkmm` API use intermediate data containers, such as `Glib::StringArrayHandle` instead of a specific Standard C++ container such as `std::vector` or `std::list`. You should not declare these types yourself -- you should use whatever Standard C++ container you prefer instead. gtkmm will do the conversion for you. Here are some of these intermediate types:

- Glib::StringArrayHandle or Glib::ArrayHandle<Glib::ustring>: Use std::vector<Glib::ustring>, std::list<Glib::ustring>, const char*[], etc.

- Glib::ListHandle<Gtk::Widget*>: Use std::vector<Gtk::Widget*>, std::list<Gtk::Widget*>, etc.

- Glib::SListHandle<Gtk::Widget*>: Use std::vector<Gtk::Widget*>, std::list<Gtk::Widget*>, etc.

### Hello World in gtkmm

We've now learned enough to look at a real example. In accordance with an ancient tradition of computer science, we now introduce Hello World, a la gtkmm:

Source Code

File: helloworld.h

    #ifndef GTKMM_EXAMPLE_HELLOWORLD_H
    #define GTKMM_EXAMPLE_HELLOWORLD_H

    #include <gtkmm/button.h>
    #include <gtkmm/window.h>

    class HelloWorld : public Gtk::Window
    {

    public:
      HelloWorld();
      virtual ~HelloWorld();

    protected:
      //Signal handlers:
      virtual void on_button_clicked();

      //Member widgets:
      Gtk::Button m_button;
    };

    #endif // GTKMM_EXAMPLE_HELLOWORLD_H

File: helloworld.cc

    #include "helloworld.h"
    #include <iostream>

    HelloWorld::HelloWorld()
    : m_button("Hello World")   // creates a new button with the label "Hello World".
    {
      // Sets the border width of the window.
      set_border_width(10);

      // When the button receives the "clicked" signal, it will call the
      // hello() method. The hello() method is defined below.
      m_button.signal_clicked().connect(sigc::mem_fun(*this, &HelloWorld::on_button_clicked));

      // This packs the button into the Window (a container).
      add(m_button);

      // The final step is to display this newly created widget...
      m_button.show();
    }

    HelloWorld::~HelloWorld()
    {
    }

    void HelloWorld::on_button_clicked()
    {
      std::cout << "Hello World" << std::endl;
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "helloworld.h"

    int main (int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      HelloWorld helloworld;
      Gtk::Main::run(helloworld); //Shows the window and returns when it is closed.

      return 0;
    }

Try to compile and run it before going on. You should see something like this:

#### Hello World

Pretty thrilling, eh? Let's examine the code. First, the `HelloWorld` class:

    class HelloWorld : public Gtk::Window
    {

    public:
      HelloWorld();
      virtual ~HelloWorld();

    protected:
      //Signal handlers:
      virtual void on_button_clicked();

      //Member widgets:
      Gtk::Button m_button;
    };

This class implements the "Hello World" window. It's derived from `Gtk::Window`, and has a single `Gtk::Button` as a member. We've chosen to use the constructor to do all of the initialisation work for the window, including setting up the signals. Here it is, with the comments omitted:

    HelloWorld::HelloWorld()
    :
      m_button ("Hello World")
    {
      set_border_width(10);
      m_button.signal_clicked().connect(sigc::mem_fun(*this, &HelloWorld::on_button_clicked));
      add(m_button);.
      m_button.show();
    }

Notice that we've used an initialiser statement to give the `m&lowbar;button` object the label "Hello World".

Next we call the Window's `set&lowbar;border&lowbar;width()` method. This sets the amount of space between the sides of the window and the widget it contains.

We then hook up a signal handler to `m&lowbar;button`'s `clicked` signal. This prints our friendly greeting to `stdout`.

Next, we use the Window's `add()` method to put `m&lowbar;button` in the Window. (`add()` comes from `Gtk::Container`, which is described in the chapter on container widgets.) The `add()` method places the Widget in the Window, but it doesn't display the widget. gtkmm widgets are always invisible when you create them - to display them, you must call their `show()` method, which is what we do in the next line.

Now let's look at our program's `main()` function. Here it is, without comments:

    int main(int argc, char** argv)
    {
      Gtk::Main kit(argc, argv);

      HelloWorld helloworld;
      Gtk::Main::run(helloworld);

      return 0;
    }

First we instantiate an object called `kit`. This is of type `Gtk::Main`. Every gtkmm program must have one of these. We pass our command-line arguments to its constructor. It takes the arguments it wants, and leaves you the rest, as we described earlier.

Next we make an object of our `HelloWorld` class, whose constructor takes no arguments, but it isn't visible yet. When we call Gtk::Main::run(), giving it the helloworld Window, it shows the Window and starts the gtkmm event loop. During the event loop gtkmm idles, waiting for actions from the user, and responding appropriately. When the user closes the Window, run() will return, causing the final line of our main() function be to executed. The application will then finish.

## Buttons

gtkmm provides four basic types of buttons:

Push-Buttons

  `Gtk::Button`. Standard buttons, usually marked with a label or picture. Pushing one triggers an action. See the Button section.

Toggle buttons

  `Gtk::ToggleButton`. Unlike a normal Button, which springs back up, a ToggleButton stays down until you press it again. It might be useful as an on/off switch. See the ToggleButton section.

Checkboxes

  `Gtk::CheckButton`. These act like ToggleButtons, but show their state in small squares, with their label at the side. They should be used in most situations which require an on/off setting. See the CheckBox section.

Radio buttons

  `Gtk::RadioButton`. Named after the station selectors on old car radios, these buttons are used in groups for options which are mutually exclusive. Pressing one causes all the others in its group to turn off. They are similar to CheckBoxes (a small widget with a label at the side), but usually look different. See the RadioButton section.

Note that, due to GTK+'s theming system, the appearance of these widgets will vary. In the case of checkboxes and radio buttons, they may vary considerably.

### Button

#### Constuctors

There are two ways to create a Button. You can specify a label string in the `Gtk::Button` constructor, or set it later with `set_label()`.

To define an accelerator key for keyboard navigation, place an underscore before one of the label's characters and specify `true` for the optional `mnemonic` parameter. For instance:

    Gtk::Button* pButton = new Gtk::Button("_Something", true);

Wherever possible you should use Stock items, to ensure consistency with other applications, and to improve the appearance of your applications by using icons. For instance,

    Gtk::Button* pButton = new Gtk::Button(Gtk::Stock::OK);

This will use standard text, in all languages, with standard keyboard accelerators, with a standard icon.

`Gtk::Button` is also a container so you could put any other widget, such as a `Gtk::Image` into it.

Reference

#### Example

This example creates a button with a picture and a label.

##### buttons example

Source Code

File: buttons.h

    #ifndef GTKMM_EXAMPLE_BUTTONS_H
    #define GTKMM_EXAMPLE_BUTTONS_H

    #include <gtkmm/window.h>
    #include <gtkmm/button.h>

    class Buttons : public Gtk::Window
    {
    public:
      Buttons();
      virtual ~Buttons();

    protected:
      //Signal handlers:
      virtual void on_button_clicked();

      //Child widgets:
      Gtk::Button m_button;
    };

    #endif //GTKMM_EXAMPLE_BUTTONS_H

File: buttons.cc

    #include "buttons.h"
    #include <iostream>

    Buttons::Buttons()
    {
      m_button.add_pixlabel("info.xpm", "cool button");

      set_title("Pixmap'd buttons!");
      set_border_width(10);

      m_button.signal_clicked().connect( sigc::mem_fun(*this, &Buttons::on_button_clicked) );

      add(m_button);

      show_all_children();
    }

    Buttons::~Buttons()
    {
    }

    void Buttons::on_button_clicked()
    {
      std::cout << "The Button was clicked." << std::endl;
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "buttons.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      Buttons buttons;
      Gtk::Main::run(buttons); //Shows the window and returns when it is closed.

      return 0;
    }

Note that the `XPMLabelBox` class can be used to place XPMs and labels into any widget that can be a container.

#### Signals

The `Gtk::Button` widget has the following signals, but most of the time you will just handle the `clicked` signal:

`pressed`

  Emitted when the button is pressed.

`released`

  Emitted when the button is released.

`clicked`

  Emitted when the button is pressed and released.

`enter`

  Emitted when the mouse pointer moves over the button's window.

`leave`

  Emitted when the mouse pointer leaves the button's window.

### ToggleButton

`ToggleButton`s are like normal `Button`s, but when clicked they remain activated, or pressed, until clicked again.

To retrieve the state of the `ToggelButton`, you can use the `get&lowbar;active()` method. This returns `true` if the button is "down". You can also set the toggle button's state, with `set&lowbar;active()`. Note that, if you do this, and the state actually changes, it causes the "clicked" signal to be emitted. This is usually what you want.

You can use the `toggled()` method to toggle the button, rather than forcing it to be up or down: This switches the button's state, and causes the `toggled` signal to be emitted.

`Gtk::ToggleButton` is most useful as a base class for the `Gtk::CheckButton` and `Gtk::RadioButton` classes.

Reference

### CheckButton

`Gtk::CheckButton` inherits from `Gtk::ToggleButton`. The only real difference between the two is `Gtk::CheckButton`'s appearance. You can check, set, and toggle a checkbox using the same member methods as for `Gtk::ToggleButton`.

Reference

#### Example

##### CheckButton

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLE_BUTTONS_H
    #define GTKMM_EXAMPLE_BUTTONS_H

    #include <gtkmm/window.h>
    #include <gtkmm/checkbutton.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_clicked();

      //Child widgets:
      Gtk::CheckButton m_button;
    };

    #endif //GTKMM_EXAMPLE_BUTTONS_H

File: examplewindow.cc

    #include "examplewindow.h"
    #include <iostream>

    ExampleWindow::ExampleWindow()
    : m_button("something")
    {
      set_title("checkbutton example");
      set_border_width(10);

      m_button.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_clicked) );

      add(m_button);

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_clicked()
    {
      std::cout << "The Button was clicked: state=" << (m_button.get_active() ? "true" : "false")  << std::endl;
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

### RadioButton

Like checkboxes, radio buttons also inherit from `Gtk::ToggleButton`, but these work in groups, and only one RadioButton in a group can be selected at any one time.

#### Groups

There are two ways to set up a group of radio buttons. The first way is to create the buttons, and set up their groups afterwards. Only the first two constructors are used. In the following example, we make a new window class called `RadioButtons`, and then put three radio buttons in it:

      class RadioButtons : public Gtk::Window
      {
      public:
          RadioButtons();

      protected:
          Gtk::RadioButton m_rb1, m_rb2, m_rb3;
      };

      RadioButtons::RadioButtons()
        : m_rb1("button1"),
          m_rb2("button2"),
          m_rb3("button3")
      {
          Gtk::RadioButton::Group group = m_rb1.get_group();
          m_rb2.set_group(group);
          m_rb3.set_group(group);
      }

We told gtkmm to put all three `RadioButton`s in the same group by obtaining the group with `get_group()` and using `set_group()` to tell the othe `RadioButton`s to share that group.

Note that you can't just do

    m_rb2.set_group(m_rb1.get_group()); //doesn't work

because the group is modified by `set_group()` and therefore non-const.

The second way to set up radio buttons is to make a group first, and then add radio buttons to it. Here's an example:

      class RadioButtons : public Gtk::Window
      {
      public:
          RadioButtons();
      };

      RadioButtons::RadioButtons()
      {
          Gtk::RadioButton::Group group;
          Gtk::RadioButton *m_rb1 = manage( new Gtk::RadioButton(group,"button1"));
          Gtk::RadioButton *m_rb2 = manage( new Gtk::RadioButton(group,"button2"));
          Gtk::RadioButton *m_rb3 = manage( new Gtk::RadioButton(group,"button3"));
      }

We made a new group by simply declaring a variable, `group`, of type `Gtk::RadioButton::Group`. Then we made three radio buttons, using a constructor to make each of them part of `group`.

#### Methods

`RadioButtons` are "off" when created; this means that when you first make a group of them, they will all be off. Don't forget to turn one of them on using `set&lowbar;active()`:

Reference

#### Example

The following example demonstrates the use of `RadioButton`s:

##### RadioButton

Source Code

File: radiobuttons.h

    #ifndef GTKMM_EXAMPLE_RADIOBUTTONS_H
    #define GTKMM_EXAMPLE_RADIOBUTTONS_H

    #include <gtkmm/window.h>
    #include <gtkmm/radiobutton.h>
    #include <gtkmm/box.h>
    #include <gtkmm/separator.h>

    class RadioButtons : public Gtk::Window
    {
    public:
      RadioButtons();
      virtual ~RadioButtons();

    protected:
      //Signal handlers:
      virtual void on_button_clicked();

      //Child widgets:
      Gtk::VBox m_Box_Top, m_Box1, m_Box2;
      Gtk::RadioButton m_RadioButton1, m_RadioButton2, m_RadioButton3;
      Gtk::HSeparator m_Separator;
      Gtk::Button m_Button_Close;
    };

    #endif //GTKMM_EXAMPLE_RADIOBUTTONS_H

File: main.cc

    #include <gtkmm/main.h>
    #include "radiobuttons.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      RadioButtons buttons;
      Gtk::Main::run(buttons); //Shows the window and returns when it is closed.

      return 0;
    }

File: radiobuttons.cc

    #include "radiobuttons.h"

    RadioButtons::RadioButtons() :
      m_Box1(false, 10),
      m_Box2(false, 10),
      m_RadioButton1("button1"),
      m_RadioButton2("button2"),
      m_RadioButton3("button3"),
      m_Button_Close("close")
    {
      set_title("radio buttons");
      set_border_width(0);

      //Put radio buttons 2 and 3 in the same group as 1:
      Gtk::RadioButton::Group group = m_RadioButton1.get_group();
      m_RadioButton2.set_group(group);
      m_RadioButton3.set_group(group);

      add(m_Box_Top);

      //Put Box1 in m_Box_Top:
      m_Box1.set_border_width(10);
      m_Box_Top.pack_start(m_Box1);

      //Put the radio buttons in Box1:
      m_Box1.pack_start(m_RadioButton1);
      m_Box1.pack_start(m_RadioButton2);
      m_Box1.pack_start(m_RadioButton3);
      m_RadioButton2.set_active();

      //Add a separator:
      m_Box_Top.pack_start(m_Separator, Gtk::PACK_SHRINK);

      //Put Box2 in m_Box_Top:
      m_Box2.set_border_width(10);
      m_Box_Top.pack_start(m_Box2, Gtk::PACK_SHRINK);

      //Put Close button in Box2:
      m_Box2.pack_start(m_Button_Close);
      m_Button_Close.set_flags(Gtk::CAN_DEFAULT);
      m_Button_Close.grab_default();

      m_Button_Close.signal_clicked().connect( sigc::mem_fun(*this, &RadioButtons::on_button_clicked) );

      show_all_children();
    }

    RadioButtons::~RadioButtons()
    {
    }

    void RadioButtons::on_button_clicked()
    {
      hide(); //to close the application.
    }

## Range Widgets

`Gtk::Scale` and `Gtk::Scrollbar` both inherit from `Gtk::Range` and share much functionality. They contain a "trough" and a "slider" (sometimes called a "thumbwheel" in other GUI environments). Dragging the slider with the pointer moves it within the trough, while clicking in the trough advances the slider towards the location of the click, either completely, or by a designated amount, depending on which mouse button is used. This should be familiar scrollbar behaviour.

As will be explained in the Adjustment section, all Range widgets are associated with a `Adjustment` object. To change the lower, upper, and current values used by the widget you need to use the methods of its `Adjustment`, which you can get with the `get_adjustment()` method. The `Range` widgets' default constructors create an `Adjustment` automatically, or you can specify an existing `Adjustment`, maybe to share it with another widget. See the Adjustments section for further details

Reference

### Scrollbar Widgets

These are standard scrollbars. They should be used only to scroll another widget, such as, a `Gtk::Entry`, or a `Gtk::Viewport`, though it's usually easier to use the `Gtk::ScrolledWindow` widget in most cases.

There are horizontal and vertical scrollbar classes - `Gtk::HScrollbar` and `Gtk::VScrollbar`.

Reference

### Scale Widgets

`Gtk::Scale` widgets (or "sliders") allow the user to visually select and manipulate a value within a specific range. You might use one, for instance, to adjust the magnification level on a zoomed preview of a picture, or to control the brightness of a colour, or to specify the number of minutes of inactivity before a screensaver takes over the screen.

As with `Scrollbars`, there are separate widget types for horizontal and vertical widgets - `Gtk::HScale` and `Gtk::VScale`. The default constructors create an `Adjustment` with all of its values set to `0.0`. This isn't useful so you will need to set some `Adjustment` details to get meaningful behaviour.

#### Useful methods

`Scale` widgets can display their current value as a number next to the trough. By default they show the value, but you can change this with the `set_draw_value()` method.

The value displayed by a scale widget is rounded to one decimal point by default, as is the `value` field in its `Gtk::Adjustment`. You can change this with the `set_digits()` method.

Also, the value can be drawn in different positions relative to the trough, specified by the `set_value_pos()` method.

Reference

### Update Policies

The update policy of a `Range` widget defines at what points during user interaction it will change the `value` field of its `Gtk::Adjustment` and emit the `value&lowbar;changed` signal. The update policies, set with the `set_update_policy()` method, are:

- `Gtk::UPDATE&lowbar;CONTINUOUS` - This is the default. The `value&lowbar;changed` signal is emitted continuously, i.e. whenever the slider is moved by even the tiniest amount.

- `Gtk::UPDATE&lowbar;DISCONTINUOUS` - The `value&lowbar;changed` signal is only emitted once the slider has stopped moving and the user has released the mouse button.

- `Gtk::UPDATE&lowbar;DELAYED` - The `value&lowbar;changed` signal is emitted when the user releases the mouse button, or if the slider stops moving for a short period of time.

### Example

This example displays a window with three range widgets all connected to the same adjustment, along with a couple of controls for adjusting some of the parameters mentioned above and in the section on adjustments, so you can see how they affect the way these widgets work for the user.

#### Range Widgets

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLE_RANGEWIDGETS_H
    #define GTKMM_EXAMPLE_RANGEWIDGETS_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_checkbutton_toggled();
      virtual void on_menu_position(Gtk::PositionType type);
      virtual void on_menu_policy(Gtk::UpdateType type);
      virtual void on_adjustment1_value_changed();
      virtual void on_adjustment2_value_changed();
      virtual void on_button_quit();

      //Child widgets:
      Gtk::VBox m_VBox_Top, m_VBox2, m_VBox_HScale;
      Gtk::HBox m_HBox_Scales, m_HBox_Digits, m_HBox_PageSize;

      Gtk::Adjustment m_adjustment, m_adjustment_digits, m_adjustment_pagesize;

      Gtk::VScale m_VScale;
      Gtk::HScale m_HScale, m_Scale_Digits, m_Scale_PageSize;

      Gtk::HSeparator m_Separator;

      Gtk::CheckButton m_CheckButton;

      Gtk::HScrollbar m_Scrollbar;

      Gtk::Menu m_Menu_Position, m_Menu_Policy;

      Gtk::Button m_Button_Quit;
    };

    #endif //GTKMM_EXAMPLE_RANGEWIDGETS_H

File: labeledoptionmenu.h

    #ifndef GTKMM_EXAMPLE_RANGEWIDGETS_LABELEDOPTIONMENU_H
    #define GTKMM_EXAMPLE_RANGEWIDGETS_LABELEDOPTIONMENU_H

    #include <gtkmm.h>

    class LabeledOptionMenu : public Gtk::HBox
    {
    public:
      LabeledOptionMenu(const Glib::ustring& menu_title, Gtk::Menu& menu,
        bool homogeneous = false, int spacing = 10);

    protected:
        Gtk::Label m_label;
        Gtk::OptionMenu m_OptionMenu;
        Gtk::Menu* m_pMenu;
    };
    #endif //GTKMM_EXAMPLE_RANGEWIDGETS_LABELEDOPTIONMENU_H

File: examplewindow.cc

    #include "examplewindow.h"
    #include "labeledoptionmenu.h"
    #include <iostream>

    ExampleWindow::ExampleWindow()
    :
      m_VBox2(false, 20),
      m_VBox_HScale(false, 10),
      m_HBox_Scales(false, 10),
      m_HBox_Digits(false, 10),
      m_HBox_PageSize(false, 10),

      // value, lower, upper, step_increment, page_increment, page_size
      // note that the page_size value only makes a difference for
      // scrollbar widgets, and the highest value you'll get is actually
      // (upper - page_size).
      m_adjustment(0.0, 0.0, 101.0, 0.1, 1.0, 1.0),
      m_adjustment_digits(1.0, 0.0, 5.0),
      m_adjustment_pagesize(1.0, 1.0, 101.0),

      m_VScale(m_adjustment),
      m_HScale(m_adjustment),
      m_Scale_Digits(m_adjustment_digits),
      m_Scale_PageSize(m_adjustment_pagesize),

      // a checkbutton to control whether the value is displayed or not
      m_CheckButton("Display value on scale widgets", 0),

      // reuse the same adjustment again
      m_Scrollbar(m_adjustment),
      // notice how this causes the scales to always be update
      // continuously when the scrollbar is moved

      m_Button_Quit("Quit")
    {
      set_title("range controls");

      //VScale:
      m_VScale.set_update_policy(Gtk::UPDATE_CONTINUOUS);
      m_VScale.set_digits(1);
      m_VScale.set_value_pos(Gtk::POS_TOP);
      m_VScale.set_draw_value();

      //HScale:
      m_HScale.set_update_policy(Gtk::UPDATE_CONTINUOUS);
      m_HScale.set_digits(1);
      m_HScale.set_value_pos(Gtk::POS_TOP);
      m_HScale.set_draw_value();
      m_HScale.set_size_request(200, 30);

      add(m_VBox_Top);
      m_VBox_Top.pack_start(m_VBox2);
      m_VBox2.set_border_width(10);
      m_VBox2.pack_start(m_HBox_Scales);

      //Put VScale and HScale (above scrollbar) side-by-side.
      m_HBox_Scales.pack_start(m_VScale);
      m_HBox_Scales.pack_start(m_VBox_HScale);

      m_VBox_HScale.pack_start(m_HScale);

      //Scrollbar:
      m_Scrollbar.set_update_policy(Gtk::UPDATE_CONTINUOUS);
      m_VBox_HScale.pack_start(m_Scrollbar);

      //CheckButton:
      m_CheckButton.set_active();
      m_CheckButton.signal_toggled().connect( sigc::mem_fun(*this, &ExampleWindow::on_checkbutton_toggled) );
      m_VBox2.pack_start(m_CheckButton);

      //OptionMenus:
      {
          using namespace Gtk::Menu_Helpers;

          MenuList& list_vpos = m_Menu_Position.items();
          list_vpos.push_back(
            MenuElem("Top", sigc::bind( sigc::mem_fun(*this, &ExampleWindow::on_menu_position), Gtk::POS_TOP)) );
          list_vpos.push_back(
            MenuElem("Bottom", sigc::bind( sigc::mem_fun(*this, &ExampleWindow::on_menu_position), Gtk::POS_BOTTOM)) );
          list_vpos.push_back(
            MenuElem("Left", sigc::bind( sigc::mem_fun(*this, &ExampleWindow::on_menu_position), Gtk::POS_LEFT)) );
          list_vpos.push_back(
            MenuElem("Right", sigc::bind( sigc::mem_fun(*this, &ExampleWindow::on_menu_position), Gtk::POS_RIGHT)) );

          m_VBox2.pack_start( *Gtk::manage(new LabeledOptionMenu("Scale Value Position:", m_Menu_Position)) );

          MenuList& list_upd = m_Menu_Policy.items();
          list_upd.push_back(
            MenuElem("Continuous", sigc::bind( sigc::mem_fun(*this, &ExampleWindow::on_menu_policy), Gtk::UPDATE_CONTINUOUS)) );
          list_upd.push_back(
            MenuElem("Discontinuous", sigc::bind( sigc::mem_fun(*this, &ExampleWindow::on_menu_policy), Gtk::UPDATE_DISCONTINUOUS)) );
          list_upd.push_back(
            MenuElem("Delayed", sigc::bind( sigc::mem_fun(*this, &ExampleWindow::on_menu_policy), Gtk::UPDATE_DELAYED)) );

          m_VBox2.pack_start( *Gtk::manage(new LabeledOptionMenu("Scale Update Policy:", m_Menu_Policy)) );
      }

      //Digits:
      m_HBox_Digits.pack_start(*Gtk::manage(new Gtk::Label("Scale Digits:", 0)),  Gtk::PACK_SHRINK);
      m_Scale_Digits.set_digits(0);
      m_adjustment_digits.signal_value_changed().connect( sigc::mem_fun(*this, &ExampleWindow::on_adjustment1_value_changed) );
      m_HBox_Digits.pack_start(m_Scale_Digits);

      //Page Size:
      m_HBox_PageSize.pack_start(*Gtk::manage(new Gtk::Label("Scrollbar Page Size:", 0)), Gtk::PACK_SHRINK);
      m_Scale_PageSize.set_digits(0);
      m_adjustment_pagesize.signal_value_changed().connect( sigc::mem_fun(*this, &ExampleWindow::on_adjustment2_value_changed) );
      m_HBox_PageSize.pack_start(m_Scale_PageSize);

      m_VBox2.pack_start(m_HBox_Digits);
      m_VBox2.pack_start(m_HBox_PageSize);
      m_VBox_Top.pack_start(m_Separator, Gtk::PACK_SHRINK);
      m_VBox_Top.pack_start(m_Button_Quit, Gtk::PACK_SHRINK);

      m_Button_Quit.set_flags(Gtk::CAN_DEFAULT);
      m_Button_Quit.grab_default();
      m_Button_Quit.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_quit) );
      m_Button_Quit.set_border_width(10);

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_checkbutton_toggled()
    {
        m_VScale.set_draw_value(m_CheckButton.get_active());
        m_HScale.set_draw_value(m_CheckButton.get_active());
    }

    void ExampleWindow::on_menu_position(Gtk::PositionType postype)
    {
        m_VScale.set_value_pos(postype);
        m_HScale.set_value_pos(postype);
    }

    void ExampleWindow::on_menu_policy(Gtk::UpdateType type)
    {
        m_VScale.set_update_policy(type);
        m_HScale.set_update_policy(type);
    }

    void ExampleWindow::on_adjustment1_value_changed()
    {
        double val = m_adjustment_digits.get_value();
        m_VScale.set_digits((int)val);
        m_HScale.set_digits((int)val);
    }

    void ExampleWindow::on_adjustment2_value_changed()
    {
        double val = m_adjustment_pagesize.get_value();
        m_adjustment.set_page_size((int)val);
        m_adjustment.set_page_increment((int)val);

        // note that we don't have to emit the "changed" signal;
        // gtkmm does this for us
    }

    void ExampleWindow::on_button_quit()
    {
      hide();
    }

File: labeledoptionmenu.cc

    #include "labeledoptionmenu.h"

    LabeledOptionMenu::LabeledOptionMenu(const Glib::ustring& menu_title, Gtk::Menu& menu, bool homogeneous, int spacing) :
        Gtk::HBox(homogeneous, spacing),
        m_label(menu_title),
        m_pMenu(&menu)
    {
      pack_start(m_label, Gtk::PACK_SHRINK);

      m_OptionMenu.set_menu(*m_pMenu);
      pack_start(m_OptionMenu);
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

## Miscellaneous Widgets

### Label

Labels are the main method of placing non-editable text in windows, for instance to place a title next to a `Entry` widget. You can specify the text in the constructor, or with the `set_text()` method.

The width of the label will be adjusted automatically. You can produce multi-line labels by putting line breaks ("\n") in the label string.

The label text can be justified using the `set_justify()` method. The widget is also capable of word-wrapping - this can be activated with `set_line_wrap()`.

TODO: gtkmm2: markup.

Reference

#### Example

Below is a short example to illustrate these functions. This example makes use of the Frame widget to better demonstrate the label styles. (The Frame widget is explained in the Frame section.)

##### Label

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:

      //Child widgets:
      Gtk::HBox m_HBox;
      Gtk::VBox m_VBox, m_VBox2;
      Gtk::Frame m_Frame_Normal, m_Frame_Multi, m_Frame_Left, m_Frame_Right,
        m_Frame_LineWrapped, m_Frame_FilledWrapped, m_Frame_Underlined;
      Gtk::Label m_Label_Normal, m_Label_Multi, m_Label_Left, m_Label_Right,
        m_Label_LineWrapped, m_Label_FilledWrapped, m_Label_Underlined;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include "examplewindow.h"
    #include <iostream>

    ExampleWindow::ExampleWindow()
    :
      m_HBox(false, 5),
      m_VBox(false, 5),
      m_Frame_Normal("Normal Label"),
      m_Frame_Multi("Multi-line Label"),
      m_Frame_Left("Left Justified Label"),
      m_Frame_Right("Right Justified Label"),
      m_Frame_LineWrapped("Line wrapped label"),
      m_Frame_FilledWrapped("Filled, wrapped label"),
      m_Frame_Underlined("Underlined label"),
      m_Label_Normal("_This is a Normal label", true),
      m_Label_Multi("This is a Multi-line label.\nSecond line\nThird line"),
      m_Label_Left("This is a Left-Justified\nMulti-line label.\nThird line"),
      m_Label_Right("This is a Right-Justified\nMulti-line label.\nFourth line, (j/k)"),
      m_Label_Underlined("This label is underlined!\nThis one is underlined in quite a funky fashion")
    {
      set_title("Label");
      set_border_width(5);

      add(m_HBox);

      m_HBox.pack_start(m_VBox, Gtk::PACK_SHRINK);

      m_Frame_Normal.add(m_Label_Normal);
      m_VBox.pack_start(m_Frame_Normal, Gtk::PACK_SHRINK);

      m_Frame_Multi.add(m_Label_Multi);
      m_VBox.pack_start(m_Frame_Multi, Gtk::PACK_SHRINK);

      m_Label_Left.set_justify(Gtk::JUSTIFY_LEFT);
      m_Frame_Left.add(m_Label_Left);
      m_VBox.pack_start(m_Frame_Left, Gtk::PACK_SHRINK);

      m_Label_Right.set_justify(Gtk::JUSTIFY_RIGHT);
      m_Frame_Right.add(m_Label_Right);
      m_VBox.pack_start(m_Frame_Right, Gtk::PACK_SHRINK);

      m_HBox.pack_start(m_VBox2, Gtk::PACK_SHRINK);

      m_Label_LineWrapped.set_text("This is an example of a line-wrapped label.  It " \
        "should not be taking up the entire             " /* big space to test spacing */\
        "width allocated to it, but automatically " \
        "wraps the words to fit.  " \
        "The time has come, for all good men, to come to " \
        "the aid of their party.  " \
        "The sixth sheik's six sheep's sick.\n" \
        "     It supports multiple paragraphs correctly, " \
        "and  correctly   adds "\
        "many          extra  spaces. ");
      m_Label_LineWrapped.set_line_wrap();
      m_Frame_LineWrapped.add(m_Label_LineWrapped);
      m_VBox2.pack_start(m_Frame_LineWrapped, Gtk::PACK_SHRINK);

      m_Label_FilledWrapped.set_text("This is an example of a line-wrapped, filled label.  " \
        "It should be taking " \
        "up the entire              width allocated to it.  " \
        "Here is a sentence to prove "\
        "my point.  Here is another sentence. "\
        "Here comes the sun, do de do de do.\n"\
        "    This is a new paragraph.\n"\
        "    This is another newer, longer, better " \
        "paragraph.  It is coming to an end, "\
        "unfortunately.");
      m_Label_FilledWrapped.set_justify(Gtk::JUSTIFY_FILL);
      m_Label_FilledWrapped.set_line_wrap();
      m_Frame_FilledWrapped.add(m_Label_FilledWrapped);
      m_VBox2.pack_start(m_Frame_FilledWrapped, Gtk::PACK_SHRINK);

      m_Label_Underlined.set_justify(Gtk::JUSTIFY_LEFT);
      m_Label_Underlined.set_pattern ("_________________________ _ _________ _ ______     __ _______ ___");
      m_Frame_Underlined.add(m_Label_Underlined);
      m_VBox2.pack_start(m_Frame_Underlined, Gtk::PACK_SHRINK);

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

### Entry

Entry widgets allow the user to enter text (surprisingly enough).

You can change the contents with the `set_text()` method, and read the current contents with the `get_text()` method.

Occasionally you might want to make an `Entry` widget read-only. This can be done by passing `false` to the `set_editable()` method.

For the input of passwords, passphrases and other information you don't want echoed on the screen, calling `set_visibility()` with `false` will cause the text to be hidden.

You might want to be notified whenever the user types in a text entry widget. `Gtk::Entry` provides two signals, `activate` and `changed`, for just this purpose. `activate` is emitted when the user presses the enter key in a text-entry widget; `changed` is emitted when the text in the widget changes. You can use these, for instance, to validate or filter the text the user types.

Reference

#### Example

Here is an example using `Gtk::Entry`. As well as a `Gtk::Entry` widget, it has two `CheckButton`s, with which you can toggle the editable and visible flags.

##### Entry

Source Code

### Combo

A `Combo` is a combination of a text entry and a popup menu. Clicking on one of the menu entries puts it in the entry box. The entry box otherwise works just like a regular `Entry` widget.

A `Gtk::Combo` contains a `Gtk::Entry` widget, which is used to implement the entry box. You can obtain the `Gtk::Entry` using `get_entry()` method.

To set the values in the popup menu, use

    void Gtk::Combo::set_popdown_strings(const Gtk::SArray& strings);

where `strings` is a list of the strings you want to appear in the list. As mentioned in the Basics section, `Gtk::SArray` is a converter object which can take any kind of STL vector container. This means that you can pass vectors or lists to this method, and things will work as you expect. For example, the following is legal:

    list<string> gl;

    gl.push_back("String 1");
    gl.push_back("String 2");
    gl.push_back("String 3");
    gl.push_back("String 4");

    combo.set_popdown_strings(gl);

TODO: STL-style access.

Reference

#### Example

##### Combo

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm/window.h>
    #include <gtkmm/combo.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_combo_changed();

      //Child widgets:
      Gtk::Combo m_Combo;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include "examplewindow.h"
    #include <gtkmm/stock.h>
    #include <iostream>

    ExampleWindow::ExampleWindow()
    {
      set_title("combo example");

      //Fill the combo:
      std::list<Glib::ustring> listStrings;
      listStrings.push_back("something");
      listStrings.push_back("something else");
      listStrings.push_back("something or other");
      m_Combo.set_popdown_strings(listStrings);

      //Create a mixed entry an add it to the combo's list using the advanced interface ComboDropDown:
      Gtk::ComboDropDownItem* item = Gtk::manage(new Gtk::ComboDropDownItem);

      Gtk::HBox* hbox = Gtk::manage(new Gtk::HBox(false, 3));
      hbox->pack_start(*Gtk::manage(new Gtk::Image(Gtk::Stock::CLEAR, Gtk::ICON_SIZE_MENU)), Gtk::PACK_SHRINK);
      hbox->pack_start(*Gtk::manage(new Gtk::Label("some image - cool!")), Gtk::PACK_SHRINK);

      item->add(*hbox);
      item->show_all();
      m_Combo.get_list()->children().push_back(*item);
      m_Combo.set_item_string(*item, "you selected the image!");

      //Restrict it to these choices only:
      m_Combo.set_value_in_list();

      add(m_Combo);

      //Connect signal handler:
      m_Combo.get_entry()->signal_changed().connect( sigc::mem_fun(*this, &ExampleWindow::on_combo_changed) );

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_combo_changed()
    {
      Gtk::Entry* pEntry = m_Combo.get_entry();
      if(pEntry)
      {
        Glib::ustring text = pEntry->get_text();
        if(!(text.empty())) //We seem to get 2 signals, one when the text is empty.
          std::cout << "Combo changed: " << text << std::endl;
      }
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

### SpinButton

A `SpinButton` allows the user to select a value from a range of numeric values. It has an Entry widget with up and down arrow buttons at the side. Clicking the buttons causes the value to 'spin' up and down across the range of possible values. The `Entry` widget may also be used to enter a value directly.

The value can have an adjustable number of decimal places, and the step size is configurable. `SpinButton`s have an 'auto-repeat' feature as well: holding down one of the arrows can optionally cause the value to change more quickly the longer the arrow is held down.

`SpinButton`s use an Adjustment object to hold information about the range of values. These Adjustment attributes are used by the Spin Button like so:

- `value`: value for the Spin Button

- `lower`: lower range value

- `upper`: upper range value

- `step&lowbar;increment`: value to increment/decrement when pressing mouse button 1 on a button

- `page&lowbar;increment`: value to increment/decrement when pressing mouse button 2 on a button

- `page&lowbar;size`: unused

Additionally, mouse button 3 can be used to jump directly to the `upper` or `lower` values.

The `SpinButton` can create a default `Adjustment`, which you can access via the `get_adjustment()` method, or you can specify an existing `Adjustment` in the constructor.

#### Methods

The number of decimal places can be altered using the `set_digits()` method.

You can set the spinbutton's value using the `set_value()` method, and retrieve it with `get_value()`.

The `spin()` method 'spins' the `SpinButton`, as if one of its arrows had been clicked. You need to specify a `Gtk::SpinType` to specify the direction or new position.

To prevent the user from typing non-numeric characters into the entry box, pass `true` to the `set_numeric()` method.

To make the `SpinButton` 'wrap' between its upper and lower bounds, use the `set_wrap()` method.

To force it to snap to the nearest `step&lowbar;increment`, use `set_snap_to_ticks`

You can modify the update policy using the `set_update_policy` method, specifying either `Gtk::UPDATE_ALWAYS` or `Gtk::UPDATE_IF_VALID`. `Gtk::UPDATE&lowbar;ALWAYS` causes the `SpinButton` to ignore errors encountered while converting the text in the entry box to a numeric value. This setting also therefore allows the `SpinButton` to accept non-numeric values. You can force an immediate update using the `update()` method.

Reference

#### Example

Here's an example of a `SpinButton` in action:

##### SpinButton

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_checkbutton_snap();
      virtual void on_checkbutton_numeric();
      virtual void on_spinbutton_digits_changed();
      virtual void on_button_close();

      enum enumValueFormats
      {
        VALUE_FORMAT_INT,
        VALUE_FORMAT_FLOAT
      };
      virtual void on_button_getvalue(enumValueFormats display);

      //Child widgets:
      Gtk::Frame m_Frame_NotAccelerated, m_Frame_Accelerated;
      Gtk::HBox m_HBox_NotAccelerated, m_HBox_Accelerated,
        m_HBox_Buttons;
      Gtk::VBox m_VBox_Main, m_VBox, m_VBox_Day, m_VBox_Month, m_VBox_Year,
        m_VBox_Accelerated, m_VBox_Value, m_VBox_Digits;
      Gtk::Label m_Label_Day, m_Label_Month, m_Label_Year,
        m_Label_Value, m_Label_Digits,
        m_Label_ShowValue;
      Gtk::Adjustment m_adjustment_day, m_adjustment_month, m_adjustment_year,
        m_adjustment_value, m_adjustment_digits;
      Gtk::SpinButton m_SpinButton_Day, m_SpinButton_Month, m_SpinButton_Year,
        m_SpinButton_Value, m_SpinButton_Digits;
      Gtk::CheckButton m_CheckButton_Snap, m_CheckButton_Numeric;
      Gtk::Button m_Button_Int, m_Button_Float, m_Button_Close;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include "examplewindow.h"
    #include <iostream>
    #include <stdio.h>

    ExampleWindow::ExampleWindow()
    :
      m_Frame_NotAccelerated("Not accelerated"),
      m_Frame_Accelerated("Accelerated"),
      m_VBox_Main(false, 5),
      m_Label_Day("Day: "), m_Label_Month("Month: "), m_Label_Year("Year: "),
      m_Label_Value("Value: "),
      m_Label_Digits("Digits: "),
      m_adjustment_day(1.0, 1.0, 31.0, 1.0, 5.0, 0.0),
      m_adjustment_month(1.0, 1.0, 12.0, 1.0, 5.0, 0.0),
      m_adjustment_year(1998.0, 0.0, 2100.0, 1.0, 100.0, 0.0),
      m_adjustment_value(0.0, -10000.0, 10000.0, 0.5, 100.0, 0.0),
      m_adjustment_digits(2.0, 1.0, 5.0, 1.0, 1.0, 0.0),
      m_SpinButton_Day(m_adjustment_day),
      m_SpinButton_Month(m_adjustment_month),
      m_SpinButton_Year(m_adjustment_year),
      m_SpinButton_Value(m_adjustment_value, 1.0, 2),
      m_SpinButton_Digits(m_adjustment_digits),
      m_CheckButton_Snap("Snap to 0.5-ticks"),
      m_CheckButton_Numeric("Numeric only input mode"),
      m_Button_Int("Value as Int"),
      m_Button_Float("Value as Float"),
      m_Button_Close("Close")
    {
      set_title("SpinButton");

      m_VBox_Main.set_border_width(10);
      add(m_VBox_Main);

      m_VBox_Main.pack_start(m_Frame_NotAccelerated);

      m_VBox.set_border_width(5);
      m_Frame_NotAccelerated.add(m_VBox);

      /* Day, month, year spinners */

      m_VBox.pack_start(m_HBox_NotAccelerated, Gtk::PACK_EXPAND_WIDGET, 5);

      m_Label_Day.set_alignment(Gtk::ALIGN_LEFT);
      m_VBox_Day.pack_start(m_Label_Day);

      m_SpinButton_Day.set_wrap();

      m_VBox_Day.pack_start(m_SpinButton_Day);

      m_HBox_NotAccelerated.pack_start(m_VBox_Day, Gtk::PACK_EXPAND_WIDGET, 5);

      m_Label_Month.set_alignment(Gtk::ALIGN_LEFT);
      m_VBox_Month.pack_start(m_Label_Month);

      m_SpinButton_Month.set_wrap();
      m_VBox_Month.pack_start(m_SpinButton_Month);

      m_HBox_NotAccelerated.pack_start(m_VBox_Month, Gtk::PACK_EXPAND_WIDGET, 5);

      m_Label_Year.set_alignment(Gtk::ALIGN_LEFT);
      m_VBox_Year.pack_start(m_Label_Year);

      m_SpinButton_Year.set_wrap();
      m_SpinButton_Year.set_size_request(55, -1);
      m_VBox_Year.pack_start(m_SpinButton_Year);

      m_HBox_NotAccelerated.pack_start(m_VBox_Year, Gtk::PACK_EXPAND_WIDGET, 5);

      //Accelerated:
      m_VBox_Main.pack_start(m_Frame_Accelerated);

      m_VBox_Accelerated.set_border_width(5);
      m_Frame_Accelerated.add(m_VBox_Accelerated);

      m_VBox_Accelerated.pack_start(m_HBox_Accelerated, Gtk::PACK_EXPAND_WIDGET, 5);

      m_HBox_Accelerated.pack_start(m_VBox_Value, Gtk::PACK_EXPAND_WIDGET, 5);

      m_Label_Value.set_alignment(Gtk::ALIGN_LEFT);
      m_VBox_Value.pack_start(m_Label_Value);

      m_SpinButton_Value.set_wrap();
      m_SpinButton_Value.set_size_request(100, -1);
      m_VBox_Value.pack_start(m_SpinButton_Value);

      m_HBox_Accelerated.pack_start(m_VBox_Digits, Gtk::PACK_EXPAND_WIDGET, 5);

      m_Label_Digits.set_alignment(Gtk::ALIGN_LEFT);
      m_VBox_Digits.pack_start(m_Label_Digits);

      m_SpinButton_Digits.set_wrap();
      m_adjustment_digits.signal_value_changed().connect( sigc::mem_fun(*this, &ExampleWindow::on_spinbutton_digits_changed) );

      m_VBox_Digits.pack_start(m_SpinButton_Digits);

      //CheckButtons:
      m_VBox_Accelerated.pack_start(m_CheckButton_Snap);
      m_CheckButton_Snap.set_active();
      m_CheckButton_Snap.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_checkbutton_snap) );

      m_VBox_Accelerated.pack_start(m_CheckButton_Numeric);
      m_CheckButton_Numeric.set_active();
      m_CheckButton_Numeric.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_checkbutton_numeric) );

      //Buttons:
      m_VBox_Accelerated.pack_start (m_HBox_Buttons, Gtk::PACK_SHRINK, 5);

      m_Button_Int.signal_clicked().connect( sigc::bind( sigc::mem_fun(*this, &ExampleWindow::on_button_getvalue), VALUE_FORMAT_INT) );
      m_HBox_Buttons.pack_start(m_Button_Int, Gtk::PACK_EXPAND_WIDGET, 5);

      m_Button_Float.signal_clicked().connect( sigc::bind( sigc::mem_fun(*this, &ExampleWindow::on_button_getvalue), VALUE_FORMAT_FLOAT) );
      m_HBox_Buttons.pack_start(m_Button_Float, Gtk::PACK_EXPAND_WIDGET, 5);

      m_VBox_Accelerated.pack_start(m_Label_ShowValue);
      m_Label_ShowValue.set_text("0");

      //Close button:
      m_Button_Close.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_close) );
      m_VBox_Main.pack_start(m_Button_Close, Gtk::PACK_SHRINK);

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_close()
    {
      hide();
    }

    void ExampleWindow::on_checkbutton_snap()
    {
      m_SpinButton_Value.set_snap_to_ticks( m_CheckButton_Snap.get_active() );
    }

    void ExampleWindow::on_checkbutton_numeric()
    {
      m_SpinButton_Value.set_numeric( m_CheckButton_Numeric.get_active() );
    }

    void ExampleWindow::on_spinbutton_digits_changed()
    {
      m_SpinButton_Value.set_digits( m_SpinButton_Digits.get_value_as_int() );
    }

    void ExampleWindow::on_button_getvalue(enumValueFormats display)
    {
      gchar buf[32];

      if (display == VALUE_FORMAT_INT)
        sprintf (buf, "%d", m_SpinButton_Value.get_value_as_int());
      else
        sprintf (buf, "%0.*f", m_SpinButton_Value.get_digits(), m_SpinButton_Value.get_value());

      m_Label_ShowValue.set_text(buf);
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

### ProgressBar

Progress bars are used to show the status of an ongoing operation. For instance, a `ProgressBar` can show how much of a task has been completed.

To change the value shown, use the `set_fraction()` method, passing a double between 0 and 1 to provide the new percentage.

where `percentage` is a number, from 0 to 1, indicating what fraction of the bar should be filled.

A `ProgressBar`is horizontal and left-to-right by default, but you can change it to a vertical progress bar by using the `set_orientation()` method.

Reference

#### Activity Mode

Besides indicating the amount of progress that has occured, the progress bar can also be used to indicate that there is some activity; this is done by placing the progress bar in activity mode. In this mode, the progress bar displays a small rectangle which moves back and forth. Activity mode is useful in situations where the progress of an operation cannot be calculated as a value range (e.g., receiving a file of unknown length).

To do this, you need to call the `pulse()` method at regular intervals. You can also choose the step size, with the `set_pulse_step()` method.

When in continuous mode, the progress bar can also display a configurable text string within its trough, using the `set_text()` method.

#### Example

##### ProgressBar

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_checkbutton_text();
      virtual void on_checkbutton_activity();
      virtual void on_checkbutton_orientation();
      virtual bool on_timeout();
      virtual void on_button_close();

      //Child widgets:
      Gtk::VBox m_VBox;
      Gtk::Alignment m_Alignment;
      Gtk::Table m_Table;
      Gtk::ProgressBar m_ProgressBar;
      Gtk::HSeparator m_Separator;
      Gtk::CheckButton m_CheckButton_Text, m_CheckButton_Activity, m_CheckButton_Orientation;
      Gtk::Button m_Button_Close;

      int m_connection_id_timeout;
      bool m_bActivityMode;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include "examplewindow.h"
    #include <iostream>

    ExampleWindow::ExampleWindow()
    : m_VBox(false, 5),
      m_Alignment(0.5, 0.5, 0, 0),
      m_Table(2, 2, true),
      m_CheckButton_Text("Show text"),
      m_CheckButton_Activity("Activity mode"),
      m_CheckButton_Orientation("Right to Left"),
      m_Button_Close("Close"),
      m_bActivityMode(false)
    {
      set_resizable();
      set_title("Gtk::ProgressBar");

      m_VBox.set_border_width(10);
      add(m_VBox);

      m_VBox.pack_start(m_Alignment, Gtk::PACK_SHRINK, 5);
      m_Alignment.add(m_ProgressBar);

      //Add a timer callback to update the value of the progress bar:
      m_connection_id_timeout = Glib::signal_timeout().connect( sigc::mem_fun(*this, &ExampleWindow::on_timeout), 50 );

      m_VBox.pack_start(m_Separator, Gtk::PACK_SHRINK);
      m_VBox.pack_start(m_Table);

      //Add a check button to select displaying of the trough text:
      m_Table.attach(m_CheckButton_Text, 0, 1, 0, 1, Gtk::EXPAND | Gtk::FILL, Gtk::EXPAND | Gtk::FILL, 5, 5);
      m_CheckButton_Text.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_checkbutton_text) );

      //Add a check button to select displaying of the trough text:
      m_Table.attach(m_CheckButton_Activity, 0, 1, 1, 2, Gtk::EXPAND | Gtk::FILL, Gtk::EXPAND | Gtk::FILL, 5, 5);
      m_CheckButton_Activity.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_checkbutton_activity) );

      //Add a check button to toggle activity mode:
      m_Table.attach(m_CheckButton_Orientation, 0, 1, 2, 3, Gtk::EXPAND | Gtk::FILL, Gtk::EXPAND | Gtk::FILL, 5, 5);
      m_CheckButton_Orientation.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_checkbutton_orientation) );

      //Add a button to exit the program.
      m_VBox.pack_start(m_Button_Close, Gtk::PACK_SHRINK);
      m_Button_Close.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_close) );
      m_Button_Close.set_flags(Gtk::CAN_DEFAULT);
      m_Button_Close.grab_default();

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_checkbutton_text()
    {
      const Glib::ustring text = m_ProgressBar.get_text();

      if(!text.empty())
        m_ProgressBar.set_text("");
      else
        m_ProgressBar.set_text("some text");
    }

    void ExampleWindow::on_checkbutton_activity()
    {
      m_bActivityMode = m_CheckButton_Activity.get_active();

      if(m_bActivityMode)
        m_ProgressBar.pulse();
      else
        m_ProgressBar.set_fraction(0.0);
    }

    void ExampleWindow::on_checkbutton_orientation()
    {
      switch(m_ProgressBar.get_orientation())
      {
        case Gtk::PROGRESS_LEFT_TO_RIGHT:
          m_ProgressBar.set_orientation(Gtk::PROGRESS_RIGHT_TO_LEFT);
          break;
        case Gtk::PROGRESS_RIGHT_TO_LEFT:
          m_ProgressBar.set_orientation(Gtk::PROGRESS_LEFT_TO_RIGHT);
          break;
        default:
          break; // do nothing
      }
    }

    void ExampleWindow::on_button_close()
    {
      hide();
    }

    /* Update the value of the progress bar so that we get
     * some movement */
    bool ExampleWindow::on_timeout()
    {
      if(m_bActivityMode)
        m_ProgressBar.pulse();
      else
      {
        double new_val = m_ProgressBar.get_fraction() + 0.01;

        if(new_val > 1.0)
          new_val = 0.0;

        //Set the new value:
        m_ProgressBar.set_fraction(new_val);
      }

      //As this is a timeout function, return true so that it
      //continues to get called
      return true;
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

### Tooltips

`Tooltips` are the little text strings that pop up when you leave your pointer over a widget for a few seconds and the `Gtk::Tooltips` object is a group of these tooltips. After creating a `Gtk::Tooltips` instance, you can use the `set_tip()` method to associate some descriptive text with a `Widget`.

The `enable()` and `disable()` methods allow you to turn a whole group of tooltips on and off.

Reference

## Container Widgets

All container widgets derive from `Gtk::Container`, not always directly. Some container widgets, such as `Gtk::Table` can hold many child widgets, so these typically have more complex interfaces. Others, such as `Gtk::Frame` contain only one child widget.

### Single-item Containers

The single-item container widgets derive from `Gtk::Bin`, which provides the `add()` and `remove()` methods for the child widget. Note that `Gtk::Button` and `Gtk::Window` are technically single-item containers, but we have discussed them already elsewhere.

We also discuss the `Gtk::Paned` widget, which allows you to divide a window into two separate "panes". This widget actually contains two child widgets, but the number is fixed so it seems appropriate.

#### Frame

Frames can enclose one or a group of widgets within a box, optionally with a title. For instance, you might place a group of `RadioButton`s or `CheckButton`s in a `Frame`.

Reference

##### Example

###### Frame

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:

      //Child widgets:
      Gtk::Frame m_Frame;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include "examplewindow.h"

    ExampleWindow::ExampleWindow()
    {
     /* Set some window properties */
      set_title("Frame Example");
      set_size_request(300, 300);

      /* Sets the border width of the window. */
      set_border_width(10);

      add(m_Frame);

      /* Set the frames label */
      m_Frame.set_label("Gtk::Frame Widget");

      /* Align the label at the right of the frame */
      //m_Frame.set_label_align(Gtk::ALIGN_RIGHT, Gtk::ALIGN_TOP);

      /* Set the style of the frame */
      m_Frame.set_shadow_type(Gtk::SHADOW_ETCHED_OUT);

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

#### Paned

Panes divide a widget into two halves, separated by a moveable divider. There are two such widgets: `Gtk::HPaned` adds a horizontal divider, and `Gtk::VPaned` adds a vertical one. Other than the names and the orientations, there's no difference between the two.

Unlike the other widgets in this chapter, pane widgets contain not one but two child widgets, one in each pane. Therefore, you should use `add1()` and `add2()` instead of the `add()` method.

You can adjust the position of the divider using the `set_position()` method, and you will probably need to do so.

Reference

##### Example

###### Paned

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include "messageslist.h"
    #include "messagetext.h"
    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:

      //Child widgets:
      Gtk::VPaned m_VPaned;
      MessagesList m_MessagesList;
      MessageText m_MessageText;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: messageslist.h

    #ifndef GTKMM_EXAMPLE_MESSAGESLIST_H
    #define GTKMM_EXAMPLE_MESSAGESLIST_H

    #include <gtkmm.h>

    class MessagesList: public Gtk::ScrolledWindow
    {
    public:
      MessagesList();
      virtual ~MessagesList();

      class ModelColumns : public Gtk::TreeModel::ColumnRecord
      {
      public:

        ModelColumns()
        { add(m_col_text); }

        Gtk::TreeModelColumn<Glib::ustring> m_col_text;
      };

      ModelColumns m_Columns;

    protected:
      Glib::RefPtr<Gtk::ListStore> m_refListStore; //The Tree Model.
      Gtk::TreeView m_TreeView; //The Tree View.
    };
    #endif //GTKMM_EXAMPLE_MESSAGESLIST_H

File: messagetext.h

    #ifndef GTKMM_EXAMPLE_MESSAGETEXT_H
    #define GTKMM_EXAMPLE_MESSAGETEXT_H

    #include <gtkmm.h>

    class MessageText : public Gtk::ScrolledWindow
    {
    public:
      MessageText();
      virtual ~MessageText();

      virtual void insert_text();

    protected:
      Gtk::TextView m_TextView;
    };

    #endif //GTKMM_EXAMPLE_MESSAGETEXT_H

File: examplewindow.cc

    #include "examplewindow.h"

    ExampleWindow::ExampleWindow()
    {
      set_title ("Paned Windows");
      set_border_width(10);
      set_default_size(450, 400);

      /* Add a vpaned widget to our toplevel window */
      add(m_VPaned);

      /* Now add the contents of the two halves of the window */
      m_VPaned.add1(m_MessagesList);
      m_VPaned.add2(m_MessageText);

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

File: messageslist.cc

    #include "messageslist.h"
    #include <sstream>

    MessagesList::MessagesList()
    {
      /* Create a new scrolled window, with scrollbars only if needed */
      set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);

      add(m_TreeView);

      /* create list store */
      m_refListStore = Gtk::ListStore::create(m_Columns);

      m_TreeView.set_model(m_refListStore);

      /* Add some messages to the window */
      for(int i = 0; i < 10; ++i)
      {
        std::ostringstream text;
        text << "message #" << i;

        Gtk::TreeModel::Row row = *(m_refListStore->append());
        row[m_Columns.m_col_text] = text.str();
      }

      //Add the Model's column to the View's columns:
      m_TreeView.append_column("Messages", m_Columns.m_col_text);

      show_all_children();
    }

    MessagesList::~MessagesList()
    {
    }

File: messagetext.cc

    #include "messagetext.h"

    MessageText::MessageText()
    {
      set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);

      add(m_TextView);
      insert_text();

      show_all_children();
    }

    MessageText::~MessageText()
    {
    }

    void MessageText::insert_text()
    {
      Glib::RefPtr<Gtk::TextBuffer> refTextBuffer = m_TextView.get_buffer();

      Gtk::TextBuffer::iterator iter = refTextBuffer->get_iter_at_offset(0);
      refTextBuffer->insert(iter,
        "From: pathfinder@nasa.gov\n"
        "To: mom@nasa.gov\n"
        "Subject: Made it!\n"
        "\n"
        "We just got in this morning. The weather has been\n"
        "great - clear but cold, and there are lots of fun sights.\n"
        "Sojourner says hi. See you soon.\n"
        " -Path\n");
    }

#### ScrolledWindow

`ScrolledWindow` widgets are used to create a scrollable area. You can insert any type of widget into a `ScrolledWindow` window, and it will be accessible regardless of its size by using the scrollbars. Note that `ScrolledWindow` is not a `Gtk::Window` despite the slightly misleading name.

Scrolled windows have scrollbar policies which determine whether the `Scrollbar`s will be displayed. The policies can be set with the `set_policy()` method. The policy may be one of `Gtk::POLICY&lowbar;AUTOMATIC` or `Gtk::POLICY&lowbar;ALWAYS`. `Gtk::POLICY&lowbar;AUTOMATIC` will cause the scrolled window to display the scrollbar only if the contained widget is larger than the visible area. `Gtk::POLICY&lowbar;ALWAYS` will cause the scrollbar to be displayed always.

Reference

##### Example

Here is a simple example that packs 100 toggle buttons into a ScrolledWindow. Try resizing the window to see the scrollbars react.

###### ScrolledWindow

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Dialog
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_close();

      //Child widgets:
      Gtk::ScrolledWindow m_ScrolledWindow;
      Gtk::Table m_Table;
      Gtk::Button m_Button_Close;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include "examplewindow.h"
    #include <stdio.h> //For sprintf()

    ExampleWindow::ExampleWindow()
    : m_Table(10, 10),
      m_Button_Close("Close")
    {
      set_title("Gtk::ScrolledWindow example");
      set_border_width(0);
      set_size_request(300, 300);

      m_ScrolledWindow.set_border_width(10);

      /* the policy is one of Gtk::POLICY AUTOMATIC, or Gtk::POLICY_ALWAYS.
       * Gtk::POLICY_AUTOMATIC will automatically decide whether you need
       * scrollbars, whereas Gtk::POLICY_ALWAYS will always leave the scrollbars
       * there.  The first one is the horizontal scrollbar, the second,
       * the vertical. */
      m_ScrolledWindow.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_ALWAYS);

      get_vbox()->pack_start(m_ScrolledWindow);

      /* set the spacing to 10 on x and 10 on y */
      m_Table.set_row_spacings(10);
      m_Table.set_col_spacings(10);

      /* pack the table into the scrolled window */
      m_ScrolledWindow.add(m_Table);

      /* this simply creates a grid of toggle buttons on the table
       * to demonstrate the scrolled window. */
      for(int i = 0; i < 10; i++)
      {
         for(int j = 0; j < 10; j++)
         {
            char buffer[32];
            sprintf(buffer, "button (%d,%d)\n", i, j);
            Gtk::Button* pButton = Gtk::manage(new Gtk::ToggleButton(buffer));
            m_Table.attach(*pButton, i, i + 1, j, j + 1);
         }
      }

      /* Add a "close" button to the bottom of the dialog */
      m_Button_Close.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_close));

      /* this makes it so the button is the default. */
      m_Button_Close.set_flags(Gtk::CAN_DEFAULT);

      Gtk::Box* pBox = get_action_area();
      if(pBox)
        pBox->pack_start(m_Button_Close);

      /* This grabs this button to be the default button. Simply hitting
       * the "Enter" key will cause this button to activate. */
      m_Button_Close.grab_default();

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_close()
    {
      hide();
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

#### AspectFrame

The `AspectFrame` widget looks like a `Frame` widget, but it also enforces the aspect ratio (the ratio of the width to the height) of the child widget, adding extra space if necessary. For instance, this would allow you to display a photograph without allowing the user to distort it horizontally or vertically while resizing.

Reference

##### Example

The following program uses a `Gtk::AspectFrame` to present a drawing area whose aspect ratio will always be 2:1, no matter how the user resizes the top-level window.

TODO: screenshot

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:

      //Child widgets:
      Gtk::AspectFrame m_AspectFrame;
      Gtk::DrawingArea m_DrawingArea;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include "examplewindow.h"

    ExampleWindow::ExampleWindow()
    : m_AspectFrame("2x1", /* label */
        Gtk::ALIGN_CENTER, /* center x */
        Gtk::ALIGN_CENTER, /* center y */
        2.0, /* xsize/ysize = 2 */
        false /* ignore child's aspect */)
    {
      set_title("Aspect Frame");
      set_border_width(10);

      // Add a child widget to the aspect frame */
      // Ask for a 200x200 window, but the AspectFrame will give us a 200x100
      // window since we are forcing a 2x1 aspect ratio */
      m_DrawingArea.set_size_request(200, 200);
      m_AspectFrame.add(m_DrawingArea);

      // Add the aspect frame to our toplevel window:
      add(m_AspectFrame);

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

#### Alignment

The `Alignment` widget allows you to place a widget at a position and size relative to the size of the `Alignment` widget itself. For instance, it might be used to center a widget.

You need to specify the `Alignment`'s characteristics to the constructor, or to the `set()` method. In particular, you won't notice much effect unless you specify a number other than 1.0 for the `xscale` and `yscale` parameters, because 1.0 simply means that the child widget will expand to fill all available space.

Reference

##### Example

This example right-aligns a button in a window by using an `Alignment` widget.

###### Alignment

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_clicked();

      //Child widgets:
      Gtk::Alignment m_Alignment;
      Gtk::Button m_Button;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include "examplewindow.h"

    ExampleWindow::ExampleWindow()
    : m_Alignment(Gtk::ALIGN_RIGHT, Gtk::ALIGN_CENTER, 0.0, 0.0),
      m_Button("Close")
    {
      set_title("Gtk::Alignement");
      set_border_width(10);
      set_default_size(200, 50);

      add(m_Alignment);

      m_Alignment.add(m_Button);

      m_Button.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_clicked) );

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_clicked()
    {
      hide();
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

See the ProgressBar section for another example that uses an `Alignment`.

### Multiple-item widgets

Multiple-item widgets inherit from `Gtk::Container`; just as with `Gtk::Bin`, you use the `add()` and `remove()` methods to add and remove contained widgets. Unlike `Gtk::Bin::remove()`, however, the `remove()` method for `Gtk::Container` takes an argument, specifiying which widget to remove.

#### Packing

You've probably noticed that gtkmm windows seem "elastic" - they can usually be stretched in many different ways. This is due to the widget packing system.

Many GUI toolkits require you to precisely place widgets in a window, using absolute positioning, often using a visual editor. This leads to several problems:

- The widgets don't rearrange themselves when the window is resized. Some widgets are hidden when the window is made smaller, and lots of useless space appears when the window is made larger.

- It's impossible to predict the amount of space necessary for text after it has been translated to other languages, or displayed in a different font. On Unix it is also impossible to anticipate the effects of every theme and window manager.

- Changing the layout of a window "on the fly", to make some extra widgets appear, for instance, is complex. It requires tedious recalculation of every widget's position.

gtkmm uses the packing system to solve these problems. Rather than specifying the position and size of each widget in the window, you can arrange your widgets in rows, columns, and/or tables. gtkmm can size your window automatically, based on the sizes of the widgets it contains. And the sizes of the widgets are, in turn, determined by the amount of text they contain, or the minimum and maximum sizes that you specify, and/or how you have requested that the available space should be shared between sets of widgets. You can perfect your layout by specifying padding distance and centering values for each of your widgets. gtkmm then uses all this information to resize and reposition everything sensibly and smoothly when the user manipulates the window.

gtkmm arranges widgets hierarchically, using containers. A Container widget contains other widgets. Most gtkmm widgets are containers. Windows, Notebook tabs, and Buttons are all container widgets. There are two flavours of containers: single-child containers, which are all descendants of `Gtk::Bin`, and multiple-child containers, which are descendants of `Gtk::Container`. Most widgets in gtkmm are descendants of `Gtk::Bin`, including `Gtk::Window`.

Yes, that's correct: a Window can contain at most one widget. How, then, can we use a window for anything useful? By placing a multiple-child container in the window. The most useful container widgets are Gtk:VBox, Gtk::HBox, and Gtk::Table:

- `Gtk::VBox` and `Gtk::HBox` arrange their child widgets vertically and horizontally, respectively. Use pack_start() and pack_end() to insert child widgets.

- `Gtk::Table` arranges its widgets in a grid. Use attach() to insert widgets.

There are several other containers, which we will also discuss.

If you've never used a packing toolkit before, it can take some getting used to. You'll probably find, however, that you don't need to rely on visual form editors quite as much as you might with other toolkits.

#### An improved Hello World

Let's take a look at a slightly improved `helloworld`, showing what we've learnt.

##### Hello World 2

Source Code

File: helloworld.h

    #ifndef GTKMM_EXAMPLE_HELLOWORLD_H
    #define GTKMM_EXAMPLE_HELLOWORLD_H

    #include <gtkmm/button.h>
    #include <gtkmm/box.h>
    #include <gtkmm/window.h>

    class HelloWorld : public Gtk::Window
    {
    public:
      HelloWorld();
      virtual ~HelloWorld();

    protected:

      // Signal handlers:
      // Our new improved on_button_clicked(). (see below)
      virtual void on_button_clicked(Glib::ustring data);

      // Child widgets:
      Gtk::HBox m_box1;
      Gtk::Button m_button1, m_button2;
    };

    #endif // GTKMM_EXAMPLE_HELLOWORLD_H

File: helloworld.cc

    #include "helloworld.h"
    #include <iostream>

    HelloWorld::HelloWorld()
    : m_button1("Button 1"),
      m_button2("Button 2")
    {
      // This just sets the title of our new window.
      set_title("Hello Buttons!");

      // sets the border width of the window.
      set_border_width(10);

      // put the box into the main window.
      add(m_box1);

      // Now when the button is clicked, we call the "on_button_clicked" function
      // with a pointer to "button 1" as it's argument
      m_button1.signal_clicked().connect(sigc::bind<Glib::ustring>( sigc::mem_fun(*this, &HelloWorld::on_button_clicked), "button 1") );

      // instead of gtk_container_add, we pack this button into the invisible
      // box, which has been packed into the window.
      // note that the pack_start default arguments are Gtk::EXPAND | Gtk::FILL, 0
      m_box1.pack_start(m_button1);

      // always remember this step, this tells GTK that our preparation
      // for this button is complete, and it can be displayed now.
      m_button1.show();

      // call the same signal handler with a different argument,
      // passing a pointer to "button 2" instead.
      m_button2.signal_clicked().connect(sigc::bind<Glib::ustring>( sigc::mem_fun(*this, &HelloWorld::on_button_clicked), "button 2") );

      m_box1.pack_start(m_button2);

      // Show the widgets.
      // They will not really be shown until this Window is shown.
      m_button2.show();
      m_box1.show();
    }

    HelloWorld::~HelloWorld()
    {
    }

    // Our new improved signal handler.  The data passed to this method is
    // printed to stdout.
    void HelloWorld::on_button_clicked(Glib::ustring data)
    {
      std::cout << "Hello World - " << data << " was pressed" << std::endl;
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "helloworld.h"

    int main (int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      HelloWorld helloworld;
      Gtk::Main::run(helloworld); //Shows the window and returns when it is closed.

      return 0;
    }

After building and running this program, try resizing the window to see the behaviour. Also, try playing with the options to `pack&lowbar;start()` while reading the Boxes section.

#### STL-style APIs

TODO: Use 'Standard Library' instead of STL. If you're an accomplished C++ programmer, you'll be happy to hear that most of the gtkmm `Container` widgets provide STL-style APIs, available via accessor methods, such as `Gtk::Box::children()` or `Gtk::Notebook::pages()`. They don't use actual STL containers (there are good reasons for this), but they look, feel, and act much like STL container classes.

These APIs are so similar to STL container APIs that, rather than explaining them in detail, we can refer you to the STL documentation for most of their methods. This is all part of gtkmm's policy of reusing existing standards.

However, STL-style APIs can require awkward or lengthy code in some situations, so some people prefer not to use them, while other people use them religiously. Therefore, you are not forced to use them - most container widgets have a simpler non-STL-style API, with methods such as `append()` and `prepend()`.

At a minimum, gtkmm container lists support iterators and the usual insertion, deletion, and addition methods. You can always expect the following methods to be available for gtkmm STL-style APIs:

- `begin()` returns a `begin` iterator

- `end()` returns an `end` iterator

- `rbegin()` returns a reverse `begin` iterator

- `rend()` returns a reverse `end` iterator

- `size()`

- `max&lowbar;size()`

- `empty()`

- `insert()`

- `push&lowbar;front()`

- `push&lowbar;back()`

- `pop&lowbar;front()`

- `pop&lowbar;back()`

- `clear()`

- `erase()`

- `remove()`

- `find()`

- `front()`

- `back()`

Also, the `[]` operator is overloaded, but that is usually order N, so if performance is a consideration, or the list has a large number of elements, think carefully before using it.

The element objects and list objects are defined, for each container, in a namespace whose name ends in `&lowbar;Helpers`. For example, the helper namespace for the notebook widget is `Gtk::Notebook&lowbar;Helpers`.

##### Adding items

There is a major difference between gtkmm STL-style APIs and real STL containers. Normally, when you use a `std::vector`, for example, you expect that whatever you put in, you'll get out, unmodified. You wouldn't make a `std::vector<int>` and expect to get `double`s out of it. But, gtkmm STL-style APIs don't always work like that - you will often put one kind of object in, and later get a different kind out. Why this odd behaviour?

Consider a menu widget, which must maintain a hierarchical list of menus and menu items. Menus can only contain certain objects, such as menu items, separators, and submenus. To ensure consistency, a "filter" is needed to keep out illegal objects. Also, since only a few types of objects are allowed, convenience methods can be provided to make it easy to build up menus.

gtkmm takes care of both requirements using special helper elements. Helper elements are temporary - they're typically constructed and passed to an insertion method in the same call. The list insertion method uses the information in the helper element to construct the real object, which is then inserted into the container.

As an example, let's look at the `Notebook` widget (explained in the section on Notebooks). Notebook widgets contain a series of "pages".

Each page in a notebook requires, at minimum, the following information:

- A child widget (zero or one), to be placed in the page

- A label for the page's tab

(The gtkmm notebook widget keeps other data for each page as well.)

To insert a new page in a notebook, we can use one of the notebook helper classes, like this:

    notebook->pages().push_back(
              Gtk::Notebook_Helpers::TabElem(*frame, bufferl));

Let's see what's going on here. Assume we have a pointer to a Notebook widget called `notebook`; we go from that to a member method called `pages()`, which returns an STL-like list object. On this we call the method `push&lowbar;back()` (this should be familiar to those who know STL).

The object that the `pages()` method returns is called a `Notebook&lowbar;Helpers::PageList`. It's one of the STL-like containers that we keep referring to. Let's take a look at this class (this has been heavily edited for clarity; see `<gtkmm/notebook.h>` for the actual definition):

    namespace Notebook_Helpers
    {
        class PageList
        {
        public:
                 . . .
            void push_back(const Element& e);
                 . . .
            Page* operator[](size_type l);
        };
    };

There are two important things to notice here:

- The `push&lowbar;back()` method takes as argument an `Element` object (helper);

- The overloaded `[]` operator returns a pointer to a `Page`.

This scheme has some important advantages:

- We can provide as many different Helper objects as desired, making it simple to construct complex widgets like Menus.

- Construction of the actual objects can be delayed until an appropriate time. Sometimes we don't have enough information until later with GTK+.

- The definitions of the objects contained in the list can change; their interfaces need not concern the programmer. For example, even if the `Page` object changes drastically, the programmer need not be concerned; the `Element`s need not change, and will continue to work as expected.

- New `Element` objects can be added at any time to support new features, without breaking existing code.

All multi-item containers have an `Element` object in their helper namespaces, and usually there are additional classes available (like `TabElem` and `MenuElem`) which derive from `Element`. `Element` classes vary from container to container, since each contains different kinds of objects.

It's very important to remember that `Element`s are not "real" objects. They exist only temporarily, and they are never stored in the container. They are used only as temporary "parameter-holders". Therefore, the following segment of code is illegal:

    MenuElem* m = new MenuElem("hello");
    m->right_justify();
    items().push_back(*m);

We constructed a new `MenuElem` helper object, and then tried to invoke `right&lowbar;justify()` on it before adding it to the menu. The trouble is that there is no `right&lowbar;justify()` method in the `MenuElem` class. The correct way to accomplish this would be:

    items().push_back(MenuElem("hello"));
    items().back()->right_justify();

Here, we've constructed a `MenuElem` and inserted it into the menu by passing it to `push&lowbar;back()`, causing the real menu item to be created. We've then called `right&lowbar;justify()` on the object retrieved from the list. This is correct - the object retrieved from the list is not a `MenuElem`, but a real `MenuItem`, and therefore supports the `right&lowbar;justify()` method as expected.

#### Boxes

Most packing uses boxes as in the above example. These are invisible containers into which we can pack our widgets. When packing widgets into a horizontal box, the objects are inserted horizontally from left to right or right to left depending on whether `pack_start()` or `pack_end()` is used. In a vertical box, widgets are packed from top to bottom or vice versa. You may use any combination of boxes inside or beside other boxes to create the desired effect.

##### Adding widgets

###### Per-child packing options

The `pack&lowbar;start()` and `pack&lowbar;end()` methods place widgets inside these containers. The `pack&lowbar;start()` method will start at the top and work its way down in a `VBox`, or pack left to right in an `HBox`. `pack&lowbar;end()` will do the opposite, packing from bottom to top in a `VBox`, or right to left in an `HBox`. Using these methods allows us to right justify or left justify our widgets. We will use `pack&lowbar;start()` in most of our examples.

There are several options governing how widgets are to be packed, and this can be confusing at first. If you have difficulties then it is sometimes a good idea to play with the `glade` GUI designer to see what is possible. You might even decide to use the `libglademm` API to load your GUI at runtime.

There are basically five different styles, as shown in this picture:

###### Box Packing 1

Each line contains one horizontal box (`HBox`) with several buttons. Each of the buttons on a line is packed into the `HBox` with the same arguments to the `pack&lowbar;start()` method).

This is the declaration of the `pack&lowbar;start()` method:

    void pack_start(Gtk::Widget& child, PackOptions options = PACK_EXPAND_WIDGET, guint padding = 0);

The first argument is the widget you're packing. In our example these are all `Buttons`s.

The `options` argument can take one of these three options:

- `PACK_SHRINK`: Space is contracted to the child widget size. The widget will take up just-enough space and never expand.

- `PACK_EXPAND_PADDING`: Extra space is filled with padding. The widgets will be spaced out evenly, but their sizes won't change - there will be empty space between the widgets instead.

- `PACK_EXPAND_WIDGET`: Extra space is taken up by increasing the child widget size, without changing the amount of space between widgets.

The `padding` argument specifies the width of an extra border area to leave around the packed widget.

Instead of the `pack_start()` and `pack_end()` methods, you might prefer to use the STL-style API, available via the `children` method. See the STL-style APIs section for more details.

Reference

###### Per-container packing options

Here's the constructor for the box widgets:

    Gtk::Box(bool homogeneous = false, int spacing = 0);

Passing `true` for `homogeneous` will cause all of the contained widgets to be the same size. `spacing` is a (minimum) number of pixels to leave between each widget.

What's the difference between spacing (set when the box is created) and padding (set when elements are packed)? Spacing is added between objects, and padding is added on either side of a widget. The following figure should make it clearer:

###### Box Packing 2

##### Example

Here is the source code for the example that produced the screenshots above. When you run this example, provide a number between 1 and 3 as a command-line option, to see different packing options in use.

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>
    #include <packbox.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow(int which);
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_quit_clicked();

      //Child widgets:
      Gtk::Button m_button;
      Gtk::VBox m_box1;
      Gtk::HBox m_boxQuit;
      Gtk::Button m_buttonQuit;

      Gtk::Label m_Label1, m_Label2;

      Gtk::HSeparator m_seperator1, m_seperator2, m_seperator3, m_seperator4, m_seperator5;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: packbox.h

    #ifndef GTKMM_EXAMPLE_PACKBOX_H
    #define GTKMM_EXAMPLE_PACKBOX_H

    #include <gtkmm.h>

    class PackBox : public Gtk::HBox
    {
    public:
      PackBox(bool homogeneous, int spacing, Gtk::PackOptions, int padding = 0);
      virtual ~PackBox();

    protected:
      Gtk::Button m_button1, m_button2, m_button3;
      Gtk::Button* m_pbutton4;

      char padstr[80];
    };

    #endif //GTKMM_EXAMPLE_PACKBOX_H

File: examplewindow.cc

    #include <iostream>
    #include "examplewindow.h"

    ExampleWindow::ExampleWindow(int which)
    : m_buttonQuit("Quit")
    {
      set_title("Gtk::Box example");

      PackBox *pPackBox1, *pPackBox2, *pPackBox3, *pPackBox4, *pPackBox5;

      switch(which)
      {
        case 1:
        {
          m_Label1.set_text("Gtk::HBox(false, 0);");

          // Align the label to the left side.  We'll discuss this function and
          // others in the section on Widget Attributes.
          m_Label1.set_alignment(Gtk::ALIGN_LEFT, Gtk::ALIGN_TOP);

          // Pack the label into the vertical box (vbox box1).  Remember that
          // widgets added to a vbox will be packed one on top of the other in
          // order.
          m_box1.pack_start(m_Label1, Gtk::PACK_SHRINK);

          // Create a PackBox - homogeneous = false, spacing = 0,
          // options = Gtk::PACK_SHRINK, padding = 0
          pPackBox1 = Gtk::manage(new PackBox(false, 0, Gtk::PACK_SHRINK));
          m_box1.pack_start(*pPackBox1, Gtk::PACK_SHRINK);

          // Create a PackBox - homogeneous = false, spacing = 0,
          // options = Gtk::PACK_EXPAND_PADDING, padding = 0
          pPackBox2 = Gtk::manage(new PackBox(false, 0, Gtk::PACK_EXPAND_PADDING));
          m_box1.pack_start(*pPackBox2, Gtk::PACK_SHRINK);

          // Create a PackBox - homogeneous = false, spacing = 0,
          // options = Gtk::PACK_EXPAND_WIDGET, padding = 0
          pPackBox3 = Gtk::manage(new PackBox(false, 0, Gtk::PACK_EXPAND_WIDGET));
          m_box1.pack_start(*pPackBox3, Gtk::PACK_SHRINK);

          // pack the separator into the vbox.  Remember each of these
          // widgets are being packed into a vbox, so they'll be stacked
          // vertically.
          m_box1.pack_start(m_seperator1, Gtk::PACK_SHRINK, 5);

          // create another new label, and show it.
          m_Label2.set_text("Gtk::HBox(true, 0);");
          m_Label2.set_alignment(Gtk::ALIGN_LEFT, Gtk::ALIGN_TOP);
          m_box1.pack_start(m_Label2, Gtk::PACK_SHRINK);

          // Args are: homogeneous, spacing, options, padding
          pPackBox4 = Gtk::manage(new PackBox(true, 0, Gtk::PACK_EXPAND_PADDING));
          m_box1.pack_start(*pPackBox4, Gtk::PACK_SHRINK);

          // Args are: homogeneous, spacing, options, padding
          pPackBox5 = Gtk::manage(new PackBox(true, 0, Gtk::PACK_EXPAND_WIDGET));
          m_box1.pack_start(*pPackBox5, Gtk::PACK_SHRINK);

          m_box1.pack_start(m_seperator2, Gtk::PACK_SHRINK, 5);

          break;
        }

        case 2:
        {

          m_Label1.set_text("Gtk::HBox(false, 10);");
          m_Label1.set_alignment(Gtk::ALIGN_LEFT, Gtk::ALIGN_TOP);
          m_box1.pack_start(m_Label1, Gtk::PACK_SHRINK);

          pPackBox1 = Gtk::manage(new PackBox(false, 10, Gtk::PACK_EXPAND_PADDING));
          m_box1.pack_start(*pPackBox1, Gtk::PACK_SHRINK);

          pPackBox2 = Gtk::manage(new PackBox(false, 10, Gtk::PACK_EXPAND_WIDGET));
          m_box1.pack_start(*pPackBox2, Gtk::PACK_SHRINK);

          m_box1.pack_start(m_seperator1, Gtk::PACK_SHRINK, 5);

          m_Label2.set_text("Gtk::HBox(false, 0);");
          m_Label2.set_alignment(Gtk::ALIGN_LEFT, Gtk::ALIGN_TOP);
          m_box1.pack_start(m_Label2, Gtk::PACK_SHRINK);

          pPackBox3 = Gtk::manage(new PackBox(false, 0, Gtk::PACK_SHRINK, 10));
          m_box1.pack_start(*pPackBox3, Gtk::PACK_SHRINK);

          pPackBox4 = Gtk::manage(new PackBox(false, 0, Gtk::PACK_EXPAND_WIDGET, 10));
          m_box1.pack_start(*pPackBox4, Gtk::PACK_SHRINK);

          m_box1.pack_start(m_seperator2, Gtk::PACK_SHRINK, 5);

          break;
        }

        case 3:
        {
          // This demonstrates the ability to use Gtk::Box::pack_end() to
          // right justify widgets.  First, we create a new box as before.
          pPackBox1 = Gtk::manage(new PackBox(false, 0, Gtk::PACK_SHRINK));

          // create the label that will be put at the end.
          m_Label1.set_text("end");

          // pack it using pack_end(), so it is put on the right side
          // of the PackBox.
          pPackBox1->pack_end(m_Label1, Gtk::PACK_SHRINK);

          m_box1.pack_start(*pPackBox1, Gtk::PACK_SHRINK);

          // this explicitly sets the separator to 400 pixels wide by 5 pixels
          // high.  This is so the hbox we created will also be 400 pixels wide,
          // and the "end" label will be separated from the other labels in the
          // hbox.  Otherwise, all the widgets in the hbox would be packed as
          // close together as possible.
          m_seperator1.set_size_request(400, 5);

          // pack the separator into ourselves
          m_box1.pack_start(m_seperator1, Gtk::PACK_SHRINK, 5);

          break;
        }

        default:
        {
          std::cerr << "Unexpected command-line option." << std::endl;
          break;
        }
      }

      // Connect the signal to hide the window:
      m_buttonQuit.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_quit_clicked) );

      // pack the button into the quitbox.
      // The last 2 arguments to Box::pack_start are: options, padding.
      m_boxQuit.pack_start(m_buttonQuit, Gtk::PACK_EXPAND_PADDING);
      m_box1.pack_start(m_boxQuit, Gtk::PACK_SHRINK);

      // pack the vbox (box1) which now contains all our widgets, into the
      // main window.
      add(m_box1);

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_quit_clicked()
    {
      hide();
    }

File: main.cc

    #include <iostream>
    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main main_instance(argc, argv);

      if(argc != 2)
      {
        std::cerr << "usage: packbox num, where num is 1, 2, or 3." << std::endl;
        // this just does cleanup in GTK, and exits with an exit status of 1.
        gtk_exit (1);
      }

      ExampleWindow window( atoi(argv[1]) );
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

File: packbox.cc

    #include "packbox.h"
    #include <cstdio> //For sprintf().

    PackBox::PackBox(bool homogeneous, int spacing, Gtk::PackOptions options, int padding) :
      Gtk::HBox(homogeneous, spacing),
      m_button1("box.pack_start("),
      m_button2("button,"),
      m_button3((options == Gtk::PACK_SHRINK) ? "Gtk::PACK_SHRINK" :
                ((options == Gtk::PACK_EXPAND_PADDING) ? "Gtk::PACK_EXPAND_PADDING" : "Gtk::PACK_EXPAND_WIDGET"))
    {
      pack_start(m_button1, options, padding);
      pack_start(m_button2, options, padding);
      pack_start(m_button3, options, padding);

      sprintf(padstr, "%d);", padding);

      m_pbutton4 = new Gtk::Button(padstr);
      pack_start(*m_pbutton4, options, padding);
    }

    PackBox::~PackBox()
    {
      delete m_pbutton4;
    }

#### ButtonBoxes

Button boxes are a convenient way to quickly arrange a group of buttons. They come in both horizontal (`Gtk::HButtonBox`) and vertical (`Gtk::VButtonBox`) flavours. They are exactly alike, except in name and orientation.

ButtonBoxes help to make applications appear consistent because they use standard settings, such as inter-button spacing and packing.

Buttons are added to a `ButtonBox` with the `add()` method.

Button boxes support several layout styles. The style can be retrieved and changed using `get_layout()` and `set_layout()`.

Reference

##### Example

###### ButtonBox

Source Code

File: examplebuttonbox.h

    #ifndef GTKMM_EXAMPLE_BUTTONBOX_H
    #define GTKMM_EXAMPLE_BUTTONBOX_H

    #include <gtkmm.h>

    class ExampleButtonBox : public Gtk::Frame
    {
    public:
      ExampleButtonBox(bool horizontal,
           const Glib::ustring& title,
           gint spacing,
           Gtk::ButtonBoxStyle layout);

    protected:
      Gtk::Button m_Button_OK, m_Button_Cancel, m_Button_Help;
    };

    #endif //GTKMM_EXAMPLE_BUTTONBOX_H

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_clicked();

      //Child widgets:
      Gtk::VBox m_VBox_Main, m_VBox;
      Gtk::HBox m_HBox;
      Gtk::Frame m_Frame_Horizontal, m_Frame_Vertical;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplebuttonbox.cc

    #include "examplebuttonbox.h"

    ExampleButtonBox::ExampleButtonBox(bool horizontal,
           const Glib::ustring& title,
           gint spacing,
           Gtk::ButtonBoxStyle layout)
    : Gtk::Frame(title),
      m_Button_OK("OK"),
      m_Button_Cancel("Cancel"),
      m_Button_Help("Help")
    {
      Gtk::ButtonBox* bbox = 0;

      if(horizontal)
        bbox = Gtk::manage( new Gtk::HButtonBox() );
      else
        bbox = Gtk::manage( new Gtk::VButtonBox() );

      bbox->set_border_width(5);

      add(*bbox);

      /* Set the appearance of the Button Box */
      bbox->set_layout(layout);
      bbox->set_spacing(spacing);

      bbox->add(m_Button_OK);
      bbox->add(m_Button_Cancel);
      bbox->add(m_Button_Help);
    }

File: examplewindow.cc

    #include "examplewindow.h"
    #include "examplebuttonbox.h"

    ExampleWindow::ExampleWindow()
    : m_Frame_Horizontal("Horizontal Button Boxes"),
      m_Frame_Vertical("Vertical Button Boxes")
    {
      set_title("Gtk::ButtonBox");
      add(m_VBox_Main);

      m_VBox_Main.pack_start(m_Frame_Horizontal, Gtk::PACK_EXPAND_WIDGET, 10);

      //The horizontal ButtonBoxes:
      m_VBox.set_border_width(10);
      m_Frame_Horizontal.add(m_VBox);

      m_VBox.pack_start( *Gtk::manage( new ExampleButtonBox(true, "Spread (spacing 40)",
                                          40, Gtk::BUTTONBOX_SPREAD)),
         Gtk::PACK_EXPAND_WIDGET, 0);

      m_VBox.pack_start( *Gtk::manage( new ExampleButtonBox(true, "Edge (spacing 30)",
                                    30, Gtk::BUTTONBOX_EDGE)),
         Gtk::PACK_EXPAND_WIDGET, 5);

      m_VBox.pack_start( *Gtk::manage( new ExampleButtonBox(true, "Start (spacing 20)",
                                          20, Gtk::BUTTONBOX_START)),
         Gtk::PACK_EXPAND_WIDGET, 5);

      m_VBox.pack_start( *Gtk::manage( new ExampleButtonBox(true, "end (spacing 10)",
                                          10, Gtk::BUTTONBOX_END)),
         Gtk::PACK_EXPAND_WIDGET, 5);

      //The vertical ButtonBoxes:
      m_VBox_Main.pack_start(m_Frame_Vertical, Gtk::PACK_EXPAND_WIDGET, 10);

      m_HBox.set_border_width(10);
      m_Frame_Vertical.add(m_HBox);

      m_HBox.pack_start( *Gtk::manage( new ExampleButtonBox(false, "Spread (spacing 5)",
                                          5, Gtk::BUTTONBOX_SPREAD)),
          Gtk::PACK_EXPAND_WIDGET, 0);

      m_HBox.pack_start( *Gtk::manage( new ExampleButtonBox(false, "Edge (spacing 30)",
                                         30, Gtk::BUTTONBOX_EDGE)),
          Gtk::PACK_EXPAND_WIDGET, 5);

      m_HBox.pack_start( *Gtk::manage( new ExampleButtonBox(false, "Start (spacing 20)",
                                          20, Gtk::BUTTONBOX_START)),
          Gtk::PACK_EXPAND_WIDGET, 5);

      m_HBox.pack_start( *Gtk::manage( new ExampleButtonBox(false, "End (spacing 10)",
                                          10, Gtk::BUTTONBOX_END)),
          Gtk::PACK_EXPAND_WIDGET, 5);

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_clicked()
    {
      hide();
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

#### Table

Tables allows us to place widgets in a grid.

##### Constructor

The grid's dimensions need to be specified in the constructor:

    Gtk::Table(int rows = 1, int columns = 1, bool homogeneous = false);

The first argument is the number of rows to make in the table, while the second, obviously, is the number of columns. If `homogeneous` is `true`, the table cells will all be the same size (the size of the largest widget in the table).

The rows and columns are indexed starting at 0. If you specify `rows` = 2 and `columns` = 2, the layout would look something like this:

     0          1          2
    0+----------+----------+
     |          |          |
    1+----------+----------+
     |          |          |
    2+----------+----------+

Note that the coordinate system starts in the upper left hand corner.

##### Adding widgets

To place a widget into a box, use the following method:

    void Gtk::Table::attach(Gtk::Widget& child,
                            guint left_attach, guint right_attach,
                            guint top_attach, guint bottom_attach,
                            guint xoptions = Gtk::FILL | Gtk::EXPAND,
                            guint yoptions = Gtk::FILL | Gtk::EXPAND,
                            guint xpadding = 0, guint ypadding = 0);

The first argument is the widget you wish to place in the table.

The `left&lowbar;attach` and `right&lowbar;attach` arguments specify where to place the widget, and how many boxes to use. For example, if you want a button in the lower-right cell of a 2 x 2 table, and want it to occupy that cell only, then `left&lowbar;attach` would be 1, `right&lowbar;attach` 2, `top&lowbar;attach` 1, and `bottom&lowbar;attach` 2. If, on the other hand, you wanted a widget to take up the entire top row of our 2 x 2 table, you'd set `left&lowbar;attach` = 0, `right&lowbar;attach` = 2, `top&lowbar;attach` = 0, and `bottom&lowbar;attach` = 1.

`xoptions` and `yoptions` are used to specify packing options and may be bitwise ORed together to allow multiple options. These options are:

`Gtk::FILL`

  If the table box is larger than the widget, and `Gtk::FILL` is specified, the widget will expand to use all the room available.

`Gtk::SHRINK`

  If the table widget is allocated less space than it requested (because the user resized the window), then the widgets will normally just disappear off the bottom of the window. If `Gtk::SHRINK` is specified, the widgets will shrink with the table.

`Gtk::EXPAND`

  This will cause the table to expand to use up anyremaining space in the window.

The padding arguments work just as they do for `pack_start()`.

##### Other methods

`set&lowbar;row&lowbar;spacing()` and `set&lowbar;col&lowbar;spacing()` set the spacing between the rows at the specified row or column. Note that for columns, the space goes to the right of the column, and for rows, the space goes below the row.

You can also set a consistent spacing for all rows and/or columns with `set_row_spacings()` and `set_col_spacings()`. Note that with these calls, the last row and last column do not get any spacing.

Reference

##### Example

In the following example, we make a window with three buttons in a 2 x 2 table. The first two buttons will be placed in the upper row. A third button is placed in the lower row, spanning both columns.

###### Table

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_quit();
      virtual void on_button_numbered(Glib::ustring data);

      //Child widgets:
      Gtk::Table m_Table;
      Gtk::Button m_Button_1, m_Button_2, m_Button_Quit;

    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include <iostream>
    #include "examplewindow.h"

    ExampleWindow::ExampleWindow()
    : m_Table(2, 2, true),
      m_Button_1("button 1"),
      m_Button_2("button 2"),
      m_Button_Quit("Quit")
    {
      set_title("Gtk::Table");
      set_border_width(20);

      add(m_Table);

      m_Table.attach(m_Button_1, 0, 1, 0, 1);
      m_Table.attach(m_Button_2, 1, 2, 0, 1);
      m_Table.attach(m_Button_Quit, 0, 2, 1, 2);

      m_Button_1.signal_clicked().connect(
          sigc::bind<Glib::ustring>( sigc::mem_fun(*this, &ExampleWindow::on_button_numbered), "button 1") );
      m_Button_2.signal_clicked().connect(
          sigc::bind<Glib::ustring>( sigc::mem_fun(*this, &ExampleWindow::on_button_numbered), "button 2") );

      m_Button_Quit.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_quit) );

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_quit()
    {
      hide();
    }

    void
    ExampleWindow::on_button_numbered(Glib::ustring data)
    {
      std::cout << "Hello again - " << data << " was pressed" << std::endl;
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

#### Notebook

A `Notebook` has a set of stacked `pages`, each of which contains widgets. Labelled `tabs` allow the user to select the pages. `Notebooks` allow several sets of widgets to be placed in a small space, by only showing one page at a time. For instance, they are often used in preferences dialogs.

Use the `append_page()`, `prepend_page()` and `insert_page()` methods to add tabbed pages to the `Notebook`, supplying the child widget and the name for the tab.

To discover the currently visible page, use the `get_current_page()` method. This returns the page number, and then calling `get_nth_page()` with that number will give you a pointer to the actual child widget.

To programmatically change the selected page, use the `set_page()` method.

There is also an STL-style API which you might find more obvious.

Reference

##### Example

###### Notebook

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_quit();

      //Child widgets:
      Gtk::VBox m_VBox;
      Gtk::Notebook m_Notebook;
      Gtk::Label m_Label1, m_Label2;

      Gtk::HButtonBox m_ButtonBox;
      Gtk::Button m_Button_Quit;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include <iostream>
    #include "examplewindow.h"

    ExampleWindow::ExampleWindow()
    : m_Label1("Contents of tab 1"),
      m_Label2("Contents of tab 2"),
      m_Button_Quit("Quit")
    {
      set_title("Gtk::Notebook example");
      set_border_width(10);
      set_default_size(400, 200);

      add(m_VBox);

      //Add the Notebook, with the button underneath:
      m_Notebook.set_border_width(10);
      m_VBox.pack_start(m_Notebook);
      m_VBox.pack_start(m_ButtonBox, Gtk::PACK_SHRINK);

      m_ButtonBox.pack_start(m_Button_Quit, Gtk::PACK_SHRINK);
      m_Button_Quit.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_quit) );

      //Add the Notebook pages:
      m_Notebook.append_page(m_Label1, "First");
      m_Notebook.append_page(m_Label2, "Second");

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_quit()
    {
      hide();
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

##### STL-style API

The `Gtk::Notebook` widget has an STL-style API, available via the `pages()` method, which you might prefer to use to add and access pages. See the STL-style APIs section for generic information.

PageList Reference

To insert pages into a notebook, use the `TabElem` helper class, like so:

    m_Notebook.pages().push_back( Gtk::Notebook_Helpers::TabElem(m_ChildWidget, "tab 1") );

TabElem Reference. TODO: Correct URL.

To access an existing child widget, you can call `get_child()` on one of the `Page` elements of the `PageList`:

    Gtk::Widget* pWidget = m_Notebook.pages()[2].get_child();

## The TreeView widget

The Gtk::TreeView widget can contain lists or trees of data, in columns.

### The Model

Each Gtk::TreeView has an associated Gtk::TreeModel, which contains the data displayed by the TreeView. Each Gtk::TreeModel can be used by more than one Gtk::TreeView. For instance, this allows the same underlying data to be displayed and edited in 2 different ways at the same time. Or the 2 Views might display different columns from the same Model data, in the same way that 2 SQL queries (or "views") might show different fields from the same database table.

Although you can theoretically implement your own Model, you will normally use either the ListStore or TreeStore model classes.

Reference

#### ListStore, for rows

The ListStore contains simple rows of data, and each row has no children.

##### TreeView - ListStore

Reference

#### TreeStore, for a hierarchy

The TreeStore contains rows of data, and each row may have child rows.

##### TreeView - TreeStore

Reference

#### Model Columns

The TreeModel::ColumnRecord class is used to keep track of the columns and their data types. You add TreeModelColumn instances to the ColumnRecord and then use those TreeModelColumns when getting and setting the data in model rows. You will probably find it convenient to derive a new TreeModel::ColumnRecord which has your TreeModelColumn instances as member data.

    class ModelColumns : public Gtk::TreeModel::ColumnRecord
    {
    public:

      ModelColumns()
        { add(m_col_text); add(m_col_number); }

      Gtk::TreeModelColumn<Glib::ustring> m_col_text;
      Gtk::TreeModelColumn<int> m_col_number;
    };

    ModelColumns m_Columns;

You specify the ColumnRecord when creating the Model, like so:

    Glib::RefPtr<Gtk::ListStore> refListStore = Gtk::ListStore::create(m_Columns);

#### Adding Rows

Add rows to the model with the `append()`, `prepend()`, or `insert()` methods.

    Gtk::TreeModel::iterator iter = m_refListStore->append();

You can dereference the iterator to get the Row:

    Gtk::TreeModel::Row row = *iter;

##### Adding child rows

`Gtk::TreeStore` models can have child items. Add them with the `append()`, `prepend()`, or `insert()` methods, like so:

    Gtk::TreeModel::iterator iter_child = m_refListStore->append(row.children());

#### Setting values

You can use the operator[] override to set the data for a particular column in the row, specifying the TreeModelColumn used to create the model.

    row[m_Columns.m_col_text] = "sometext";

#### Getting values

You can use the operator[] override to get the data in a particular column in a row, specifiying the TreeModelColumn used to create the model.

    Glib::ustring strText = row[m_Columns.m_col_text];
    int number = row[m_Columns.m_col_number];

The compiler will complain if you use an inappropriate type. For instance, this would generate a compiler error:

    int number = row[m_Columns.m_col_text]; //compiler error - no conversion from
    ustring to int.

#### "Hidden" Columns

You might want to associate extra data with each row. If so, just add it as a Model column, but don't add it to the View.

### The View

The View is the actual widget (Gtk::TreeView) that displays the model (Gtk::TreeModel) data and allows the user to interact with it. The View can show all of the model's columns, or just some, and it can show them in various ways.

Reference

#### Using a Model

You can specify a Gtk::TreeModel when constructing the Gtk::TreeView, or you can use the set_model() method, like so:

    m_TreeView.set_model(m_refListStore);

#### Adding View Columns

You can use the append_column() method to tell the View that it should display certain Model columns, in a certain order, with a certain column title.

      m_TreeView.append_column("Messages", m_Columns.m_col_text);

When using this simple append_column() override, the TreeView will display the model data with an appropriate CellRenderer. For instance, strings and numbers are shown in a simple Gtk::Entry widget, and booleans are shown in a Gtk::CheckButton. This is usually what you need. For other column types you must either connect a callback that converts your type into a string representation, with TreeViewColumn::set_cell_data_func(), or derive a custom CellRenderer. Note that (unsigned) short is not supported by default - You could use (unsigned) int or (unsigned) long as the column type instead.

#### More than one Model Column per View Column

To render more than one model column in a view column, you need to create the TreeView::Column widget manually, and use pack_start() to add the model columns to it.

Then use append_column() to add the view Column to the View. Notice that Gtk::View::append_column() is overridden to accept either a prebuilt Gtk::View::Column widget, or just the TreeModelColumn from which it generates an appropriate Gtk::View::Column widget.

Here is some example code from demos/gtk-demo/example_stockbrowser.cc, which has a pixbuf icon and a text name in the same column:

    Gtk::TreeView::Column* pColumn = Gtk::manage( new Gtk::TreeView::Column("Symbol") );

    // m_columns.icon and m_columns.symbol are columns in the model.
    // pColumn is the column in the TreeView:
    pColumn->pack_start(m_columns.icon, false); //false = don't expand.
    pColumn->pack_start(m_columns.symbol);

    m_TreeView.append_column(*pColumn);

#### Specifying CellRenderer details

The default CellRenderers and their default behaviour will normally suffice, but you might occasionally need finer control. For instance, this example code from `demos/gtk-demo/example_treestore.cc`, manually constructs a Gtk::CellRenderer widget and instructs it to render the data from various model columns through various aspects of its appearance.

    Gtk::CellRendererToggle* pRenderer = Gtk::manage( new Gtk::CellRendererToggle() );
    int cols_count = m_TreeView.append_column("Alex", *pRenderer);
    Gtk::TreeViewColumn* pColumn = m_TreeView.get_column(cols_count-1);
    if(pColumn)
    {
      pColumn->add_attribute(pRenderer->property_active(), m_columns.alex);
      pColumn->add_attribute(pRenderer->property_visible(), m_columns.visible);
      pColumn->add_attribute(pRenderer->property_activatable(), m_columns.world);

You can also connect to CellRenderer signals to detect user actions. For instance:

    Gtk::CellRendererToggle* pRenderer = Gtk::manage( new Gtk::CellRendererToggle() );
    pRenderer->signal_toggled().connect(
      sigc::bind( sigc::mem_fun(*this, &Example_TreeView_TreeStore::on_cell_toggled), m_columns.dave)
    );

#### Editable Cells

##### Automatically-stored editable cells.

Cells in a TreeView can be edited in-place by the user. To allow this, use the Gtk::TreeView insert_column_editable() and append_column_editable() methods instead of insert_column() and append_column(). When these cells are edited the new values will be stored immediately in the Model. Note that these methods are templates which can only be instantiated for simple column types such as Glib::ustring, int, and long.

##### Implementing custom logic for editable cells.

However, you might not want the new values to be stored immediately. For instance, maybe you want to restrict the input to certain characters or ranges of values.

To achieve this, you should use the normal Gtk::TreeView insert_column() and append_column() methods, then use get_column_cell_renderer() to get the Gtk::CellRenderer used by that column.

You must set the cell's editable property to true, like so:

    cell.property_editable() = true;

You should then cast that Gtk::CellRenderer* to the specific CellRenderer that you expect, and then connect to the appropriate "edited" signal. For instance, connect to Gtk::CellRendererText::signal_edited(), or Gtk::CellRendererToggle::signal_toggled(). If the column contains more than one CellRenderer then you will need to use Gtk::TreeView::get_column() and then call get_cell_renderers() on that view Column.

In your signal handler, you should examine the new value and then store it in the Model if that is appropriate for your application.

### Iterating over Model Rows

Gtk::TreeModel provides an STL-style container of its children, via the children() method. You can use the familiar begin() and end() methods iterator incrementing, like so:

    typedef Gtk::TreeModel::Children type_children; //minimise code length.
    type_children children = refModel->children();
    for(type_children::iterator iter = children.begin(); iter != children.end(); ++iter)
    {
      Gtk::TreeModel::Row row = *iter;
      //Do something with the row - see above for set/get.
    }

#### Row children

When using a Gtk::TreeStore, the rows can have child rows, which can have their own children in turn. Use Gtk::TreeModel::Row::children() to get the STL-style container of child Rows:

    Gtk::TreeModel::Children children = row.children();

### The Selection

To find out what rows the user has selected, get the Gtk::TreeView::Selection object from the TreeView, like so:

    Glib::RefPtr<Gtk::TreeSelection> refTreeSelection =
    m_TreeView.get_selection();

#### Single or multiple selection

By default, only single rows can be selected, but you can allow multiple selection by setting the mode, like so:

    refTreeSelection->set_mode(Gtk::SELECTION_MULTIPLE);

#### The selected rows

For single-selection, you can just call get_selected(), like so:

    TreeModel::iterator iter = refTreeSelection->get_selected();
    if(iter) //If anything is selected
    {
      TreeModel::Row row = *iter;
      //Do something with the row.
    }

For multiple-selection, you need to define a callback, and give it to selected_foreach(), like so:

    refTreeSelection->selected_foreach(
        sigc::mem_fun(*this, &TheClass::selected_row_callback) );

    ...

    void TheClass::selected_row_callback(const Gtk::TreeModel::iterator& iter)
    {
      TreeModel::Row row = *iter;
      //Do something with the row.
    }

#### The "changed" signal

To respond to the user clicking on a row or range of rows, connect to the signal like so:

    refTreeSelection->signal_changed().connect(
      sigc::mem_fun(*this, &Example_StockBrowser::on_selection_changed)
    );

#### Preventing row selection

Maybe the user should not be able to select every item in your list or tree. For instance, in the gtk-demo, you can select a demo to see the source code, but it doesn't make any sense to select a demo category.

To control which rows can be selected, use the `set_select_function()` method, providing a `sigc::slot` callback. For instance:

    m_refTreeSelection->set_select_function( sigc::mem_fun(*this, &DemoWindow::select_function) );

and then

    bool DemoWindow::select_function(const Glib::RefPtr<Gtk::TreeModel>& model,
                                     const Gtk::TreeModel::Path& path, bool)
    {
      const Gtk::TreeModel::iterator iter = model->get_iter(path);
      return iter->children().empty(); // only allow leaf nodes to be selected
    }

#### Changing the selection

To change the selection, specify a Gtk::TreeModel::iterator or Gtk::TreeModel::Row, like so:

    Gtk::TreeModel::Row row = m_refModel->children()[5]; //The fifth row.
    if(row)
      refTreeSelection->select(row);

or

    Gtk::TreeModel::iterator iter = m_refModel->children().begin()
    if(iter)
      refTreeSelection->select(iter);

### Drag and Drop

`Gtk::TreeView` already implments simple drag-and-drop when used with the `Gtk::ListStore` or `Gtk::TreeStore` models. If necessary, it also allows you to implement more complex behaviour when items are dragged and dropped, using the normal Drag and Drop API.

#### Reorderable rows

If you call `Gtk::TreeView::set_reorderable()` then your TreeView's items can be moved within the treeview itself. This is demonstrated in the `TreeStore` example.

However, this does not allow you any control of which items can be dragged, and where they can be dropped. If you need that extra control then you might create a derived `Gtk::TreeModel` from `Gtk::TreeStore` or `Gtk::ListStore` and override the `Gtk::TreeDragSource::row_draggable()` and `Gdk::TreeDragDest::row_drop_possible()` virtual methods. You can examine the `Gtk::TreeModel::Path`s provided and allow or disallow dragging or dropping by return `true` or `false`.

This is demonstrated in the drag_and_drop example.

### Popup Context Menu

Lots of people need to implement right-click context menus for `TreeView`'s so we will explain how to do that here to save you some time. Apart from one or two points, it's much the same as a normal context menu, as described in the menus chapter.

#### Handling `button_press_event`

To detect a click of the right mouse button, you need to handle the `button_press_event` signal, and check exactly which button was pressed. Because the `TreeView` normally handles this signal completely, you need to either override the default signal handler in a derived `TreeView` class, or use `connect_nofify()` insted of `connect()`. You probably also want to call the default handler before doing anything else, so that the right-click will cause the row to be selected first.

This is demonstrated in the Popup Custom Menu example.

### Examples

#### ListStore

This example has a `Gtk::TreeView` widget, with a `Gtk::ListStore` model.

##### TreeView - ListStore

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_quit();

      //Tree model columns:
      class ModelColumns : public Gtk::TreeModel::ColumnRecord
      {
      public:

        ModelColumns()
        { add(m_col_id); add(m_col_name); }

        Gtk::TreeModelColumn<unsigned int> m_col_id;
        Gtk::TreeModelColumn<Glib::ustring> m_col_name;
      };

      ModelColumns m_Columns;

      //Child widgets:
      Gtk::VBox m_VBox;

      Gtk::ScrolledWindow m_ScrolledWindow;
      Gtk::TreeView m_TreeView;
      Glib::RefPtr<Gtk::ListStore> m_refTreeModel;

      Gtk::HButtonBox m_ButtonBox;
      Gtk::Button m_Button_Quit;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include <iostream>
    #include "examplewindow.h"

    ExampleWindow::ExampleWindow()
    : m_Button_Quit("Quit")
    {
      set_title("Gtk::TreeView (ListStore) example");
      set_border_width(5);
      set_default_size(400, 200);

      add(m_VBox);

      //Add the TreeView, inside a ScrolledWindow, with the button underneath:
      m_ScrolledWindow.add(m_TreeView);

      //Only show the scrollbars when they are necessary:
      m_ScrolledWindow.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);

      m_VBox.pack_start(m_ScrolledWindow);
      m_VBox.pack_start(m_ButtonBox, Gtk::PACK_SHRINK);

      m_ButtonBox.pack_start(m_Button_Quit, Gtk::PACK_SHRINK);
      m_ButtonBox.set_border_width(5);
      m_ButtonBox.set_layout(Gtk::BUTTONBOX_END);
      m_Button_Quit.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_quit) );

      //Create the Tree model:
      m_refTreeModel = Gtk::ListStore::create(m_Columns);
      m_TreeView.set_model(m_refTreeModel);

      //Fill the TreeView's model
      Gtk::TreeModel::Row row = *(m_refTreeModel->append());
      row[m_Columns.m_col_id] = 1;
      row[m_Columns.m_col_name] = "Billy Bob";

      row = *(m_refTreeModel->append());
      row[m_Columns.m_col_id] = 2;
      row[m_Columns.m_col_name] = "Joey Jojo";

      row = *(m_refTreeModel->append());
      row[m_Columns.m_col_id] = 3;
      row[m_Columns.m_col_name] = "Rob McRoberts";

      //Add the TreeView's view columns:
      m_TreeView.append_column("ID", m_Columns.m_col_id);
      m_TreeView.append_column("Name", m_Columns.m_col_name);

      //Make all the columns reorderable:
      //This is not necessary, but it's nice to show the feature.
      //You can use TreeView::set_column_drag_function() to more
      //finely control column drag and drop.
      for(guint i = 0; i < 2; i++)
      {
        Gtk::TreeView::Column* pColumn = m_TreeView.get_column(i);
        pColumn->set_reorderable();
      }

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_quit()
    {
      hide();
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

#### TreeStore

This example is very similar to the ListStore example, but uses a `Gtk::TreeStore` model instead, and adds children to the rows.

##### TreeView - TreeStore

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_quit();
      virtual void on_treeview_row_activated(const Gtk::TreeModel::Path& path, Gtk::TreeViewColumn* column);

      //Tree model columns:
      class ModelColumns : public Gtk::TreeModel::ColumnRecord
      {
      public:

        ModelColumns()
        { add(m_col_id); add(m_col_name); }

        Gtk::TreeModelColumn<int> m_col_id;
        Gtk::TreeModelColumn<Glib::ustring> m_col_name;
      };

      ModelColumns m_Columns;

      //Child widgets:
      Gtk::VBox m_VBox;

      Gtk::ScrolledWindow m_ScrolledWindow;
      Gtk::TreeView m_TreeView;
      Glib::RefPtr<Gtk::TreeStore> m_refTreeModel;

      Gtk::HButtonBox m_ButtonBox;
      Gtk::Button m_Button_Quit;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include <iostream>
    #include "examplewindow.h"

    ExampleWindow::ExampleWindow()
    : m_Button_Quit("Quit")
    {
      set_title("Gtk::TreeView (TreeStore) example");
      set_border_width(5);
      set_default_size(400, 200);

      add(m_VBox);

      //Add the TreeView, inside a ScrolledWindow, with the button underneath:
      m_ScrolledWindow.add(m_TreeView);

      //Only show the scrollbars when they are necessary:
      m_ScrolledWindow.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);

      m_VBox.pack_start(m_ScrolledWindow);
      m_VBox.pack_start(m_ButtonBox, Gtk::PACK_SHRINK);

      m_ButtonBox.pack_start(m_Button_Quit, Gtk::PACK_SHRINK);
      m_ButtonBox.set_border_width(5);
      m_ButtonBox.set_layout(Gtk::BUTTONBOX_END);
      m_Button_Quit.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_quit) );

      //Create the Tree model:
      m_refTreeModel = Gtk::TreeStore::create(m_Columns);
      m_TreeView.set_model(m_refTreeModel);

      //All the items to be reordered with drag-and-drop:
      m_TreeView.set_reorderable();

      //Fill the TreeView's model
      Gtk::TreeModel::Row row = *(m_refTreeModel->append());
      row[m_Columns.m_col_id] = 1;
      row[m_Columns.m_col_name] = "Billy Bob";

      Gtk::TreeModel::Row childrow = *(m_refTreeModel->append(row.children()));
      childrow[m_Columns.m_col_id] = 11;
      childrow[m_Columns.m_col_name] = "Billy Bob Junior";

      childrow = *(m_refTreeModel->append(row.children()));
      childrow[m_Columns.m_col_id] = 12;
      childrow[m_Columns.m_col_name] = "Sue Bob";

      row = *(m_refTreeModel->append());
      row[m_Columns.m_col_id] = 2;
      row[m_Columns.m_col_name] = "Joey Jojo";

      row = *(m_refTreeModel->append());
      row[m_Columns.m_col_id] = 3;
      row[m_Columns.m_col_name] = "Rob McRoberts";

      childrow = *(m_refTreeModel->append(row.children()));
      childrow[m_Columns.m_col_id] = 31;
      childrow[m_Columns.m_col_name] = "Xavier McRoberts";

      //Add the TreeView's view columns:
      m_TreeView.append_column("ID", m_Columns.m_col_id);
      m_TreeView.append_column("Name", m_Columns.m_col_name);

      //Connect signal:
      m_TreeView.signal_row_activated().connect( sigc::mem_fun(*this, &ExampleWindow::on_treeview_row_activated) );

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_quit()
    {
      hide();
    }

    void ExampleWindow::on_treeview_row_activated(const Gtk::TreeModel::Path& path, Gtk::TreeViewColumn* /* column */)
    {
      Gtk::TreeModel::iterator iter = m_refTreeModel->get_iter(path);
      if(iter)
      {
        Gtk::TreeModel::Row row = *iter;
        std::cout << "Row activated: ID=" << row[m_Columns.m_col_id] << ", Name=" << row[m_Columns.m_col_name] << std::endl;
      }
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

#### Editable Cells

This example is identical to the ListStore example, but it uses `TreeView::append_column_editable()` instead of `TreeView::append_column()`.

##### TreeView - Editable Cells

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_quit();

      //Tree model columns:
      class ModelColumns : public Gtk::TreeModel::ColumnRecord
      {
      public:

        ModelColumns()
        { add(m_col_id); add(m_col_name); add(m_col_foo); }

        Gtk::TreeModelColumn<unsigned int> m_col_id;
        Gtk::TreeModelColumn<Glib::ustring> m_col_name;
        Gtk::TreeModelColumn<bool> m_col_foo;
      };

      ModelColumns m_Columns;

      //Child widgets:
      Gtk::VBox m_VBox;

      Gtk::ScrolledWindow m_ScrolledWindow;
      Gtk::TreeView m_TreeView;
      Glib::RefPtr<Gtk::ListStore> m_refTreeModel;

      Gtk::HButtonBox m_ButtonBox;
      Gtk::Button m_Button_Quit;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include <iostream>
    #include "examplewindow.h"

    ExampleWindow::ExampleWindow()
    : m_Button_Quit("Quit")
    {
      set_title("Gtk::TreeView Editable Cells example");
      set_border_width(5);
      set_default_size(400, 200);

      add(m_VBox);

      //Add the TreeView, inside a ScrolledWindow, with the button underneath:
      m_ScrolledWindow.add(m_TreeView);

      //Only show the scrollbars when they are necessary:
      m_ScrolledWindow.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);

      m_VBox.pack_start(m_ScrolledWindow);
      m_VBox.pack_start(m_ButtonBox, Gtk::PACK_SHRINK);

      m_ButtonBox.pack_start(m_Button_Quit, Gtk::PACK_SHRINK);
      m_ButtonBox.set_border_width(5);
      m_ButtonBox.set_layout(Gtk::BUTTONBOX_END);
      m_Button_Quit.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_quit) );

      //Create the Tree model:
      m_refTreeModel = Gtk::ListStore::create(m_Columns);
      m_TreeView.set_model(m_refTreeModel);

      //Fill the TreeView's model
      Gtk::TreeModel::Row row = *(m_refTreeModel->append());
      row[m_Columns.m_col_id] = 1;
      row[m_Columns.m_col_name] = "Billy Bob";
      row[m_Columns.m_col_foo] = true;

      row = *(m_refTreeModel->append());
      row[m_Columns.m_col_id] = 2;
      row[m_Columns.m_col_name] = "Joey Jojo";
      row[m_Columns.m_col_foo] = true;

      row = *(m_refTreeModel->append());
      row[m_Columns.m_col_id] = 3;
      row[m_Columns.m_col_name] = "Rob McRoberts";
      row[m_Columns.m_col_foo] = false;

      //Add the TreeView's view columns:
      m_TreeView.append_column_editable("ID", m_Columns.m_col_id);
      m_TreeView.append_column_editable("Name", m_Columns.m_col_name);
      m_TreeView.append_column_editable("foo", m_Columns.m_col_foo);

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_quit()
    {
      hide();
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

#### Drag and Drop

This example is much like the TreeStore example, but has 2 extra columns to indicate whether the row can be dragged, and whether it can receive drag-and-dropped rows. It uses a derived `Gtk::TreeStore` which overrides the virtual functions as described in the TreeView Drag and Drop section..

##### TreeView - Drag And Drop

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>
    #include "treemodel_dnd.h"

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_quit();

      //Child widgets:
      Gtk::VBox m_VBox;

      Gtk::ScrolledWindow m_ScrolledWindow;
      Gtk::TreeView m_TreeView;
      Glib::RefPtr<TreeModel_Dnd> m_refTreeModel;

      Gtk::HButtonBox m_ButtonBox;
      Gtk::Button m_Button_Quit;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: treemodel_dnd.h

    #ifndef GTKMM_EXAMPLE_TREEMODEL_DND_H
    #define GTKMM_EXAMPLE_TREEMODEL_DND_H

    #include <gtkmm.h>

    class TreeModel_Dnd : public Gtk::TreeStore
    {
    protected:
      TreeModel_Dnd();

    public:

       //Tree model columns:
      class ModelColumns : public Gtk::TreeModel::ColumnRecord
      {
      public:

        ModelColumns()
        { add(m_col_id); add(m_col_name); add(m_col_draggable); add(m_col_receivesdrags); }

        Gtk::TreeModelColumn<int> m_col_id;
        Gtk::TreeModelColumn<Glib::ustring> m_col_name;
        Gtk::TreeModelColumn<bool> m_col_draggable;
        Gtk::TreeModelColumn<bool> m_col_receivesdrags;
      };

      ModelColumns m_Columns;

      static Glib::RefPtr<TreeModel_Dnd> create();

    protected:
      //Overridden virtual functions:
      virtual bool row_draggable_vfunc(const Gtk::TreeModel::Path& path) const;
      virtual bool row_drop_possible_vfunc(const Gtk::TreeModel::Path& dest, const Gtk::SelectionData& selection_data) const;

    };

    #endif //GTKMM_EXAMPLE_TREEMODEL_DND_H

File: examplewindow.cc

    #include <iostream>
    #include "examplewindow.h"

    ExampleWindow::ExampleWindow()
    : m_Button_Quit(Gtk::Stock::QUIT)
    {
      set_title("Gtk::TreeView (Drag and Drop) example");
      set_border_width(5);
      set_default_size(400, 200);

      add(m_VBox);

      //Add the TreeView, inside a ScrolledWindow, with the button underneath:
      m_ScrolledWindow.add(m_TreeView);

      //Only show the scrollbars when they are necessary:
      m_ScrolledWindow.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);

      m_VBox.pack_start(m_ScrolledWindow);
      m_VBox.pack_start(m_ButtonBox, Gtk::PACK_SHRINK);

      m_ButtonBox.pack_start(m_Button_Quit, Gtk::PACK_SHRINK);
      m_ButtonBox.set_border_width(5);
      m_ButtonBox.set_layout(Gtk::BUTTONBOX_END);
      m_Button_Quit.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_quit) );

      //Create the Tree model:
      //Use our derived model, which overrides some Gtk::TreeDragDest and Gtk::TreeDragSource virtual functions:
      m_refTreeModel = TreeModel_Dnd::create(); //The columns are declared in the overridden TreeModel.
      m_TreeView.set_model(m_refTreeModel);

      //Enable Drag-and-Drop of TreeView rows:
      //See also the derived TreeModel's *_vfunc overrides.
      m_TreeView.enable_model_drag_source();
      m_TreeView.enable_model_drag_dest();

      //Fill the TreeView's model
      Gtk::TreeModel::Row row = *(m_refTreeModel->append());
      row[m_refTreeModel->m_Columns.m_col_id] = 1;
      row[m_refTreeModel->m_Columns.m_col_name] = "Billy Bob";
      row[m_refTreeModel->m_Columns.m_col_draggable] = true;
      row[m_refTreeModel->m_Columns.m_col_receivesdrags] = true;

      Gtk::TreeModel::Row childrow = *(m_refTreeModel->append(row.children()));
      childrow[m_refTreeModel->m_Columns.m_col_id] = 11;
      childrow[m_refTreeModel->m_Columns.m_col_name] = "Billy Bob Junior";
      childrow[m_refTreeModel->m_Columns.m_col_draggable] = true;
      childrow[m_refTreeModel->m_Columns.m_col_receivesdrags] = true;

      childrow = *(m_refTreeModel->append(row.children()));
      childrow[m_refTreeModel->m_Columns.m_col_id] = 12;
      childrow[m_refTreeModel->m_Columns.m_col_name] = "Sue Bob";
      childrow[m_refTreeModel->m_Columns.m_col_draggable] = true;
      childrow[m_refTreeModel->m_Columns.m_col_receivesdrags] = true;

      row = *(m_refTreeModel->append());
      row[m_refTreeModel->m_Columns.m_col_id] = 2;
      row[m_refTreeModel->m_Columns.m_col_name] = "Joey Jojo";
      row[m_refTreeModel->m_Columns.m_col_draggable] = true;
      row[m_refTreeModel->m_Columns.m_col_receivesdrags] = true;

      row = *(m_refTreeModel->append());
      row[m_refTreeModel->m_Columns.m_col_id] = 3;
      row[m_refTreeModel->m_Columns.m_col_name] = "Rob McRoberts";
      row[m_refTreeModel->m_Columns.m_col_draggable] = true;
      row[m_refTreeModel->m_Columns.m_col_receivesdrags] = true;

      childrow = *(m_refTreeModel->append(row.children()));
      childrow[m_refTreeModel->m_Columns.m_col_id] = 31;
      childrow[m_refTreeModel->m_Columns.m_col_name] = "Xavier McRoberts";
      childrow[m_refTreeModel->m_Columns.m_col_draggable] = true;
      childrow[m_refTreeModel->m_Columns.m_col_receivesdrags] = true;

      //Add the TreeView's view columns:
      m_TreeView.append_column("ID", m_refTreeModel->m_Columns.m_col_id);
      m_TreeView.append_column("Name", m_refTreeModel->m_Columns.m_col_name);
      m_TreeView.append_column_editable("Draggable", m_refTreeModel->m_Columns.m_col_draggable);
      m_TreeView.append_column_editable("Receives Drags", m_refTreeModel->m_Columns.m_col_receivesdrags);

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_quit()
    {
      hide();
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

File: treemodel_dnd.cc

    #include "treemodel_dnd.h"
    #include <iostream>

    TreeModel_Dnd::TreeModel_Dnd()
    {
      //We can't just call Gtk::TreeModel(m_Columns) in the initializer list
      //because m_Columns does not exist when the base class constructor runs.
      //And we can't have a static m_Columns instance, because that would be
      //instantiated before the gtkmm type system.
      //So, we use this method, which should only be used just after creation:
      set_column_types(m_Columns);
    }

    Glib::RefPtr<TreeModel_Dnd> TreeModel_Dnd::create()
    {
      return Glib::RefPtr<TreeModel_Dnd>( new TreeModel_Dnd() );
    }

    bool TreeModel_Dnd::row_draggable_vfunc(const Gtk::TreeModel::Path& path) const
    {
      //Make the value of the "draggable" column determine whether this row can be dragged:

      TreeModel_Dnd* unconstThis = const_cast<TreeModel_Dnd*>(this); //TODO: Add a const version of get_iter to TreeModel:
      const_iterator iter = unconstThis->get_iter(path);
      //const_iterator iter = get_iter(path);
      if(iter)
      {
        Row row = *iter;
        bool is_draggable = row[m_Columns.m_col_draggable];
        return is_draggable;
      }

      return Gtk::TreeStore::row_draggable_vfunc(path);
    }

    bool TreeModel_Dnd::row_drop_possible_vfunc(const Gtk::TreeModel::Path& dest, const Gtk::SelectionData& selection_data) const
    {
      //Make the value of the "receives drags" column determine whether a row can be dragged into it:

      //dest is the path that the row would have after it has been dropped:
      //But in this case we are more interested in the parent row:
      Gtk::TreeModel::Path dest_parent = dest;
      bool dest_is_not_top_level = dest_parent.up();
      if(!dest_is_not_top_level || dest_parent.empty())
      {
        //The user wants to move something to the top-level.
        //Let's always allow that.
      }
      else
      {
        //Get an iterator for the row at this path:
        //We must unconst this. This should not be necessary with a future version of gtkmm.
        TreeModel_Dnd* unconstThis = const_cast<TreeModel_Dnd*>(this); //TODO: Add a const version of get_iter to TreeModel:
        const_iterator iter_dest_parent = unconstThis->get_iter(dest_parent);
        //const_iterator iter_dest_parent = get_iter(dest);
        if(iter_dest_parent)
        {
          Row row = *iter_dest_parent;
          bool receives_drags = row[m_Columns.m_col_receivesdrags];
          return receives_drags;
        }
      }

      //You could also examine the row being dragged (via selection_data)
      //if you must look at both rows to see whether a drop should be allowed.
      //You could use
      //TODO: Add const version of get_from_selection_data(): Glib::RefPtr<const Gtk::TreeModel> refThis = Glib::RefPtr<const Gtk::TreeModel>(this);
      //Glib::RefPtr<Gtk::TreeModel> refThis = Glib::RefPtr<Gtk::TreeModel>(const_cast<TreeModel_Dnd*>(this));
      //refThis->reference(); //, true /* take_copy */)
      //Gtk::TreeModel::Path path_dragged_row;
      //Gtk::TreeModel::Path::get_from_selection_data(selection_data, refThis, path_dragged_row);

      return Gtk::TreeStore::row_drop_possible_vfunc(dest, selection_data);
    }

#### Popup Context Menu

This example is much like the ListStore example, but derives a custom TreeView in order to override the `button_press_event`, and also to encapsulate the tree model code in our derived class. See the TreeView Popup Context Menu section.

##### TreeView - Popup Context Menu

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>
    #include "treeview_withpopup.h"

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_quit();

      //Child widgets:
      Gtk::VBox m_VBox;

      Gtk::ScrolledWindow m_ScrolledWindow;
      TreeView_WithPopup m_TreeView;

      Gtk::HButtonBox m_ButtonBox;
      Gtk::Button m_Button_Quit;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: treeview_withpopup.h

    #ifndef GTKMM_EXAMPLE_TREEVIEW_WITHPOPUP_H
    #define GTKMM_EXAMPLE_TREEVIEW_WITHPOPUP_H

    #include <gtkmm.h>

    class TreeView_WithPopup : public Gtk::TreeView
    {
    public:
      TreeView_WithPopup();
      virtual ~TreeView_WithPopup();

    protected:
      // Override Signal handler:
      // Alternatively, use signal_button_press_event().connect_notify()
      virtual bool on_button_press_event(GdkEventButton *ev);

      //Signal handler for popup menu items:
      virtual void on_menu_file_popup_generic();

      //Tree model columns:
      class ModelColumns : public Gtk::TreeModel::ColumnRecord
      {
      public:

        ModelColumns()
        { add(m_col_id); add(m_col_name); }

        Gtk::TreeModelColumn<unsigned int> m_col_id;
        Gtk::TreeModelColumn<Glib::ustring> m_col_name;
      };

      ModelColumns m_Columns;

      //The Tree model:
      Glib::RefPtr<Gtk::ListStore> m_refTreeModel;

      Gtk::Menu m_Menu_Popup;
    };

    #endif //GTKMM_EXAMPLE_TREEVIEW_WITHPOPUP_H

File: examplewindow.cc

    #include <iostream>
    #include "examplewindow.h"

    ExampleWindow::ExampleWindow()
    : m_Button_Quit("Quit")
    {
      set_title("Gtk::TreeView (ListStore) example");
      set_border_width(5);
      set_default_size(400, 200);

      add(m_VBox);

      //Add the TreeView, inside a ScrolledWindow, with the button underneath:
      m_ScrolledWindow.add(m_TreeView);

      //Only show the scrollbars when they are necessary:
      m_ScrolledWindow.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);

      m_VBox.pack_start(m_ScrolledWindow);
      m_VBox.pack_start(m_ButtonBox, Gtk::PACK_SHRINK);

      m_ButtonBox.pack_start(m_Button_Quit, Gtk::PACK_SHRINK);
      m_ButtonBox.set_border_width(5);
      m_ButtonBox.set_layout(Gtk::BUTTONBOX_END);
      m_Button_Quit.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_quit) );

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_quit()
    {
      hide();
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

File: treeview_withpopup.cc

    #include "treeview_withpopup.h"
    #include <iostream>

    TreeView_WithPopup::TreeView_WithPopup()
    {
      //Create the Tree model:
      m_refTreeModel = Gtk::ListStore::create(m_Columns);
      set_model(m_refTreeModel);

      //Fill the TreeView's model
      Gtk::TreeModel::Row row = *(m_refTreeModel->append());
      row[m_Columns.m_col_id] = 1;
      row[m_Columns.m_col_name] = "right-click on this";

      row = *(m_refTreeModel->append());
      row[m_Columns.m_col_id] = 2;
      row[m_Columns.m_col_name] = "or this";

      row = *(m_refTreeModel->append());
      row[m_Columns.m_col_id] = 3;
      row[m_Columns.m_col_name] = "or this, for a popup context menu";

      //Add the TreeView's view columns:
      append_column("ID", m_Columns.m_col_id);
      append_column("Name", m_Columns.m_col_name);

      //Fill popup menu:
      {
        Gtk::Menu::MenuList& menulist = m_Menu_Popup.items();

        menulist.push_back( Gtk::Menu_Helpers::MenuElem("_Edit",
          sigc::mem_fun(*this, &TreeView_WithPopup::on_menu_file_popup_generic) ) );
        menulist.push_back( Gtk::Menu_Helpers::MenuElem("_Process",
          sigc::mem_fun(*this, &TreeView_WithPopup::on_menu_file_popup_generic) ) );
        menulist.push_back( Gtk::Menu_Helpers::MenuElem("_Remove",
          sigc::mem_fun(*this, &TreeView_WithPopup::on_menu_file_popup_generic) ) );
      }
      m_Menu_Popup.accelerate(*this);
    }

    TreeView_WithPopup::~TreeView_WithPopup()
    {
    }

    bool TreeView_WithPopup::on_button_press_event(GdkEventButton* event)
    {
      //Call base class, to allow normal handling,
      //such as allowing the row to be selected by the right-click:
      bool return_value = TreeView::on_button_press_event(event);

      //Then do our custom stuff:
      if( (event->type == GDK_BUTTON_PRESS) && (event->button == 3) )
      {
        m_Menu_Popup.popup(event->button, event->time);
      }

      return return_value;
    }

    void TreeView_WithPopup::on_menu_file_popup_generic()
    {
      std::cout << "A popup menu item was selected." << std::endl;

      Glib::RefPtr<Gtk::TreeView::Selection> refSelection = get_selection();
      if(refSelection)
      {
        Gtk::TreeModel::iterator iter = refSelection->get_selected();
        if(iter)
        {
          int id = (*iter)[m_Columns.m_col_id];
          std::cout << "  Selected ID=" << id << std::endl;
        }
      }
    }

## TextView

The `TextView` widget can be used to display and edit large amounts of formatted text. Like the `TreeView`, it has a model/view design. In this case the `TextBuffer` is the model.

### The Buffer

`Gtk::TextBuffer` is a model containing the data for the `Gtk::TextView`, like the `Gtk::TreeModel` used by `Gtk::TreeView`. This allows two or more `Gtk::TextView`s to share the same `TextBuffer`, and allows those TextBuffers to be displayed slightly differently. Or you could maintain several `Gtk::TextBuffer`s and choose to display each one at different times in the same `Gtk::TextView` widget.

The `TextView` creates its own default `TextBuffer`, which you can access via the `get_buffer()` method.

Reference

#### Iterators

#### Tags and Formatting

##### Tags

To specify that some text in the buffer should have specific formatting, you must define a tag to hold that formatting information, and then apply that tag to the region of text. For instance, to define the tag and its properties:

    Glib::RefPtr<Gtk::TextBuffer::Tag> refTagMatch = Gtk::TextBuffer::Tag::create();
    refTagMatch->property_background() = "orange";

You can specify a name for the `Tag` when using the `create()` method, but it is not necessary.

The `Tag` class has many other properties.

Reference

##### TagTable

Each `Gtk::TextBuffer` uses a `Gtk::TextBuffer::TagTable`, which contains the `Tag`s for that buffer. 2 or more `TextBuffer`s may share the same `TagTable`. When you create `Tags` you should add them to the `TagTable`. For instance:

    Glib::RefPtr<Gtk::TextBuffer::TagTable> refTagTable = Gtk::TextBuffer::TagTable::create();
    refTagTable->add(refTagMatch);
    Glib::RefPtr<Gtk::TextBuffer> refBuffer = Gtk::TextBuffer::create(refTagTable); //Hopefully a future version of gtkmm will have a set_tag_table() method, for use after creation of the buffer.

You can also use `get_tag_table` to get, and maybe modify, the `TextBuffer`'s default `TagTable` instead of creating one explicitly.

Reference

##### Applying Tags

If you have created a `Tag` and added it to the `TagTable`, you may apply that tag to part of the `TextBuffer` so that some of the text is displayed with that formatting. You define the start and end of the range of text by specifying `Gtk::TextBuffer::iterator`s. For instance:

    refBuffer->apply_tag(refTagMatch, iterRangeStart, iterRangeStop);

Or you could specify the tag when first inserting the text: refBuffer->insert_with_tag(iter, "Some text", refTagMatch);

You can apply more than one `Tag` to the same text, by using `apply_tag()` more than once, or by using `insert_with_tags()`. The `Tags` might specify different values for the same properties, but you can resolve these conflicts by using `Tag::set_priority()`.

#### Marks

`TextBuffer` `iterators` are generally invalidated when the text changes, but you can use a `Gtk::TextBuffer::Mark` to remember a position in these situations. For instance,

    Glib::RefPtr<Gtk::TextBuffer::Mark> refMark = refBuffer->create_mark(iter);

You can then use the `get_iter()` method later to create an iterator for the `Mark`'s new position.

There are two built-in `Mark`s - `insert` and `select_bound`, which you can access with `TextBuffer`'s `get_insert()` and `get_selection_bound()` methods.

Reference

#### The View

As mentioned above, each `TextView` has a `TextBuffer`, and one or more `TextView` can share the same `TextBuffer`.

Like the `TreeView`, you should probably put your `TextView` inside a `ScrolledWindow` to allow the user to see and move around the whole text area with scrollbars.

Reference

##### Default formatting

`TextView` has various methods which allow you to change the presentation of the buffer for this particular view. Some of these may be overridden by the `Gtk::TextTag`s in the buffer, if they specify the same things. For instance, set_left_margin(), set_right_margin(), set_indent(), etc.

##### Scrolling

`Gtk::TextView` has various scroll_to_*() methods. These allow you to ensure that a particular part of the text buffer is visible. For instance, your application's Find feature might use `Gtk::TextView::scroll_to_iter()` to show the found text.

### Widgets and ChildAnchors

You can embed widgets, such as `Gtk::Button`s, in the text. Each such child widget needs a `ChildAnchor`. ChildAnchors are associated with `iterators`. For instance, to create a child anchor at a particular position, use `Gtk::TextBuffer::create_child_anchor()`:

    Glib::RefPtr<Gtk::TextChildAnchor> refAnchor = refBuffer->create_child_anchor(iter);

Then, to add a widget at that position, use `Gtk::TextView::add_child_at_anchor`:

    m_TextView.add_child_at_anchor(m_Button, refAnchor);

Reference

### Examples

#### Simple Example

##### TextView

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:

      virtual void fill_buffers();

      //Signal handlers:
      virtual void on_button_quit();
      virtual void on_button_buffer1();
      virtual void on_button_buffer2();

      //Child widgets:
      Gtk::VBox m_VBox;

      Gtk::ScrolledWindow m_ScrolledWindow;
      Gtk::TextView m_TextView;

      Glib::RefPtr<Gtk::TextBuffer> m_refTextBuffer1, m_refTextBuffer2;

      Gtk::HButtonBox m_ButtonBox;
      Gtk::Button m_Button_Quit, m_Button_Buffer1, m_Button_Buffer2;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include "examplewindow.h"

    ExampleWindow::ExampleWindow()
    : m_Button_Quit(Gtk::Stock::QUIT),
      m_Button_Buffer1("Use buffer 1"),
      m_Button_Buffer2("Use buffer 2")
    {
      set_title("Gtk::TextView example");
      set_border_width(5);
      set_default_size(400, 200);

      add(m_VBox);

      //Add the TreeView, inside a ScrolledWindow, with the button underneath:
      m_ScrolledWindow.add(m_TextView);

      //Only show the scrollbars when they are necessary:
      m_ScrolledWindow.set_policy(Gtk::POLICY_AUTOMATIC, Gtk::POLICY_AUTOMATIC);

      m_VBox.pack_start(m_ScrolledWindow);

      //Add buttons:
      m_VBox.pack_start(m_ButtonBox, Gtk::PACK_SHRINK);

      m_ButtonBox.pack_start(m_Button_Buffer1, Gtk::PACK_SHRINK);
      m_ButtonBox.pack_start(m_Button_Buffer2, Gtk::PACK_SHRINK);
      m_ButtonBox.pack_start(m_Button_Quit, Gtk::PACK_SHRINK);
      m_ButtonBox.set_border_width(5);
      m_ButtonBox.set_spacing(5);
      m_ButtonBox.set_layout(Gtk::BUTTONBOX_END);

      //Connect signals:
      m_Button_Quit.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_quit) );
      m_Button_Buffer1.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_buffer1) );
      m_Button_Buffer2.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_buffer2) );

      fill_buffers();
      on_button_buffer1();

      show_all_children();
    }

    void ExampleWindow::fill_buffers()
    {
      m_refTextBuffer1 = Gtk::TextBuffer::create();
      m_refTextBuffer1->set_text("This is the text from TextBuffer #1.");

      m_refTextBuffer2 = Gtk::TextBuffer::create();
      m_refTextBuffer2->set_text("This is some alternative text, from TextBuffer #2.");

    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_quit()
    {
      hide();
    }

    void ExampleWindow::on_button_buffer1()
    {
      m_TextView.set_buffer(m_refTextBuffer1);
    }

    void ExampleWindow::on_button_buffer2()
    {
      m_TextView.set_buffer(m_refTextBuffer2);
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

## Menus and Toolbars

There are specific APIs for Menus and toolbars, but you should usually deal with them together, using the `UIManager` to define `actions` which you can then arrange in menu and toolbars. In this way you can handle activation of the action instead of responding to the menu and toolbar items separately. And you can enable or disable both the menu and toolbar item via the action.

This involves the use of the `Gtk::ActionGroup`, `Gtk::Action`, and `UIManager` classes, all of which should be instantiated via their `create()` methods, which return `RefPtr`s.

### Actions

First create the `Action`s and add them to an `ActionGroup`, with `ActionGroup::add()`.

The arguments to `Action::create()` specify the action's name and how it will appear in menus and toolbars. Use stock items where possible so that you don't need to specify the label, accelerator, icon, and tooltips, and so you can use pre-existing translations.

You can also specify a signal handler when calling `ActionGroup::add()`. This signal handler will be called when the action is activated via either a menu item or a toolbar button.

Note that you must specify actions for sub menus as well as menu items.

For instance:

    m_refActionGroup = Gtk::ActionGroup::create();

    m_refActionGroup->add( Gtk::Action::create("MenuFile", "_File") );
    m_refActionGroup->add( Gtk::Action::create("New", Gtk::Stock::NEW),
      sigc::mem_fun(*this, &ExampleWindow::on_action_file_new) );
    m_refActionGroup->add( Gtk::Action::create("ExportData", "Export Data"),
      sigc::mem_fun(*this, &ExampleWindow::on_action_file_open) );
    m_refActionGroup->add( Gtk::Action::create("Quit", Gtk::Stock::QUIT),
      sigc::mem_fun(*this, &ExampleWindow::on_action_file_quit) );

### UIManager

Next you should create a UIManager and add the ActionGroup to the UIManager with `insert_action_group()` At this point is also a good idea to tell the parent window to respond to the specified keyboard shortcuts, by using `add_accel_group`.

For instance,

    Glib::RefPtr<Gtk::UIManager> m_refUIManager = Gtk::UIManager::create();
    m_refUIManager->insert_action_group(m_refActionGroup);
    add_accel_group(m_refUIManager->get_accel_group());

Then, you can define the actual visible layout of the menus and toolbars, and add the UI layout to the UIManager. This "ui string" uses an XML format, in which you should mention the names of the actions that you have already created. For instance:

        Glib::ustring ui_info =
            "<ui>"
            "  <menubar name='MenuBar'>"
            "    <menu action='MenuFile'>"
            "      <menuitem action='New'/>"
            "      <menuitem action='Open'/>"
            "      <separator/>"
            "      <menuitem action='Quit'/>"
            "    </menu>"
            "    <menu action='MenuEdit'>"
            "      <menuitem action='Cut'/>"
            "      <menuitem action='Copy'/>"
            "      <menuitem action='Paste'/>"
            "    </menu>"
            "  </menubar>"
            "  <toolbar  name='ToolBar'>"
            "    <toolitem action='Open'/>"
            "    <toolitem action='Quit'/>"
            "  </toolbar>"
            "</ui>";

        m_refUIManager->>add_ui_from_string(ui_info);

To instantiate a Gtk::MenuBar or Gtk::Toolbar which you can actually show, you should use the `UIManager::get_widget()` method, and then add the widget to a container. For instance:

    Gtk::Widget* pMenubar = m_refUIManager->get_widget("/MenuBar");
    pBox->add(*pMenuBard, Gtk::PACK_SHRINK);

### Popup Menus

TODO: Update for UIManager API. Menus are normally just added to a window, but they can also be displayed temporarily as the result of a mouse button click. For instance, a context menu might be diplayed when the user clicks their right mouse button. You can use `Gtk::Menu`'s `popup()` method, but you need to provide a button identifier and the time of activation. This information is provided by the `button_press_event` signal, which you will need to handle anyway. For instance:

    bool ExampleWindow::on_button_press_event(GdkEventButton* event)
    {
      if( (event->type == GDK_BUTTON_PRESS) && (event->button == 3) )
      {
        m_Menu_Popup.popup(event->button, event->time);
        return true; //It has been handled.
      }
      else
        return false;
    }

### Examples

#### Main Menu example

##### Main Menu

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm/window.h>
    #include <gtkmm/box.h>
    #include <gtkmm/uimanager.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_menu_file_new_generic();
      virtual void on_menu_file_quit();
      virtual void on_menu_others();

      //Child widgets:
      Gtk::VBox m_Box;

      Glib::RefPtr<Gtk::UIManager> m_refUIManager;
      Glib::RefPtr<Gtk::ActionGroup> m_refActionGroup;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include "examplewindow.h"
    #include <gtkmm/stock.h>
    #include <iostream>

    ExampleWindow::ExampleWindow()
    {
      set_title("main menu example");
      set_default_size(200, 200);

      add(m_Box); //We can put a MenuBar at the top of the box and other stuff below it.

      //Create actions for menus and toolbars:
      m_refActionGroup = Gtk::ActionGroup::create();

      //File|New sub menu:
      m_refActionGroup->add( Gtk::Action::create("FileNewStandard", Gtk::Stock::NEW, "_New", "Create a new file"),
        sigc::mem_fun(*this, &ExampleWindow::on_menu_file_new_generic) );

      m_refActionGroup->add( Gtk::Action::create("FileNewFoo", Gtk::Stock::NEW, "New Foo", "Create a new foo"),
        sigc::mem_fun(*this, &ExampleWindow::on_menu_file_new_generic) );

      m_refActionGroup->add( Gtk::Action::create("FileNewGoo", Gtk::Stock::NEW, "_New Goo", "Create a new goo"),
        sigc::mem_fun(*this, &ExampleWindow::on_menu_file_new_generic) );

      //File menu:
      m_refActionGroup->add( Gtk::Action::create("FileMenu", "File") );
      m_refActionGroup->add( Gtk::Action::create("FileNew", Gtk::Stock::NEW) ); //Sub-menu.
      m_refActionGroup->add( Gtk::Action::create("FileQuit", Gtk::Stock::QUIT),
        sigc::mem_fun(*this, &ExampleWindow::on_menu_file_quit) );

      //Edit menu:
      m_refActionGroup->add( Gtk::Action::create("EditMenu", "Edit") );
      m_refActionGroup->add( Gtk::Action::create("EditCopy", Gtk::Stock::COPY),
        sigc::mem_fun(*this, &ExampleWindow::on_menu_others) );
      m_refActionGroup->add( Gtk::Action::create("EditPaste", Gtk::Stock::PASTE),
        sigc::mem_fun(*this, &ExampleWindow::on_menu_others) );
      m_refActionGroup->add( Gtk::Action::create("EditSomething", "Something"),
        sigc::mem_fun(*this, &ExampleWindow::on_menu_others) );

      //Help menu:
      m_refActionGroup->add( Gtk::Action::create("HelpMenu", "Help") );
      m_refActionGroup->add( Gtk::Action::create("HelpAbout", Gtk::Stock::HELP),
        sigc::mem_fun(*this, &ExampleWindow::on_menu_others) );

      m_refUIManager = Gtk::UIManager::create();
      m_refUIManager->insert_action_group(m_refActionGroup);

      add_accel_group(m_refUIManager->get_accel_group());

      //Layout the actions in a menubar and toolbar:
      try
      {
        Glib::ustring ui_info =
            "<ui>"
            "  <menubar name='MenuBar'>"
            "    <menu action='FileMenu'>"
            "      <menu action='FileNew'>"
            "        <menuitem action='FileNewStandard'/>"
            "        <menuitem action='FileNewFoo'/>"
            "        <menuitem action='FileNewGoo'/>"
            "      </menu>"
            "      <separator/>"
            "      <menuitem action='FileQuit'/>"
            "    </menu>"
            "    <menu action='EditMenu'>"
            "      <menuitem action='EditCopy'/>"
            "      <menuitem action='EditPaste'/>"
            "      <menuitem action='EditSomething'/>"
            "    </menu>"
            "    <menu action='HelpMenu'>"
            "      <menuitem action='HelpAbout'/>"
            "    </menu>"
            "  </menubar>"
            "  <toolbar  name='ToolBar'>"
            "    <toolitem action='FileNewStandard'/>"
            "    <toolitem action='FileQuit'/>"
            "  </toolbar>"
            "</ui>";

        m_refUIManager->add_ui_from_string(ui_info);
      }
      catch(const Glib::Error& ex)
      {
        std::cerr << "building menus failed: " <<  ex.what();
      }

      //Get the menubar and toolbar widgets, and add them to a container widget:
      Gtk::Widget* pMenubar = m_refUIManager->get_widget("/MenuBar");
      if(pMenubar)
        m_Box.pack_start(*pMenubar, Gtk::PACK_SHRINK);

      Gtk::Widget* pToolbar = m_refUIManager->get_widget("/ToolBar") ;
      if(pToolbar)
        m_Box.pack_start(*pToolbar, Gtk::PACK_SHRINK);

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_menu_file_quit()
    {
      hide(); //Closes the main window to stop the Gtk::Main::run().
    }

    void ExampleWindow::on_menu_file_new_generic()
    {
       std::cout << "A File|New menu item was selected." << std::endl;
    }

    void ExampleWindow::on_menu_others()
    {
      std::cout << "A menu item was selected." << std::endl;
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

#### Popup Menu example

##### Popup Menu

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual bool on_button_press_event(GdkEventButton* event);
      virtual void on_menu_file_popup_generic();

      //Child widgets:
      Gtk::VBox m_Box;
      Gtk::EventBox m_EventBox;
      Gtk::Label m_Label;

      Glib::RefPtr<Gtk::UIManager> m_refUIManager;
      Glib::RefPtr<Gtk::ActionGroup> m_refActionGroup;

      Gtk::Menu* m_pMenuPopup;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include "examplewindow.h"
    #include <gtkmm/stock.h>
    #include <iostream>

    ExampleWindow::ExampleWindow()
    : m_Label("Right-click to see the popup menu."),
      m_pMenuPopup(0)
      /* m_Image(Gtk::Stock::DIALOG_QUESTION, Gtk::ICON_SIZE_MENU) */
    {
      set_title("popup example");
      set_default_size(200, 200);

      add(m_Box);

      //Add an event box that can catch button_press events:
      m_Box.pack_start(m_EventBox);
      m_EventBox.signal_button_press_event().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_press_event) );

      m_EventBox.add(m_Label);

      //Create actions:

      //Fill menu:

      m_refActionGroup = Gtk::ActionGroup::create();

      //File|New sub menu:
      //These menu actions would normally already exist for a main menu, because a context menu
      //should not normally contain menu items that are only available via a context menu.
      m_refActionGroup->add( Gtk::Action::create("ContextMenu", "Context Menu") );

      m_refActionGroup->add( Gtk::Action::create("ContextEdit", "Edit"),
        sigc::mem_fun(*this, &ExampleWindow::on_menu_file_popup_generic) );

      m_refActionGroup->add( Gtk::Action::create("ContextProcess", "Process"),
        sigc::mem_fun(*this, &ExampleWindow::on_menu_file_popup_generic) );

      m_refActionGroup->add( Gtk::Action::create("ContextRemove", "Remove"),
        sigc::mem_fun(*this, &ExampleWindow::on_menu_file_popup_generic) );

      //TODO:
      /*
        //Add a ImageMenuElem:
        menulist.push_back( Gtk::Menu_Helpers::ImageMenuElem("_Something", m_Image,
          sigc::mem_fun(*this, &ExampleWindow::on_menu_file_popup_generic) ) ) ;
      */

      m_refUIManager = Gtk::UIManager::create();
      m_refUIManager->insert_action_group(m_refActionGroup);

      add_accel_group(m_refUIManager->get_accel_group());

      //Layout the actions in a menubar and toolbar:
      try
      {
        Glib::ustring ui_info =
            "<ui>"
            "  <menubar name='MenuBar'>"
            "    <menu name='ContextMenu'>"
            "        <menuitem action='ContextEdit'/>"
            "        <menuitem action='ContextProcess'/>"
            "        <menuitem action='ContextRemove'/>"
            "    </menu>"
            "  </menubar>"
            "</ui>";

        m_refUIManager->add_ui_from_string(ui_info);
      }
      catch(const Glib::Error& ex)
      {
        std::cerr << "building menus failed: " <<  ex.what();
      }

      //Get the menu:
      m_pMenuPopup = dynamic_cast<Gtk::Menu*>( m_refUIManager->get_widget("/MenuBar/ContextMenu") );

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_menu_file_popup_generic()
    {
       std::cout << "A popup menu item was selected." << std::endl;
    }

    bool ExampleWindow::on_button_press_event(GdkEventButton* event)
    {
      if( (event->type == GDK_BUTTON_PRESS) && (event->button == 3) )
      {
        if(m_pMenuPopup)
          m_pMenuPopup->popup(event->button, event->time);

        return true; //It has been handled.
      }
      else
        return false;
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

## Adjustments

gtkmm has various widgets that can be visually adjusted using the mouse or the keyboard, such as the Range widgets (described in the Range Widgets section). There are also a few widgets that display some adjustable part of a larger area, such as the Viewport widget. These widgets have `Gtk::Adjustment` objects that express this common part of their API.

So that applications can react to changes, for instance when a user moves a scrollbar, `Gtk::Adjustment` has a `changed` signal. You can then use the `get_changed()` method to discover the new value.

### Creating an Adjustment

The `Gtk::Adjustment` constructor is as follows:

    Gtk::Adjustment(float value,
                    float lower,
                    float upper,
                    float step_increment = 1,
                    float page_increment = 10,
                    float page_size = 0);

The `value` argument is the initial value of the adjustment, usually corresponding to the topmost or leftmost position of an adjustable widget. The `lower` and `upper` arguments specifies the possible range of values which the adjustment can hold. The `step&lowbar;increment` argument specifies the smaller of the two increments by which the user can change the value, while the `page&lowbar;increment` is the larger one. The `page&lowbar;size` argument usually corresponds somehow to the visible area of a panning widget. The `upper` argument is used to represent the bottom most or right most coordinate in a panning widget's child. TODO: Investigate the upper argument properly. There was some unclear stuff about it not always being the upper value.

### Using Adjustments the Easy Way

The adjustable widgets can be roughly divided into those which use and require specific units for these values, and those which treat them as arbitrary numbers.

The group which treats the values as arbitrary numbers includes the Range widgets (Scrollbars and Scales, the Progressbar widget, and the SpinButton widget). These widgets are typically "adjusted" directly by the user with the mouse or keyboard. They will treat the `lower` and `upper` values of an adjustment as a range within which the user can manipulate the adjustment's `value`. By default, they will only modify the `value` of an adjustment.

The other group includes the `Viewport` widget and the `ScrolledWindow` widget. All of these widgets use pixel values for their adjustments. These are also typically adjusted indirectly using scrollbars. While all widgets which use adjustments can either create their own adjustments or use ones you supply, you'll generally want to let this particular category of widgets create its own adjustments.

TODO: Text widget is deprecated: Look at GTK+ tutorial for up-to-date example. If you share an adjustment object between a Scrollbar and a Text widget, manipulating the scrollbar will automagically adjust the Text widget. You can set it up like this:

      // creates its own adjustments
      Gtk::Text text(0, 0);
      // uses the newly-created adjustment for the scrollbar as well
      Gtk::VScrollbar vscrollbar (*(text.get_vadjustment()));

### Adjustment Internals

OK, you say, that's nice, but what if I want to create my own handlers to respond when the user adjusts a Range widget or a SpinButton. To access the value of a `Gtk::Adjustment`, you can use the `get_value()` and `set_value()` methods:

As mentioned earlier, `Gtk::Adjustment` can emit signals. This is, of course, how updates happen automagically when you share an Adjustment object between a Scrollbar and another adjustable widget; all adjustable widgets connect signal handlers to their adjustment's `value&lowbar;changed` signal, as can your program.

So, for example, if you have a Scale widget, and you want to change the rotation of a picture whenever its value changes, you would create a signal handler like this:

    void cb_rotate_picture (Gtk::Widget *picture)
    {
      picture->set_rotation (adj->value);
    ...

and connect it to the scale widget's adjustment like this:

    adj.value_changed.connect(sigc::bind<Widget*>(sigc::mem_fun(*this, &cb_rotate_picture), picture));

What if a widget reconfigures the `upper` or `lower` fields of its Adjustment, such as when a user adds more text to a text widget? In this case, it emits the `changed` signal.

Range widgets typically connect a handler to this signal, which changes their appearance to reflect the change - for example, the size of the slider in a scrollbar will grow or shrink in inverse proportion to the difference between the `lower` and `upper` values of its adjustment.

You probably won't ever need to attach a handler to this signal, unless you're writing a new type of range widget.

    adjustment->changed();

## Widgets Without X-Windows

Some Widgets do not have an associated X-Window, so they therefore do not receive X events. This means that the signals described in the X event signals section will not be emitted. If you want to capture events for these widgets you can use a special container called `Gtk::EventBox`, which is described in the EventBox section.

Here is a list of some of these Widgets:

    Gtk::Alignment
    Gtk::Arrow
    Gtk::Bin
    Gtk::Box
    Gtk::Image
    Gtk::Item
    Gtk::Label
    Gtk::Pixmap
    Gtk::ScrolledWindow
    Gtk::Separator
    Gtk::Table
    Gtk::AspectFrame
    Gtk::Frame
    Gtk::VBox
    Gtk::HBox
    Gtk::VSeparator
    Gtk::HSeparator

These widgets are mainly used for decoration or layout, so you won't often need to capture events on them. They are intended to have no X-Window in order to improve performance.

### EventBox

TODO: Why don't they have X Windows - explain clipping. Some gtkmm widgets don't have associated X windows; they draw on their parents' windows. Because of this, they cannot receive events. Also, if they are incorrectly sized, they don't clip, so you can get messy overwriting etc. If you require more from these widgets, the EventBox is for you. Although the name EventBox emphasises the event-handling method, the widget can also be used for clipping (and more; see the example below).

The constructor for `Gtk::EventBox` is:

    Gtk::EventBox();

A child widget can be added to the EventBox using:

    event_box.add(child_widget);

Reference

#### Example

The following example demonstrates both uses of an `EventBox` - a label is created that is clipped to a small box, and set up so that a mouse-click on the label causes the program to exit. Resizing the window reveals varying amounts of the label.

##### EventBox

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual bool on_eventbox_button_press(GdkEventButton* event);

      //Child widgets:
      Gtk::EventBox m_EventBox;
      Gtk::Label m_Label;
      Gtk::Tooltips m_Tooltips;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include "examplewindow.h"

    ExampleWindow::ExampleWindow()
    : m_Label("Click here to quit, quit, quit, quit, quit")
    {
      set_title ("EventBox");
      set_border_width(10);

      add(m_EventBox);

      m_EventBox.add(m_Label);

      //Clip the label short:
      m_Label.set_size_request(110, 20);

      //And bind an action to it:
      m_EventBox.set_events(Gdk::BUTTON_PRESS_MASK);
      m_EventBox.signal_button_press_event().connect(
        sigc::mem_fun(*this, &ExampleWindow::on_eventbox_button_press) );

      m_Tooltips.set_tip(m_EventBox, "Click me!");

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    bool ExampleWindow::on_eventbox_button_press(GdkEventButton*)
    {
      hide();
      return true;
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

## Dialogs

Dialogs are used as secondary windows, to provide specific information or to ask questions. `Gtk::Dialog` windows contain a few pre-packed widgets to ensure consistency, and a `run()` method which blocks until the user dismisses the dialog.

There are several derived dialog classes which you might find useful. For instance, you will probably use `Gtk::MessageDialog` for most simple notifications. But at other times you might need to derive your own dialog class to provide more complex functionality.

To pack widgets into a custom dialog, you should pack them into the `Gtk::VBox`, available via `get_vbox()`. To just add a button to the bottom of the dialog, you could use the `add_button()` method.

The `run()` method returns an `int`. This may be a value from the `Gtk::ResponseType` if the user closed the button by clicking a standard button, or it could be the custom response value that you specified when using `add_button()`.

Reference

### MessageDialog

This is a convenience class, used to create simple, standard message dialogs, with a message, an icon, and buttons for user response. You can specify the type of message and the text in the constructor, as well as specifying standard buttons via `OR`ed `Gtk::ButtonsType` values.

Reference

#### Example

##### MessageDialog

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_info_clicked();
      virtual void on_button_question_clicked();

      //Child widgets:
      Gtk::VButtonBox m_ButtonBox;
      Gtk::Button m_Button_Info, m_Button_Question;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include "examplewindow.h"
    #include <gtkmm/dialog.h>
    #include <iostream>

    ExampleWindow::ExampleWindow()
    : m_Button_Info("Show Info MessageDialog"),
      m_Button_Question("Show Question MessageDialog")
    {
      set_title("Gtk::MessageDialog example");

      add(m_ButtonBox);

      m_ButtonBox.pack_start(m_Button_Info);
      m_Button_Info.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_info_clicked) );

      m_ButtonBox.pack_start(m_Button_Question);
      m_Button_Question.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_question_clicked) );

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_info_clicked()
    {
      Gtk::MessageDialog dialog(*this, "This is an INFO MessageDialog");
      dialog.run();
    }

    void ExampleWindow::on_button_question_clicked()
    {
      Gtk::MessageDialog dialog(*this, "This is a QUESTION MessageDialog", false /* use_markup */, Gtk::MESSAGE_QUESTION, (Gtk::ButtonsType)(Gtk::BUTTONS_OK | Gtk::BUTTONS_CANCEL));
      int result = dialog.run();

      //Handle the response:
      switch(result)
      {
        case(Gtk::RESPONSE_OK):
        {
          std::cout << "OK clicked." << std::endl;
          break;
        }
        case(Gtk::RESPONSE_CANCEL):
        {
          std::cout << "Cancel clicked." << std::endl;
          break;
        }
        default:
        {
          std::cout << "Unexpected button clicked." << std::endl;
          break;
        }
      }

    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

### FileChooserDialog

This dialog is suitable for use with "Open" or "Save" menu items.

Most useful member methods for this class are actually in the Gtk::FileChooser base class.

Reference

#### Example

##### FileChooser

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_file_clicked();
      virtual void on_button_folder_clicked();

      //Child widgets:
      Gtk::VButtonBox m_ButtonBox;
      Gtk::Button m_Button_File, m_Button_Folder;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include "examplewindow.h"
    #include <iostream>

    ExampleWindow::ExampleWindow()
    : m_Button_File("Choose File"),
      m_Button_Folder("Choose Folder")
    {
      set_title("Gtk::FileSelection example");

      add(m_ButtonBox);

      m_ButtonBox.pack_start(m_Button_File);
      m_Button_File.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_file_clicked) );

      m_ButtonBox.pack_start(m_Button_Folder);
      m_Button_Folder.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_folder_clicked) );

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_folder_clicked()
    {
      Gtk::FileChooserDialog dialog("Please choose a folder", Gtk::FILE_CHOOSER_ACTION_SELECT_FOLDER);
      dialog.set_transient_for(*this);

      //Add response buttons the the dialog:
      dialog.add_button(Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
      dialog.add_button("Select", Gtk::RESPONSE_OK);

      int result = dialog.run();

      //Handle the response:
      switch(result)
      {
        case(Gtk::RESPONSE_OK):
        {
          std::cout << "Select clicked." << std::endl;
          std::cout << "Folder selected: " << dialog.get_filename() << std::endl;
          break;
        }
        case(Gtk::RESPONSE_CANCEL):
        {
          std::cout << "Cancel clicked." << std::endl;
          break;
        }
        default:
        {
          std::cout << "Unexpected button clicked." << std::endl;
          break;
        }
      }
    }

    void ExampleWindow::on_button_file_clicked()
    {
      Gtk::FileChooserDialog dialog("Please choose a file", Gtk::FILE_CHOOSER_ACTION_OPEN);
      dialog.set_transient_for(*this);

      //Add response buttons the the dialog:
      dialog.add_button(Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
      dialog.add_button(Gtk::Stock::OPEN, Gtk::RESPONSE_OK);

      //Add filters, so that only certain file types can be selected:

      Gtk::FileFilter filter_text;
      filter_text.set_name("Text files");
      filter_text.add_mime_type("text/plain");
      dialog.add_filter(filter_text);

      Gtk::FileFilter filter_cpp;
      filter_cpp.set_name("C/C++ files");
      filter_cpp.add_mime_type("text/x-c");
      filter_cpp.add_mime_type("text/x-c++");
      filter_cpp.add_mime_type("text/x-c-header");
      dialog.add_filter(filter_cpp);

      Gtk::FileFilter filter_any;
      filter_any.set_name("Any files");
      filter_any.add_pattern("*");
      dialog.add_filter(filter_any);

      //Show the dialog and wait for a user response:
      int result = dialog.run();

      //Handle the response:
      switch(result)
      {
        case(Gtk::RESPONSE_OK):
        {
          std::cout << "Open clicked." << std::endl;

          std::string filename = dialog.get_filename(); //Notice that it is a std::string, not a Glib::ustring.
          std::cout << "File selected: " <<  filename << std::endl;
          break;
        }
        case(Gtk::RESPONSE_CANCEL):
        {
          std::cout << "Cancel clicked." << std::endl;
          break;
        }
        default:
        {
          std::cout << "Unexpected button clicked." << std::endl;
          break;
        }
      }

    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

### ColorSelectionDialog

This dialog allows the user to choose a color.

Reference

#### Example

##### ColorSelectionDialog

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_color_set();

      //Child widgets:
      Gtk::VBox m_VBox;
      Gtk::ColorButton m_Button;
      Gtk::DrawingArea m_DrawingArea; //To show the color.

      Gdk::Color m_Color;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include "examplewindow.h"
    #include <iostream>

    ExampleWindow::ExampleWindow()
    {
      set_title("Gtk::ColorButton example");
      set_default_size(200, 200);

      add(m_VBox);

      m_VBox.pack_start(m_Button, Gtk::PACK_SHRINK);
      m_Button.signal_color_set().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_color_set) );

      //Set start color:
      m_Color.set_red(0);
      m_Color.set_blue(65535);
      m_Color.set_green(0);
      m_Button.set_color(m_Color);

      m_DrawingArea.modify_bg(Gtk::STATE_NORMAL, m_Color);

      m_VBox.pack_start(m_DrawingArea);

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_color_set()
    {
      //Store the chosen color, and show it:
      m_Color = m_Button.get_color();
      m_DrawingArea.modify_bg(Gtk::STATE_NORMAL, m_Color);
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

### FontSelectionDialog

This dialog allows the user to choose a font.

Reference

#### Example

##### FontSelectionDialog

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_font_set();

      //Child widgets:
      Gtk::FontButton m_Button;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include "examplewindow.h"
    #include <iostream>

    ExampleWindow::ExampleWindow()
    : m_Button("sans")
    {
      set_title("Gtk::FontSelectionDialog example");

      add(m_Button);
      m_Button.signal_font_set().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_font_set) );

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_font_set()
    {
      Glib::ustring font_name = m_Button.get_font_name();
      std::cout << "Font chosen: " << font_name << std::endl;
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

## The Drawing Area Widget

The DrawingArea widget is a blank X window that gives you the freedom to create any graphic you desire. Along with that freedom comes the responsibility to handle expose events on the widget. When a widget is first shown, or when it is covered and then uncovered again it needs to redraw itself. Most widgets have code to do this, but the DrawingArea does not, allowing you to write an expose event signal handler to determine how the contents of the widget will be drawn.

There are a number of methods to help you draw various objects into the widget, such as pixels, lines, rectangles, elipses, polygons, images, and text. We'll take each one in turn and give an example of its use.

### Graphics Contexts

Before getting into the actual drawing routines, some background information about graphics contexts is needed. Graphics contexts are a server-side resource. They contain information that describes how drawing is to be done. This provides for fewer arguments to the drawing methods, and less communication between the client and the server. The following example shows how to set up a graphics context with a foreground color of red for drawing.

    Gdk::GC some_gc;
    some_gc.create(get_window());
    Gdk::Color some_color;
    Gdk::Colormap some_colormap(Gdk::Colormap::get_system());
    some_color.set_red(65535);
    some_color.set_green(0);
    some_color.set_blue(0);
    some_colormap.alloc(some_color);
    some_gc.set_foreground(some_color);

The first two lines create the graphics context and assign it to the appropriate widget. The `get_window()` method is a part of the `Gtk::Widget` class, so if you put this code into a derived widget's implementation then you can call it just as it is, otherwise you'd use `some_widget.get_window()`.

The next two lines create the `Gdk::Color` and `Gdk::Colormap`. After setting the color values you then need to allocate the color. The system figures out what to do in this case. The colormap contains information about how colors can be displayed on your screen, and is able to allocate the requested color. For example, on a display of only 256 colors the exact color requested may not be available, so the closest color to the one requested will be used instead. The final line sets the color as the foreground color.

There are a number of attributes that can be set for a graphics context. There's the foreground and background color. When drawing lines, you can set the thickness of the line with `set_line_width()`. Whether a solid or dashed line is drawn can be set with `set_line_style()`. The size and proportions of the dashes are set with `set_dashes`. How two lines join together, whether round or pointed or beveled off, is set with `set_join_style()`. Other things that can be set within a graphics context include font style, stippling and tiling for the filling of solid polygons.

### Drawing Pixels

You can draw individual pixels with the two methods `Gdk::Drawable::draw_point()` and `Gdk::Drawable::draw_points()`. All drawing methods take a `Gdk::GC` as their first argument, except where noted. The other two arguments to `draw_point()` are the x coordinate (horizontal position relative to the left edge of the widget, starting at 0), and the y coordinate (vertical position relative to the top of the widget, starting at 0). `draw_points()` takes two arguments, the `Gdk::GC` and a collection of `Gdk::Points`. The second argument can be any kind of standard container, such as a `std::vector<Gdk::Point>`. So for example `draw_point()` could be used like this:

    get_window()->draw_point(some_gc, 20, 20);

But `draw_points()` is a bit more complicated and might be used like this:

    std::vector<Gdk::Point> points_array;
    points_array.push_back(Gdk::Point(10, 10));
    points_array.push_back(Gdk::Point(20, 20));
    draw_points(some_gc, points_array); //One way to draw the two points.

### Drawing Lines

#### Example

Drawing lines is more interesting than just points, so here is a complete program:

##### Drawing Area - Lines

Source Code

File: myarea.h

    #ifndef GTKMM_EXAMPLE_MYAREA_H
    #define GTKMM_EXAMPLE_MYAREA_H

    #include <gtkmm/drawingarea.h>
    #include <gdkmm/colormap.h>
    #include <gdkmm/window.h>

    class MyArea : public Gtk::DrawingArea
    {
    public:
      MyArea();
      virtual ~MyArea();

    protected:
      //Overridden default signal handlers:
      virtual void on_realize();
      virtual bool on_expose_event(GdkEventExpose* e);

      Glib::RefPtr<Gdk::GC> gc_;
      Gdk::Color blue_, red_;
    };

    #endif // GTKMM_EXAMPLE_MYAREA_H

File: main.cc

    #include "myarea.h"
    #include <gtkmm/main.h>
    #include <gtkmm/window.h>

    int main(int argc, char** argv)
    {
       Gtk::Main kit(argc, argv);

       Gtk::Window win;

       MyArea area;
       win.add(area);
       area.show();

       Gtk::Main::run(win);

       return 0;
    }

File: myarea.cc

    #include "myarea.h"

    MyArea::MyArea()
    {
      // get_window() would return 0 because the Gdk::Window has not yet been realized
      // So we can only allocate the colors here - the rest will happen in on_realize().
      Glib::RefPtr<Gdk::Colormap> colormap = get_default_colormap ();

      blue_ = Gdk::Color("blue");
      red_ = Gdk::Color("red");

      colormap->alloc_color(blue_);
      colormap->alloc_color(red_);
    }

    MyArea::~MyArea()
    {
    }

    void MyArea::on_realize()
    {
      // We need to call the base on_realize()
      Gtk::DrawingArea::on_realize();

      // Now we can allocate any additional resources we need
      Glib::RefPtr<Gdk::Window> window = get_window();
      gc_ = Gdk::GC::create(window);
      window->set_background(red_);
      window->clear();
      gc_->set_foreground(blue_);
    }

    bool MyArea::on_expose_event(GdkEventExpose* /* event */)
    {
      // This is where we draw on the window
      Glib::RefPtr<Gdk::Window> window = get_window();
      window->clear();
      window->draw_line(gc_, 1, 1, 100, 100);
      return true;
    }

This program contains two classes. The first is a subclass of `Gtk::DrawingArea` and contains an `on_expose_event` member function. This method is called whenever the image in the drawing area needs to be redrawn. The four additional arguments to `draw_line()` (besides the graphics context as the first) are the coordinates for the start and end of the line.

The `TestWindow` class contains a drawing area. When it is created, it creates a drawing area of 50 pixels across by 50 pixels tall. If the window is resized, the graphic drawn is kept in the top left corner of the larger window. The drawing area is created with a default grey background.

### Drawing Rectangles and Polygons

The `draw_rectangle()` method draws rectangles and squares. The second argument determines whether the rectangle is filled. Give a non-zero value to have the rectangle filled. The third and fourth arguments specify the x and y coordiates of the upper-left corner of the rectangle, respectively. The last two arguments specify the width and height (in pixels) of the rectangle.

Because of the way X handles drawing, an outline rectangle is one pixel taller and wider than a filled rectangle. If you want a rectangle with an outline of one color and a fill of another color, you need to draw the filled rectangle first. Otherwise the filled rectangle will obscure the top and left edges of the outline rectangle. You may need to subtract one pixel from the width and height of the outline rectangle to get the size you expect.

The `draw_polygon()` method takes a `Glib::ArrayHandle<Gdk::Point>`, which is another way of saying a standard container of `Gdk::Point`, just like we saw in `draw_points()` above. The first argument is the `Gdk::GC` and the second argument determines if the polygon is a filled one or an outline, just like for the `draw_rectangle()`. The polygon's shape is taken by drawing a line from the first point to the second, and so on to the last point in the list, and from there a line is drawn back to the first point. This of course implies that you do not need to repeat the first point as the last point.

### Drawing Ellipses and Arcs

The `draw_arc()` has a lot of parameters. The second one is again for the choice of filled or unfilled arc. The next two arguments are the x and y coordinates of the upper left corner of the circle. Imagine a rectangle surrounding the circle, and just touching it at the top, bottom, and sides. The upper left corner of this box is the point specified by the x and y coordinates. The width and height of this box are the next two arguments. A wide box will make a wide elliptical shape.

The final two arguments define the starting and ending angle, in case you do not want to make a complete circle. The angle is measured in 1/64th of a degree, starts at the right, and runs counter-clockwise.

### Drawing Text

Text is drawn via Pango Layouts. The easiest way to create a `Pango::Layout` is to use `create_pango_layout`. Once created, the layout can be manipulated in various ways, including changing the text, font, etc. Finally, the layout can be rendered using the `draw_layout` method of `Gdk::Drawable`, which takes the usual `Gdk::GC`, an x-position, a y-position and the layout itself.

#### Example

Here's a sample program using all of the drawing methods shown so far:

##### Drawing Area - Text

Source Code

The structure of the program is the same as the first one, except that this one includes examples of the drawing elements discussed up to now.

### Draw Images

There are a couple of drawing methods for putting image data into a drawing area. `draw_pixmap()` can copy the contents of a `Gdk::Drawable` (the window of a drawing area is one) into the drawing area. There is also `draw_bitmap()` for drawing a two-color image into the drawing area, and `draw_image()` for drawing an image with more than two colors.

For all of these methods, the first argument is the `Gdk::GC`. The second argument is the object of the appropriate type to copy in: `Gdk::Drawable`, `Gdk::Bitmap`, `Gdk::Image`. The next two arguments are the x and y points in the image to begin copying from. Then come the x and y points in the drawing area to copy to. The final two arguments are the width and height of the area to copy.

There is also a method for drawing from a `Gdk::Pixbuf`. A `Gdk::Pixbuf` buffer is a useful wrapper around a collection of pixels, which can be read from files, and manipulated in various ways.

Probably the most common way of creating `Gdk::Pixbuf`s is to use `Gdk::Pixbuf::create_from_file()`, which can read an image file, such as a png file into a pixbuf ready for rendering.

The `Gdk::Pixbuf` can be rendered with `render_to_drawable`, which takes quite a few parameters. The `render_to_drawable` is a member of `Gdk::Pixbuf` rather than `Gdk::Drawable`, which is unlike the `draw_*` functions described earlier. As such, its first parameter is the drawable to render to. The second parameter is still the `Gdk::GC`. The next two parameters are the point in the pixbuf to start drawing from. This is followed by the point in the drawable to draw it at, and by the width and height to actually draw (which may not be the whole image, especially if you're only responding to an expose event for part of the window). Finally, there are the dithering parameters. If you use Gdk::RGB_DITHER_NONE as the dither type, then the dither offset parameters can both be 0.

Here is a small bit of code to tie it all together: (Note that usually you wouldn't load the image every time in the expose event handler! It's just shown here to keep it all together)

    bool myarea::on_expose_event(GdkEventExpose* ev)
    {
      Glib::RefPtr<Gdk::PixBuf> image = Gdk::PixBuf::create_from_file("myimage.png");
      image->render_to_drawable(get_window(), get_style()->get_black_gc(),
        0, 0, 100, 80, image->get_width(), image->get_height(), // draw the whole image (from 0,0 to the full width,height) at 100,80 in the window
        Gdk::RGB_DITHER_NONE, 0, 0);
      return true;
    }

## Drag and Drop

Gtk::Widget has several methods and signals which are prefixed with "drag_". These are used for Drag and Drop.

### Sources and Destinations

Things are dragged from `sources` to be dropped on `destinations`. Each source and destination has infomation about the data formats that it can send or receive, provided by `Gtk::TargetEntry` items. A drop destination will only accept a dragged item if they both share a compatible Gtk::TargetEntry item. Appropriate signals will then be emitted, telling the signal handlers which Gtk::TargetEntry was used.

Gtk::TargetEntry objects contain this information&colon;

- target: A name, such as "STRING"

- info: An identifier which will be sent to your signals to tell you which TargetEntry was used.

- flags: TODO

### Methods

Widgets can be identified as sources or destinations using these Gtk::Widget methods:

    void drag_source_set(const ArrayHandle_TargetEntry& targets, GdkModifierType start_button_mask, GdkDragAction actions);

- `targets` is a container of Gtk&colon;&colon;TargetEntry (std&colon;&colon;list<Gtk&colon;&colon;TargetEntry> or std::vector<Gtk&colon;&colon;TargetEntry>, for instance) elements.

- `start_button_mask` is an ORed combination of values, which specify which modifier key or mouse button must be pressed to start the drag.

- `actions` is an ORed combination of values, which specified which Drag and Drop operations will be possible from this source - for instance, copy, move, or link. The user can choose between the actions by using modifier keys, such as `Shift` to change from `copy` to `move`, and this will be shown by a different cursor.

    void drag_dest_set(const ArrayHandle_TargetEntry& targets, GtkDestDefaults flags, GdkDragAction actions);

- `flags` is an ORed combination of values which indicates how the widget will respond visually to Drag and Drop items.

- `actions` indicates the Drag and Drop actions which this destination can receive - see the description above.

### Signals

When a drop destination has accepted a dragged item, certain signals will be emitted, depending on what action has been selected. For instance, the user might have held down the `Shift` key to specify a `move` rather than a `copy`. Remember that the user can only select the actions which you have specified in your calls to `drag_dest_set()` and `drag_source_set()`.

#### Copy

The source widget will emit these signals, in this order:

- `drag_begin`: Provides DragContext.

- `drag_motion`: Provides DragContext and coordinates. You can call the drag_status() method of the DragContext to indicate which target will be accepted.

- `drag_get`: Provides `info` about the dragged data format, and a `GtkSelectionData` structure, in which you should put the requested data.

- `drag_drop`: Provides DragContext and coordinates.

- `drag_end`: Provides DragContext.

The destination widget will emit this signal, after the source destination has emitted the `drag_get` signal:

- `drag_data_received`: Provides `info` about the dragged data format, and a `GtkSelectionData` structure which contains the dropped data. You should call the `drag_finish()` method of the `DragContext` to indicate whether the operation was successful.

#### Move

During a `move`, the source widget will also emit this signal:

- `drag_delete`: Gives the source the opportunity to delete the original data if that's appropriate.

#### Link

TODO: Find an example or documentation.

### DragContext

The drag and drop signals provide a DragContext, which contains some information about the drag and drop operation and can be used to influence the process. For instance, you can discover the source widget, or change the drag and drop icon, by using the `set_icon()` methods. More importantly, you should call the `drag_finish()` method from your `drag_data_received` signal handler to indicate whether the drop was successful.

### Example

Here is a very simple example, demonstrating a drag and drop `Copy` operation:

#### Drag and Drop

Source Code

File: dndwindow.h

    #ifndef GTKMM_EXAMPLE_DNDWINDOW_H
    #define GTKMM_EXAMPLE_DNDWINDOW_H

    #include <gtkmm/label.h>
    #include <gtkmm/window.h>
    #include <gtkmm/box.h>
    #include <gtkmm/button.h>

    class DnDWindow : public Gtk::Window
    {

    public:
      DnDWindow();
      virtual ~DnDWindow();

    protected:
      //Signal handlers:
      virtual void on_button_drag_data_get(const Glib::RefPtr<Gdk::DragContext>& context, Gtk::SelectionData& selection_data, guint info, guint time);
      virtual void on_label_drop_drag_data_received(const Glib::RefPtr<Gdk::DragContext>& context, int x, int y, const Gtk::SelectionData& selection_data, guint info, guint time);

      //Member widgets:
      Gtk::HBox m_HBox;
      Gtk::Button m_Button_Drag;
      Gtk::Label m_Label_Drop;
    };

    #endif // GTKMM_EXAMPLE_DNDWINDOW_H

File: dndwindow.cc

    #include "dndwindow.h"
    #include <iostream>

    DnDWindow::DnDWindow()
    : m_Button_Drag("Drag Here\n"),
      m_Label_Drop("Drop here\n")
    {
      set_title("DnD example");

      add(m_HBox);

      //Targets:
      std::list<Gtk::TargetEntry> listTargets;
      listTargets.push_back( Gtk::TargetEntry("STRING") );
      listTargets.push_back( Gtk::TargetEntry("text/plain") );

      //Drag site:

      //Make m_Button_Drag a DnD drag source:
      m_Button_Drag.drag_source_set(listTargets);

      //Connect signals:
      m_Button_Drag.signal_drag_data_get().connect( sigc::mem_fun(*this, &DnDWindow::on_button_drag_data_get));

      m_HBox.pack_start(m_Button_Drag);

      //Drop site:

      //Make m_Label_Drop a DnD drop destination:
      m_Label_Drop.drag_dest_set(listTargets);

      //Connect signals:
      m_Label_Drop.signal_drag_data_received().connect( sigc::mem_fun(*this, &DnDWindow::on_label_drop_drag_data_received) );

      m_HBox.pack_start(m_Label_Drop);

      show_all();
    }

    DnDWindow::~DnDWindow()
    {
    }

    void DnDWindow::on_button_drag_data_get(const Glib::RefPtr<Gdk::DragContext>&, Gtk::SelectionData& selection_data, guint, guint)
    {
      selection_data.set(selection_data.get_target(), 8 /* 8 bits format */, (const guchar*)"I'm Data!", 9 /* the length of I'm Data! in bytes */);
    }

    void DnDWindow::on_label_drop_drag_data_received(const Glib::RefPtr<Gdk::DragContext>& context, int, int, const Gtk::SelectionData& selection_data, guint, guint time)
    {
      if ((selection_data.get_length() >= 0) && (selection_data.get_format() == 8))
      {
        std::cout << "Received \"" << selection_data.get_data_as_string() << "\" in label " << std::endl;
      }

      context->drag_finish(false, false, time);
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "dndwindow.h"

    int main (int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      DnDWindow dndWindow;
      Gtk::Main::run(dndWindow); //Shows the window and returns when it is closed.

      return 0;
    }

There is a more complex example in examples/dnd.

## The Clipboard

Simple text copy-paste functionality is provided for free by widgets such as Gtk::Entry and Gtk::TextView, but you might need special code to deal with your own data formats. For instance, a drawing program would need special code to allow copy and paste within a view, or between documents.

`Gtk::Clipboard` is a singleton. You can get the one and only instance with `Gtk::Clipboard::get()`.

So your application doesn't need to wait for clipboard operations, particularly between the time when the user chooses Copy and then later chooses Paste, most `Gtk::Clipboard` methods take `sigc::slot`s which specify callback methods. When `Gtk::Clipboard` is ready, it will call these methods, either providing the requested data, or asking for data.

Reference

### Targets

Different applications contain different types of data, and they might make that data available in a variety of formats. gtkmm calls these data types `target`s.

For instance, gedit can supply and receive the `"UTF8_STRING"` target, so you can paste data into gedit from any application that supplies that target. Or two different image editing applications might supply and receive a variety of image formats as targets. As long as one application can receive one of the targets that the other supplies then you will be able to copy data from one to the other.

A target can be in a variety of binary formats. This chapter, and the examples, assume that the data is 8-bit text. This would allow us to use an XML format for the clipboard data. However this would probably not be appropriate for binary data such as images. `Gtk::Clipboard` provides overloads that allow you to specify the format in more detail if necessary.

The Drag and Drop API uses the same mechanism. You should probably use the same data targets and formats for both Clipboard and Drag and Drap operations.

### Copy

When the user asks to copy some data, you should tell the clipboard what targets are available, and provide the callback methods that it can use to get the data. At this point you should store a copy of the data, to be provided when the clipboard calls your callback method in repsonse to a paste.

For instance,

    Glib::RefPtr<Gtk::Clipboard> refClipboard = Gtk::Clipboard::get();

    //Targets:
    std::list<Gtk::TargetEntry> listTargets;
    listTargets.push_back( Gtk::TargetEntry("example_custom_target") );
    listTargets.push_back( Gtk::TargetEntry("UTF8_STRING") );

    refClipboard->set( listTargets,
      sigc::mem_fun(*this, &ExampleWindow::on_clipboard_get),
      sigc::mem_fun(*this, &ExampleWindow::on_clipboard_clear) );

Your callback will then provide the store data when the user chooses to paste the data. For instance:

    void ExampleWindow::on_clipboard_get(Gtk::SelectionData& selection_data, guint info)
    {
      const Glib::ustring& target = selection_data.get_target();

      if(target == "example_custom_target")
        selection_data.set("example_custom_target", m_ClipboardStore);
    }

The `ideal` example below can supply more than one clipboard target.

The clear callback allows you to free the memory used by your stored data when the clipboard replaces its data with something else.

### Paste

When the user asks to paste data from the clipboard, you should request a specific format and provide a callback method which will be called with the actual data. For instance:

    refClipboard->request_contents("example_custom_target",  sigc::mem_fun(*this, &ExampleWindow::on_clipboard_received) );

Here is an example callback method:

    void ExampleWindow::on_clipboard_received(const Gtk::SelectionData& selection_data)
    {
      Glib::ustring clipboard_data = selection_data.get_data_as_text();
      //Do something with the pasted data.
    }

#### Discovering the available targets

To find out what targets are currently available on the clipboard for pasting, call the `request_methods()` method, specifying a method to be called with the information. For instance:

    refClipboard->request_targets( sigc::mem_fun(*this, &ExampleWindow::on_clipboard_received_targets) );

In your callback, compare the list of available targets with those that your application supports for pasting. You could enable or disable a Paste menu item, depending on whether pasting is currently possible. For instance:

    void ExampleWindow::on_clipboard_received_targets(const Gtk::SelectionData& selection_data)
    {
      bool bPasteIsPossible = false;

      //Get the list of available clipboard targets:
      typedef std::list<Glib::ustring> type_listTargets;
      type_listTargets targets = selection_data.get_targets();

      //and see if one is suitable:
      for(type_listTargets::const_iterator iter = targets.begin(); iter != targets.end(); ++iter)
      {
        if(*iter == "example_custom_target")
          bPasteIsPossible = true;
      }

      //Do something, depending on whether bPasteIsPossible is true.
    }

o

### Examples

#### Simple

This example allows copy and pasting of application-specific data, using the standard text target. Although this is simple, it's not ideal because it does not identify the clipboard data as being of a particular type.

##### Clipboard - Simple

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_copy();
      virtual void on_button_paste();
      virtual void on_clipboard_text_received(const Glib::ustring& text);

      //Child widgets:
      Gtk::VBox m_VBox;

      Gtk::Label m_Label;

      Gtk::Table m_Table;
      Gtk::ToggleButton m_ButtonA1, m_ButtonA2, m_ButtonB1, m_ButtonB2;

      Gtk::HButtonBox m_ButtonBox;
      Gtk::Button m_Button_Copy, m_Button_Paste;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include "examplewindow.h"

    ExampleWindow::ExampleWindow()
    : m_Label("Select cells in the table, click Copy, then open a second instance of this example to try pasting the copied data."),
      m_Table(2, 2, true),
      m_ButtonA1("A1"), m_ButtonA2("A2"), m_ButtonB1("B1"), m_ButtonB2("B2"),
      m_Button_Copy(Gtk::Stock::COPY), m_Button_Paste(Gtk::Stock::PASTE)
    {
      set_title("Gtk::Clipboard example");
      set_border_width(12);

      add(m_VBox);

      m_VBox.pack_start(m_Label, Gtk::PACK_SHRINK);

      //Fill Table:
      m_VBox.pack_start(m_Table);
      m_Table.attach(m_ButtonA1, 0, 1, 0, 1);
      m_Table.attach(m_ButtonA2, 1, 2, 0, 1);
      m_Table.attach(m_ButtonB1, 0, 1, 1, 2);
      m_Table.attach(m_ButtonB2, 1, 2, 1, 2);

      //Add ButtonBox to bottom:
      m_VBox.pack_start(m_ButtonBox, Gtk::PACK_SHRINK);
      m_VBox.set_spacing(6);

      //Fill ButtonBox:
      m_ButtonBox.set_layout(Gtk::BUTTONBOX_END);
      m_ButtonBox.pack_start(m_Button_Copy, Gtk::PACK_SHRINK);
      m_Button_Copy.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_copy) );
      m_ButtonBox.pack_start(m_Button_Paste, Gtk::PACK_SHRINK);
      m_Button_Paste.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_paste) );

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_copy()
    {
      //Build a string representation of the stuff to be copied:
      //Ideally you would use XML, with an XML parser here:
      Glib::ustring strData;
      strData += m_ButtonA1.get_active() ? "1" : "0";
      strData += m_ButtonA2.get_active() ? "1" : "0";
      strData += m_ButtonB1.get_active() ? "1" : "0";
      strData += m_ButtonB2.get_active() ? "1" : "0";

      Glib::RefPtr<Gtk::Clipboard> refClipboard = Gtk::Clipboard::get();
      refClipboard->set_text(strData);
    }

    void ExampleWindow::on_button_paste()
    {
      //Tell the clipboard to call our method when it is ready:
      Glib::RefPtr<Gtk::Clipboard> refClipboard = Gtk::Clipboard::get();
      refClipboard->request_text( sigc::mem_fun(*this, &ExampleWindow::on_clipboard_text_received) );
    }

    void ExampleWindow::on_clipboard_text_received(const Glib::ustring& text)
    {
      //See comment in on_button_copy() about this silly clipboard format.
      if(text.size() >= 4)
      {
        m_ButtonA1.set_active( text[0] == '1' );
        m_ButtonA2.set_active( text[1] == '1' );
        m_ButtonB1.set_active( text[2] == '1' );
        m_ButtonB2.set_active( text[3] == '1' );
      }
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

#### Ideal

This is like the simple example, but it

1. Defines a custom clipboard target, though the format of that target is still text.

2. It supports pasting of 2 targets - both the custom one and a text one that creates an arbitrary text representation of the custom data.

3. It uses request_targets() and disables the Paste button if it can't use anything on the clipboard

##### Clipboard - Ideal

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_copy();
      virtual void on_button_paste();

      virtual void on_clipboard_get(Gtk::SelectionData& selection_data, guint info);
      virtual void on_clipboard_clear();

      virtual void on_clipboard_received(const Gtk::SelectionData& selection_data);
      virtual void on_clipboard_received_targets(const Glib::StringArrayHandle& targets_array);

      virtual void update_paste_status(); //Disable the paste button if there is nothing to paste.

      //Child widgets:
      Gtk::VBox m_VBox;

      Gtk::Label m_Label;

      Gtk::Table m_Table;
      Gtk::ToggleButton m_ButtonA1, m_ButtonA2, m_ButtonB1, m_ButtonB2;

      Gtk::HButtonBox m_ButtonBox;
      Gtk::Button m_Button_Copy, m_Button_Paste;

      Glib::ustring m_ClipboardStore; //Keep copied stuff here, until it is pasted. This could be a big complex data structure.
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: examplewindow.cc

    #include "examplewindow.h"
    #include <algorithm>

    namespace
    {

    const char example_target_custom[] = "gtkmmclipboardexample";
    const char example_target_text[]   = "UTF8_STRING";

    } // anonymous namespace

    ExampleWindow::ExampleWindow()
    : m_Label("Select cells in the table, click Copy, then open a second instance "
              "of this example to try pasting the copied data.\nOr try pasting the "
              "text representation into gedit."),
      m_Table(2, 2, true),
      m_ButtonA1("A1"), m_ButtonA2("A2"), m_ButtonB1("B1"), m_ButtonB2("B2"),
      m_Button_Copy(Gtk::Stock::COPY), m_Button_Paste(Gtk::Stock::PASTE)
    {
      set_title("Gtk::Clipboard example");
      set_border_width(12);

      add(m_VBox);

      m_VBox.pack_start(m_Label, Gtk::PACK_SHRINK);

      //Fill Table:
      m_VBox.pack_start(m_Table);
      m_Table.attach(m_ButtonA1, 0, 1, 0, 1);
      m_Table.attach(m_ButtonA2, 1, 2, 0, 1);
      m_Table.attach(m_ButtonB1, 0, 1, 1, 2);
      m_Table.attach(m_ButtonB2, 1, 2, 1, 2);

      //Add ButtonBox to bottom:
      m_VBox.pack_start(m_ButtonBox, Gtk::PACK_SHRINK);
      m_VBox.set_spacing(6);

      //Fill ButtonBox:
      m_ButtonBox.set_layout(Gtk::BUTTONBOX_END);
      m_ButtonBox.pack_start(m_Button_Copy, Gtk::PACK_SHRINK);
      m_Button_Copy.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_copy) );
      m_ButtonBox.pack_start(m_Button_Paste, Gtk::PACK_SHRINK);
      m_Button_Paste.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_paste) );

      show_all_children();

      update_paste_status();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_copy()
    {
      //Build a string representation of the stuff to be copied:
      //Ideally you would use XML, with an XML parser here:
      Glib::ustring strData;
      strData += m_ButtonA1.get_active() ? "1" : "0";
      strData += m_ButtonA2.get_active() ? "1" : "0";
      strData += m_ButtonB1.get_active() ? "1" : "0";
      strData += m_ButtonB2.get_active() ? "1" : "0";

      //Store the copied data until it is pasted:
      m_ClipboardStore = strData;

      Glib::RefPtr<Gtk::Clipboard> refClipboard = Gtk::Clipboard::get();

      //Targets:
      std::list<Gtk::TargetEntry> listTargets;

      listTargets.push_back( Gtk::TargetEntry(example_target_custom) );
      listTargets.push_back( Gtk::TargetEntry(example_target_text) );

      refClipboard->set( listTargets, sigc::mem_fun(*this, &ExampleWindow::on_clipboard_get), sigc::mem_fun(*this, &ExampleWindow::on_clipboard_clear) );

      update_paste_status();
    }

    void ExampleWindow::on_button_paste()
    {
      //Tell the clipboard to call our method when it is ready:
      Glib::RefPtr<Gtk::Clipboard> refClipboard = Gtk::Clipboard::get();

      refClipboard->request_contents(example_target_custom,  sigc::mem_fun(*this, &ExampleWindow::on_clipboard_received) );

      update_paste_status();
    }

    void ExampleWindow::on_clipboard_get(Gtk::SelectionData& selection_data, guint)
    {
      //info is meant to indicate the target, but it seems to be always 0,
      //so we use the selection_data's target instead.

      const std::string target = selection_data.get_target();

      if(target == example_target_custom)
      {
        // This set() override uses an 8-bit text format for the data.
        selection_data.set(example_target_custom, m_ClipboardStore);
      }
      else if(target == example_target_text)
      {
        //Build some arbitrary text representation of the data,
        //so that people see something when they paste into a text editor:
        Glib::ustring text_representation;

        text_representation += m_ButtonA1.get_active() ? "A1, " : "";
        text_representation += m_ButtonA2.get_active() ? "A2, " : "";
        text_representation += m_ButtonB1.get_active() ? "B1, " : "";
        text_representation += m_ButtonB2.get_active() ? "B2, " : "";

        selection_data.set_text(text_representation);
      }
      else
      {
        g_warning("ExampleWindow::on_clipboard_get(): Unexpected clipboard target format.");
      }
    }

    void ExampleWindow::on_clipboard_clear()
    {
      //This isn't really necessary. I guess it might save memory.

      m_ClipboardStore.clear();
    }

    void ExampleWindow::on_clipboard_received(const Gtk::SelectionData& selection_data)
    {
      const std::string target = selection_data.get_target();

      if(target == example_target_custom) //It should always be this, because that' what we asked for when calling request_contents().
      {
        Glib::ustring clipboard_data = selection_data.get_data_as_string();

        //See comment in on_button_copy() about this silly clipboard format.
        if(clipboard_data.size() >= 4)
        {
          m_ButtonA1.set_active( clipboard_data[0] == '1' );
          m_ButtonA2.set_active( clipboard_data[1] == '1' );
          m_ButtonB1.set_active( clipboard_data[2] == '1' );
          m_ButtonB2.set_active( clipboard_data[3] == '1' );
        }
      }
    }

    void ExampleWindow::update_paste_status()
    {
      //Disable the paste button if there is nothing to paste.

      Glib::RefPtr<Gtk::Clipboard> refClipboard = Gtk::Clipboard::get();

      //Discover what targets are available:
      refClipboard->request_targets( sigc::mem_fun(*this, &ExampleWindow::on_clipboard_received_targets) );
    }

    void ExampleWindow::on_clipboard_received_targets(const Glib::StringArrayHandle& targets_array)
    {
      // Get the list of available clipboard targets:
      std::list<std::string> targets (targets_array);

      const bool bPasteIsPossible =
          std::find(targets.begin(), targets.end(), example_target_custom) != targets.end();

      // Enable/Disable the Paste button appropriately:
      m_Button_Paste.set_sensitive(bPasteIsPossible);
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

## Timeouts, I/O and Idle Functions

### Timeouts

You may be wondering how to make gtkmm do useful work while it's idling along (well, sleeping actually) in `Gtk::Main::run()`. Happily, you have several options. Using the following methods you can create a timeout method that will be called every few milliseconds.

    sigc::connection Glib::SignalTimeout::connect(const sigc::slot<bool>& slot, unsigned int interval, int priority = Glib::PRIORITY_DEFAULT);

The first argument is a slot you wish to have called when the timeout occurs. The second argument is the number of milliseconds between calls to that method. You receive a `sigc::connection` object that can be used to deactivate the connection.

    my_onnection.disconnect();

to destroy the connection. Another way of destroying the connection is your signal handler. It has to be of the type `sigc::slot<bool>`. As you see from the definition your signal handler has to return a value of the type `bool`. A definition of a sample method might look like this:

    bool MyCallback() { std::cout << "Hello World!\n"; return true; }

You can stop the timeout method by returning `false` from your signal handler. Therefore, if you want your method to be called repeatedly, it should return `true`.

Here's an example of this technique:

Source Code

File: timerexample.h

    #ifndef GTKMM_EXAMPLE_TIMEREXAMPLE_H
    #define GTKMM_EXAMPLE_TIMEREXAMPLE_H

    #include <gtkmm.h>
    #include <iostream>
    #include <map>

    class TimerExample : public Gtk::Window
    {
    public:
      TimerExample();

    protected:
      // signal handlers
      void on_button_add_timer();
      void on_button_delete_timer();
      void on_button_quit();

      // This is the callback function the timeout will call
      bool on_timeout(int timer_number);

      // Member data:

      Gtk::HBox m_Box;
      Gtk::Button m_ButtonAddTimer, m_ButtonDeleteTimer, m_ButtonQuit;

      // Keep track of the timers being added:
      int m_timer_number;

      // These two constants are initialized in the constructor's member initializer:
      const int count_value;
      const int timeout_value;

      // STL map for storing our connections
      std::map<int, sigc::connection> m_timers;

      // STL map for storing our timer values.
      // Each timer counts back from COUNT_VALUE to 0 and is removed when it reaches 0
      std::map<int, int> m_counters;
    };

    #endif // GTKMM_EXAMPLE_TIMEREXAMPLE_H

File: main.cc

    #include "timerexample.h"
    #include <gtkmm/main.h>

    int main (int argc, char *argv[])
    {
      Gtk::Main app(argc, argv);

      TimerExample example;
      Gtk::Main::run(example);

      return 0;
    }

File: timerexample.cc

    #include "timerexample.h"

    TimerExample::TimerExample() :
      m_Box(true, 10),
      m_ButtonAddTimer(Gtk::Stock::ADD), // use Gtk::Stock wherever possible for buttons, etc.
      m_ButtonDeleteTimer(Gtk::Stock::REMOVE),
      m_ButtonQuit(Gtk::Stock::QUIT),
      m_timer_number(0), // start numbering the timers at 0
      count_value(5), // each timer will count down 5 times before disconnecting
      timeout_value(1500) // 1500 ms = 1.5 seconds
    {
      set_border_width(10);

      add(m_Box);
      m_Box.pack_start(m_ButtonAddTimer);
      m_Box.pack_start(m_ButtonDeleteTimer);
      m_Box.pack_start(m_ButtonQuit);

      // Connect the three buttons:
      m_ButtonQuit.signal_clicked().connect(sigc::mem_fun(*this, &TimerExample::on_button_quit));
      m_ButtonAddTimer.signal_clicked().connect(sigc::mem_fun(*this, &TimerExample::on_button_add_timer));
      m_ButtonDeleteTimer.signal_clicked().connect(sigc::mem_fun(*this, &TimerExample::on_button_delete_timer));

      show_all_children();
    }

    void TimerExample::on_button_quit()
    {
      hide();
    }

    void TimerExample::on_button_add_timer()
    {
      // Creation of a new object prevents long lines and shows us a little
      // how slots work.  We have 0 parameters and bool as a return value
      // after calling sigc::bind.
      sigc::slot<bool> my_slot = sigc::bind(sigc::mem_fun(*this, &TimerExample::on_timeout), m_timer_number);

      // This is where we connect the slot to the Glib::signal_timeout()
      sigc::connection conn = Glib::signal_timeout().connect(my_slot, timeout_value);

      // Remember the connection:
      m_timers[m_timer_number] = conn;

      // Initialize timer count:
      m_counters[m_timer_number] = count_value + 1;

      // Print some info to the console for the user:
      std::cout << "added timeout " << m_timer_number++ << std::endl;
    }

    void TimerExample::on_button_delete_timer()
    {
      // any timers?
      if(m_timers.empty())
      {
        // no timers left
        std::cout << "Sorry, there are no timers left." << std::endl;
      }
      else
      {
        // get the number of the first timer
        int timer_number = m_timers.begin()->first;

        // Give some info to the user:
        std::cout << "manually disconnecting timer " << timer_number << std::endl;

        // Remove the entry in the counter values
        m_counters.erase(timer_number);

        // Diconnect the signal handler:
        m_timers[timer_number].disconnect();

        // Forget the connection:
        m_timers.erase(timer_number);
      }
    }

    bool TimerExample::on_timeout(int timer_number)
    {
      // Print the timer:
      std::cout << "This is timer " << timer_number;

      // decrement and check counter value
      if (--m_counters[timer_number] == 0)
      {
        std::cout << " being disconnected" <<  std::endl;

        // delete the counter entry in the STL MAP
        m_counters.erase(timer_number);

        // delete the connection entry in the STL MAP
        m_timers.erase(timer_number);

        // Note that we do not have to explicitly call disconnect() on the connection
        // since Gtk::Main does this for us when we return false.
        return false;
      }

      // Print the timer value
      std::cout << " - " << m_counters[timer_number] << "/" << count_value << std::endl;

     // Keep going (do not disconnect yet):
      return true;
    }

### Monitoring I/O

A nifty feature of GDK (one of the libraries underlying gtkmm) is the ability to have it check for data on a file descriptor for you. This is especially useful for networking applications. The following method is used to do this:

    sigc::connection Gtk::Main::input.connect(const SlotType& sd, int source,
                                        GdkInputCondition condition);

The first argument is a slot (SlotType is a typedef to a sigc::slot<>) you wish to have called when then the specified event (see argument 3) occurs on the file descriptor you specify using argument two. Argument three may be one or more (using `&verbar;`) of:

- GDK&lowbar;INPUT&lowbar;READ - Call your method when there is data ready for reading on your file descriptor.

- GDK&lowbar;INPUT&lowbar;WRITE - Call your method when the file descriptor is ready for writing.

- GDK&lowbar;INPUT&lowbar;EXCEPTION - Call your method when an exception happened on the file descriptor.

The return value is a sigc::connection that may be used to stop monitoring this file descriptor using its `disconnect` method. The `sd` signal handler should be declared as follows:

    void input_callback(int source, GdkInputCondition condition);

where `source` and `condition` are as specified above. As usual the slot is created with `sigc::mem_fun()` (for a member method of an object.), or `sigc::ptr_fun` (for a function).

A little (and somewhat dirty) example follows. To use the example just execute it from a terminal; it doesn't create a window. It will create a pipe named `testpipe` in the current directory. Then start another shell and execute `cat >testpipe`. The example will print each line you enter until you type `quit`.

Source location: examples/input/input.cc

    #include <gtkmm/main.h>
    #include <fcntl.h>
    #include <unistd.h>
    #include <sys/types.h>
    #include <sys/stat.h>
    #include <fstream>
    #include <iostream>
    #include <memory>

    using std::istream;

    using std::auto_ptr;

    auto_ptr<istream> input;

    // this will be our signal handler for read operations
    // there is not much to say. just read a string,
    // print it and quit the application if the string was quit
    void MyCallback(int, GdkInputCondition) {
      Gtk::string dummy;
      do {
        (*input) >> dummy;
        cout << dummy << endl;
        if(dummy == "quit") Gtk::Main::quit();
      } while(input->fail());
    }

    int main (int argc, char *argv[])
    {
      // the usual Gtk::Main object
      Gtk::Main app(argc, argv);

      // create a fifo for testing purposes
      if (mkfifo("testfifo",0666) != 0) {
        cerr << "error creating fifo" << endl;
        return -1;
      }

      // open the fifo
      input=new ifstream("testfifo");

    //    int fd = open("testfifo", 0);
    //    if (fd == -1) {
    //      cerr << "error opening fifo" << endl;
    //      return -1;
    //    }

      // assign the fifo's filedescriptor to our ifstream object
      //This sucks; it will only ever work with libstdc++-v3, as
      //  both istream::__filebuf_type and the basic_filebuf contructor
      //  that takes an fd are libstdc++-v3 specific.
      //input=new istream(new ifstream::__filebuf_type(fd,"testfifo"));

      // connect the signal handler
      app.input.connect(sigc::ptr_fun(MyCallback), fd, GDK_INPUT_READ);

      // and last but not least - run the application main loop
      app.run();

      // now remove the temporary fifo
      if(unlink("testfifo"))
        cerr << "error removing fifo" << endl;

      return 0;
    }

### Idle Functions

If you want to specify a method that gets called when nothing else is happening, use the following:

    sigc::connection  Gtk::Main::idle.connect(Slot<int> idlefunc, int priority);

This causes gtkmm to call the specified method whenever nothing else is happening. You can add a priority (lower numbers are higher priorities). If you don't supply a priority value, then Gtk::PRIORITY&lowbar;DEFAULT will be used. There are two ways to remove the signal handler: calling `disconnect` on the sigc::connection object, or returning `false` (or 0) in the signal handler, which should be declared as follows:

    int idleFunc();

Since this is very similar to the methods above this explanation should be sufficient to understand what's going on. However, here's a little example:

Source Code

File: idleexample.h

    #ifndef GTKMM_EXAMPLE_IDLEEXAMPLE_H
    #define GTKMM_EXAMPLE_IDLEEXAMPLE_H

    #include <gtkmm.h>
    #include <iostream>

    class IdleExample : public Gtk::Window
    {
    public:
      IdleExample();

    protected:
      // Signal Handlers:
      bool on_timer();
      bool on_idle();
      void on_button_clicked();

      // Member data:
      Gtk::VBox m_Box;
      Gtk::Button m_ButtonQuit;
      Gtk::ProgressBar m_ProgressBar_c;
      Gtk::ProgressBar m_ProgressBar_d;
    };

    #endif // GTKMM_EXAMPLE_IDLEEXAMPLE_H

File: idleexample.cc

    #include "idleexample.h"

    IdleExample::IdleExample() :
      m_Box(false, 5),
      m_ButtonQuit(Gtk::Stock::QUIT)
    {
      set_border_width(5);

      // Put buttons into container

      // Adding a few widgets:
      add(m_Box);
      m_Box.pack_start( *Gtk::manage(new Gtk::Label("Formatting Windows drive C:")) );
      m_Box.pack_start( *Gtk::manage(new Gtk::Label("100 MB")) );
      m_Box.pack_start(m_ProgressBar_c);

      m_Box.pack_start( *Gtk::manage(new Gtk::Label("")) );

      m_Box.pack_start( *Gtk::manage(new Gtk::Label("Formatting Windows drive D:")) );
      m_Box.pack_start( *Gtk::manage(new Gtk::Label("5000 MB")) );
      m_Box.pack_start(m_ProgressBar_d);

      Gtk::HBox* hbox = Gtk::manage( new Gtk::HBox(false,10));
      m_Box.pack_start(*hbox);
      hbox->pack_start(m_ButtonQuit, Gtk::PACK_EXPAND_PADDING);

      // Connect the signal handlers:
      m_ButtonQuit.signal_clicked().connect( sigc::mem_fun(*this, &IdleExample::on_button_clicked) );

      // formatting drive c in timeout signal handler - called once every 50ms
      Glib::signal_timeout().connect( sigc::mem_fun(*this, &IdleExample::on_timer), 50 );

      // formatting drive d in idle signal handler - called as quickly as possible
      Glib::signal_idle().connect( sigc::mem_fun(*this, &IdleExample::on_idle) );

      show_all_children();
    }

    void IdleExample::on_button_clicked()
    {
      hide();
    }

    // this timer callback function is executed once every 50ms (set in connection above).
    // Use timeouts when speed is not critical. (ie periodically updating something).
    bool IdleExample::on_timer()
    {
      double value = m_ProgressBar_c.get_fraction();

      // Update progressbar 1/500th each time:
      m_ProgressBar_c.set_fraction(value + 0.002);

      return value < 0.99;  // return false when done
    }

    // This idle callback function is executed as often as possible, hence it is ideal for
    // processing intensive tasks.
    bool IdleExample::on_idle()
    {
      double value = m_ProgressBar_d.get_fraction();

      // Update progressbar 1/5000th each time:
      m_ProgressBar_d.set_fraction(value + 0.0002);

      return value < 0.99;  // return false when done
    }

File: main.cc

    #include "idleexample.h"
    #include <gtkmm/main.h>

    int main (int argc, char *argv[])
    {
      Gtk::Main app(argc, argv);

      IdleExample example;
      Gtk::Main::run(example);

      return 0;
    }

This example points out the difference of idle and timeout methods a little. If you need methods that are called periodically, and speed is not very important, then you want timeout methods. If you want methods that are called as often as possible (like calculating a fractal in background), then use idle methods.

Try executing the example and increasing the system load. The upper progress bar will increase steadily; the lower one will slow down.

## Memory management

### Widgets

#### Normal C++ memory management

gtkmm allows the programmer to control the lifetime (that is, the construction and destruction) of any widget in the same manner as any other C++ object. This flexibility allows you to use `new` and `delete` to create and destroy objects dynamically or to use regular class members (that are destroyed automatically when the class is destroyed) or to use local instances (that are destroyed when the instance goes out of scope). This flexibility is not present in some C++ GUI toolkits, which restrict the programmer to only a subset of C++'s memory management features.

Here are some examples of normal C++ memory management:

##### Class Scope widgets

If a programmer does not need dynamic memory allocation, automatic widgets in class scope may be used. One advantage of automatic widgets in class scope is that memory management is grouped in one place. The programmer does not risk memory leaks from failing to `delete` a widget.

The primary disadvantages of using class scope widgets are revealing the class implementation rather than the class interface in the class header. Class scope widgets also require Automatic widgets in class scope suffer the same disadvantages as any other class scope automatic variable.

    #include <gtkmm/button.h>
    class Foo
    {
    private:
      Gtk::Button theButton;
      // will be destroyed when the Foo object is destroyed
    };

##### Function scope widgets

If a programmer does not need a class scope widget, a function scope widget may also be used. The advantages to function scope over class scope are the increased data hiding and reduced dependencies.

    {
      Gtk::Button aButton;
      aButton.show();
      ...
      kit.run();
    }

##### Dynamic allocation with new and delete

Although, in most cases, the programmer will prefer to allow containers to automatically destroy their children using manage() (see below), the programmer is not required to use manage(). The traditional `new` and `delete` operators may also be used.

    Gtk::Button* pButton = new Gtk::Button("Test");

    // do something useful with pButton

    delete pButton;

Here, the programmer deletes pButton to prevent a memory leak.

#### Managed Widgets

Alternatively, you can let a widget's container control when the widget is destroyed. In most cases, you want a widget to last only as long as the container it is in. To delegate the management of a widget's lifetime to its container, first create it with `manage()` and pack it into its container with `add()`. Now, the widget will be destroyed whenever its container is destroyed.

##### Dynamic allocation with manage() and add()

gtkmm provides the manage() and add() methods to create and destroy widgets. Every widget except a top-level window must be added or packed into a container in order to be displayed. The manage() function marks a packed widget so that when the widget is added to a container, the container becomes responsible for deleting the widget.

    MyWidget::MyWidget()
    {
      Gtk::Button* pButton = manage(new Gtk::Button("Test"));
      add(*pButton); //add aButton to MyWidget
    }

Now, when MyWidget is destroyed, the button will also be deleted. It is no longer necessary to delete pButton to free the button's memory; its deletion has been delegated to MyWidget.

gtkmm also provides the set&lowbar;manage() method for all widgets. This can be used to generate the same result as manage(), but is more tedious:

foo.add( (w=new Gtk::Label("Hello"), w->set&lowbar;manage(), &w) );

is the same as

foo.add( manage(new Gtk::Label("Hello")) );

Of course, a top level container will not be added to another container. The programmer is responsible for destroying the top level container using one of the traditional C++ techniques. For instance, your top-level Window might just be an instance in your main() function..

### Shared resources

Some objects, such as Pixmaps and Fonts, are obtained from a shared store. Therefore you cannot instantiate your own instances. These classes typically inherit from Glib::Object. Rather than requiring you to reference and unreference these objects, gtkmm uses the RefPtr<> smartpointer.

Objects such as Gdk::Bitmap can only be instantiated with a create() function. For instance,

    Glib::RefPtr<Gdk::Bitmap> bitmap = Gdk::Bitmap::create(window, data, width, height);

You have no way of getting a bare Gdk::Bitmap. In the example, bitmap is a smart pointer, so you can do this, much like a normal pointer:

    if(bitmap)
    {
      int depth = bitmap->get_depth().
    }

When bitmap goes out of scope an unref() will happen in the background and you don't need to worry about it anymore. There's no new so there's no delete.

If you copy a RefPtr, for instance

    Glib::RefPtr<Gdk::Bitmap> bitmap2 = bitmap.

, or if you pass it as a method argument or a return type, then RefPtr will do any necessary referencing to ensure that the instance will not be destroyed until the last RefPtr has gone out of scope.

See the appendix for detailed information about RefPtr.

If you wish to learn more about smartpointers, you might look in these books:

- Bjarne Stroustrup, "The C++ Programming Language" - section 14.4.2

- Nicolai M. Josuttis, "The C++ Standard Library" - section 4.2

## Glade and libglademm

Although you can use C++ code to instantiate and arrange widgets, this can soon become tedious and repetitive. And it requires a recompilation to show changes. The `Glade` application allows you to layout widgets on screen and then save an XML description of the arrangement. Your application can then use the `libglademm` API to load that XML file at runtime and obtain a pointer to specifically named widget instances.

This has the following advantages:

1. Less C++ code is required.

2. UI changes can be seen more quickly, so UIs are able to improve.

3. Designers without programming skills can create and edit UIs.

You still need C++ code to deal with User Interface changes triggered by user actions, but using `libglademm` for the basic widget layout allows you to focus on implementing that functionality.

### Loading the .glade file

`Gnome::Glade::Xml` must be used via a `Glib::RefPtr`. Like all such classes, you need to use create() method to instantiate it.

    Glib::RefPtr<Gnome::Glade::Xml> refXml = Gnome::Glade::Xml::create("basic.glade");

This will instantiate the windows defined in the .glade file, though they will not be shown immediately unless you have specified that via the Properties window in Glade. The widgets are ownedg by the `Gnome::Glade::Xml` instance, and will be deleted automatically when it is deleted, when the last copy of the smartpointer goes out of scope.

To instantiate just one window, or just one of the child widgets, you can specify the name of a widget as the second parameter. For instance,

    Glib::RefPtr<Gnome::Glade::Xml> refXml = Gnome::Glade::Xml::create("basic.glade", "treeview_products");

### Accessing widgets

To access a widget, for instance to `show()` a dialog, use the `get_widget()` method, providing the widget's name. This name should be specified in the Glade Properties window. If the widget could not be found, or is of the wrong type, then the pointer will be set to 0.

    Gtk::Dialog* pDialog = 0;
    refXml->get_widget("DialogBasic", pDialog);

libglademm checks for a null pointer, and checks that the widget is of the expected type, and will show warnings on the command line about these.

Remember that you are not instantiating a widget with `get_widget()`, you are just obtaining a pointer to one that already exists. You will always receive a pointer to the same instance when you call `get_widget` on the same `Gnome::Glade::Xml`, with the same widget name. The widgets are instantiated during `Glade::Xml::create()`.

`get_widget()` returns child widgets that are manage()ed (see the Memory Management chapter), so they will be deleted when their parent container is deleted. So, if you get only a child widget from libglademm, instead of a whole window, then you must either put it in a Container or delete it. Windows (such as Dialogs) can not be managed because they have no parent container, so you must delete them at some point.

#### Example

The `basic` example in the `libglademm` package shows how to load a Glade file at runtime and access the widgets with libglademm.

### Using derived widgets

You can use Glade to layout your own custom widgets derived from gtkmm widget classes. This keeps your code organised and encapsulated. Of course you won't see the exact appearance and properties of your derived widget in Glade, but you can specify its location and child widgets and the properties of its gtkmm base class.

Use `Glade::Xml::get_widget_derived()` like so:

    DerivedDialog* pDialog = 0;
    refXml->get_widet_derived("DialogBasic", pDialog);

Your derived class must have a constructor that takes a pointer to the underlying C type (there is a typedef for this), and the Gnome::Glade::Xml instance. You must call the base class's constructor in the initialization list, providing the C pointer. For instance,

    DerivedDialog::DerivedDialog(BaseObjectType* cobject, const Glib::RefPtr<Gnome::Glade::Xml>& refGlade)
    : Gtk::Dialog(cobject)
    {
    }

You could then encapsulate the manipulation of the child widgets in the constructor of the derived class, maybe using get_widget() or get_widget_derived() again. For instance,

    DerivedDialog::DerivedDialog(BaseObjectType* cobject, const Glib::RefPtr<Gnome::Glade::Xml>& refGlade)
    : Gtk::Dialog(cobject),
      m_refGlade(refGlade),
      m_pButton(0)
    {
      //Get the Glade-instantiated Button, and connect a signal handler:
      m_refGlade->get_widget("quit_button", m_pButton);
      if(m_pButton)
      {
        m_pButton->signal_clicked().connect( sigc::mem_fun(*this, &DerivedDialog::on_button_quit) );
      }
    }

#### Example

The `derived` example in the `libglademm` package shows how to load a Glade file at runtime and access a widgets via a derived class.

## Internationalization and Localization

`gtkmm` applications can easily support multiple languages, including non-ASCII languages such as Chinese and right-to-left languages such as Arabic. An appropriately-written gtkmm application will use the appropriate language at runtime based on the user's environment.

You might not anticipate the need to support additional languages, but you can never rule it out. And it's easier to develop the application properly in the first place rather than retrofitting later.

The process of writing source code that allows for translation is called `internationalization`, often abbreviated to `i18n`. The `Localization` process provides translated text for other languages, based on that source code.

### English in the source code, translations in the .po files.

String literals should be typed in the source code in english as normal, but they should be surrounded by a call to the gettext() function. These strings will be extracted for translation and the translations may be used at runtime instead of the original english strings.

#### gettext

The GNU gettext package allows you to mark strings in source code, extract those strings for translation, and use the translated strings in your application.

Call `gettext()` with the string literals that should be translated. For example:

    window.set_title(gettext("My application"));
    label.set_text(gettext("This is some text"));

Using `gettext()` throughout your source code can make it harder to read, so many projects, such as `GNOME` define the shorter `_()` macro that does the same thing. For instance,

    window.set_title(_("My application"));
    label.set_text(_("This is some text"));

##### How gettext works

`xgettext` script extracts the strings and put them in a `mypackage.pot` file. The translators of your application create their translations by first copying this .pot file to `languagename.po` files. A locale identifies a language and an encoding for that language, including date and numerical formats. Later, when the text in your source code has changed, the `msmerge` script is used to update the `localename.po` files from the regnerated .pot file.

At install time, the `.po` files are converted to a binary format (with the extension `.mo`) and placed in a system-wide directory for locale files.

When the application runs, the gettext library checks the system-wide directory to see if there is a `.mo` file for the user's locale environment (you can set the locale with, for instance, "export LANG=de_DE.UTF-8" from a bash console). Later, when the program reaches a `gettext` call, it looks for a translation. If none is found, the original string is used.

##### gettext and build files

To use gettext, you need to modify your application's build files, to use the gettext library, to generate the .pot file, and to install the translations from the .po files.

1. Run `getttextize --force --copy --intl` - you should add this to your autogen.sh script. This creates the `po` and `intl` subdirectories, among other things.

2. Create po/Makevars, by copying po/Makevars.template and editing it.

3. Add AM_GNU_GETTEXT to your configure.in

4. Define ALL_LINGUAS in your configure.in, listing the locales for which .po translations exist in your po directory.

5. Add intl and po to the SUBDIRS in your top-level Makefile.am

To add a translation for a new locale, just copy po/yourproject.pot to somelocale.po, such as de.po or hu.po. Also add the locale name to ALL_LINGUAS in your configure.in.

This is demonstrated in the `gtkmm_hello` example package, available from the `gtkmm` download page.

See also, the gettext manual.

##### GNOME's intltool

Applications often use text that isn't in their source code. For instance, desktop menu details, and GUI resource files such as Glade files. But gettext() works only with C/C++ source code. Therefore, the GNOME developers created `intltool`. It uses gettext() but combines strings from other files into the gettext .pot/.po files. The `intltool` equivalent of `gettextize` is `intltoolize`. The `intltool` README file tells you what modifications to make to your build files.

This is demonstrated in the `gnomemm_hello` example package, available from the `gtkmm` download page.

### Expecting UTF8

A properly internationalized application will not make assumptions about the number of bytes in a character. That means that you shouldn't use pointer arithmetic to step through the characters in a string, and it means you shouldn't use std::string or standard C functions such as strlen() because they make the same assumption.

However, you probably already avoid bare char* arrays and pointer arithmetic by using std::string, so you just need to start using Glib::ustring instead. See the Basics chapter about Glib::ustring.

#### Glib::ustring and std::iostreams

TODO: This section is not clear - it needs to spell things out more clearly and obviously.

Unfortunately, the integration with the standard iostreams is not completely foolproof. `gtkmm` converts Glib::ustrings to a locale-specific encoding (which usually is not UTF-8) if you output them to an `ostream` with `operator<<`. Likewise, retrieving Glib::ustrings from `istream` with `operator>>` causes a conversion in the opposite direction. But this scheme breaks down if you go through a std::string, e.g. by inputting text from a stream to a std::string and then implicitly converting it to a Glib::ustring. If the string contained non-ASCII characters and the current locale is not UTF-8 encoded, the result is a corrupted Glib::ustring. You can work around this with a manual conversion. For instance, to retrieve the std::string from a `ostringstream`:

    std::ostringstream output;
    output.imbue(std::locale("")); // use the user's locale for this stream
    output << percentage << " % done";
    label->set_text(Glib::locale_to_utf8(output.str()));

### Pitfalls

There are a few common mistakes that you would discover eventually yourself. But this section might help you to avoid them.

#### Same strings, different semantics

Sometimes two english strings are identical but have different meanings in different contexts, so they would probably not be identical when translated. Since the English strings are used as look-up keys, this causes problems.

In these cases, you should add extra characters to the strings. For instance, use `"jumps[noun]"` and `"jumps[verb]"` instead of just `"jumps"`) and strip them again outside the `gettext` call. If you add extra characters you should also add a comment for the translators before the `gettext` call. Such comments will be shown in the `.po` files. For instance,

    // note to translators: don't translate the "[noun]" part - it is
    // just here to distinguish the string from another "jumps" string
    text = strip(gettext("jumps[noun]"), "[noun]");

#### Composition of strings

C programmers use `sprintf()` to compose and concatenate strings. C++ favours streams, but unfortunately, this approach makes translation difficult, because each fragment of text is translated separately, without allowing the translators to rearrange them according to the grammar of the language.

For instance, this code would be problematic:

    std::cout << _("Current amount: ") << amount
    	  << _(" Future: ") << future << std::endl;

    label.set_text(_("Really delete ") + filename + _(" now?"));

So you should either avoid this situation or revert to the C-style `sprintf()`. One possible solution is the compose library which supports syntax such as:

    label.set_text(compose(_("Really delete %1 now?"), filename));

#### Assuming the displayed size of strings

You never know how much space a string will take on screen when translated. It might very possibly be twice the size of the original English string. Luckily, most `gtkmm` widgets will expand at runtime to the required size.

#### Unusual words

You should avoid cryptic abbreviations, slang, or jargon. They are usually difficult to translate, and are often difficult for even native speakers to understand. For instance, prefer "application" to "app"

#### Using non-ASCII characters in strings

Currently, gettext does not support non-ASCII characters (i.e. any characters with a code above 127) in source code. For instance, you cannot use the copyright sign (©).

To work around this, you could write a comment in the source code just before the string, telling the translators to use the special character if it is available in their languages. For english, you could then make an American English `en_US.po` translation which used that special charactger.

### Getting help with translations

If your program is free software, there is a whole `GNOME` subproject devoted to helping you make translations, the `GNOME` Translation Project.

The way it works is that you contact the gnome-i18n mailing list to find out how the translators can access your `po/` subdirectory, and to add your project to the big status tables.

Then you make sure you update the file `POTFILES.in` in the `po/` subdirectory (`intltool-update -M` can help with this) so that the translators always access updated `myprogram.pot` files, and simply freeze the strings at least a couple of days before you make a new release, announcing it on gnome-i18n. Depending on the number of strings your program contains and how popular it is, the translations will then start to tick in as `languagename.po` files.

Note that most language teams only consist of 1-3 persons, so if your program contains a lot of strings, it might last a while before anyone has the time to look at it. Also, most translators do not want to waste their time (translating is a very time-consuming task) so if they do not assess your project as being really serious (in the sense that it is polished and being maintained) they may decide to spend their time on some other project.

## Custom Widgets

`gtkmm` makes it very easy to derive new widgets by inheriting from an existing widget class, either by deriving from a container and adding child widgets, or by deriving from a single-item widget, and changing its behaviour. But you might occasionally find that no suitable starting point already exists. In this case, you can implement a widget from scratch.

### Custom Containers

When deriving from Gtk::Container, you should override the following virtual methods:

- `on_size_request()`: Calculate the minimum height and width needed by the container.

- `on_size_allocate()`: Position the child widgets, given the height and width that the container has actually been given.

- `forall_vfunc()`: Call the same callback for each of the children.

- `on_add()`:

- `on_remove()`:

- `child_type_vfunc()`: Return what type of child can be added.

The `on_size_request()` and `on_size_allocate()` virtual methods control the layout of the child widgets. For instance, if your container has 2 child widgets, with one below the other, your `on_size_request()` might report the maximum of their widths and the sum of their heights. If you want padding between the child widgets then you would add that to the width and height too. Your widget's container will use this result to ensure that your widget gets enough space, and not less. By examining each widget's parent, and its parent, this logic will eventually decide the size of the top-level window.

`on_size_allocate()`, however, receives the actual height and width that the parent container has decided to give to your widget. This might be more than the minimum, for instance if the top-level window has been expanded. You might choose to ignore the extra space and leave a blank area, or you might choose to expand your child widgets to fill the space, or you might choose to expand the padding between your widgets. Its your container, so you decide. Don't forget to call `set_allocation` inside your `on_size_allocate()` implementation to actually use the allocated space that has been offered by the parent container.

Unless your container is a top-level window that derives from Gtk::Window, you should also call `Gtk::Container::set_flags(Gtk::NO_WINDOW)` in your constructor. Otherwise, your container will appear in its own window, regardless of what container you put it in. And unless your container draws directly onto the underlying Gdk::Window, you should probably call `set_redraw_on_allocate(false)` to improve performance.

By overriding `forall_vfunc()` you can allow applications to operate on all of the container's child widgets. For instance, `show_all_children` uses this to find all the child widgets and show them.

Although your container might have its own method to set the child widgets, you should still provide an implementation for the virtual `on_add()` and `on_remove()` methods from the base class, so that the add() and remove() methods will do something appropriate if they are called.

Your implementation of the `child_type_vfunc()` method should report the type of widget that may be added to your container, if it is not yet full. This is usually Gtk::Widget::get_type() to indicate that the container may contain any class derived from Gtk::Widget. If the container may not contain any more widgets, then this method should return G_TYPE_NONE.

#### Example

This example implements a container with two child widgets, one above the other. Of course, in this case it would be far simpler just to use a Gtk::VBox.

##### Custom Container

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>
    #include "mycontainer.h"

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_quit();

      //Child widgets:
      Gtk::VBox m_VBox;
      MyContainer m_MyContainer;
      Gtk::Button m_Button_One, m_Button_Two;
      Gtk::HButtonBox m_ButtonBox;
      Gtk::Button m_Button_Quit;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: mycontainer.h

    #ifndef GTKMM_CUSTOM_CONTAINER_MYCONTAINER_H
    #define GTKMM_CUSTOM_CONTAINER_MYCONTAINER_H

    #include <gtkmm/container.h>

    class MyContainer : public Gtk::Container
    {
    public:
      MyContainer();
      virtual ~MyContainer();

      virtual void set_child_widgets(Gtk::Widget& child_one, Gtk::Widget& child_two);

    protected:

      //Overrides:
      virtual void on_size_request(Gtk::Requisition* requisition);
      virtual void on_size_allocate(Gtk::Allocation& allocation);

      virtual void forall_vfunc(gboolean include_internals, GtkCallback callback, gpointer callback_data);

      virtual void on_add(Gtk::Widget* child);
      virtual void on_remove(Gtk::Widget* child);
      virtual GtkType child_type_vfunc() const;

      Gtk::Widget* m_child_one;
      Gtk::Widget* m_child_two;
    };

    #endif //GTKMM_CUSTOM_CONTAINER_MYCONTAINER_H

File: examplewindow.cc

    #include <iostream>
    #include "examplewindow.h"

    ExampleWindow::ExampleWindow()
    : m_Button_One("Child One"),
      m_Button_Two("Child Two"),
      m_Button_Quit("Quit")
    {
      set_title("Custom Container example");
      set_border_width(6);
      set_default_size(400, 200);

      add(m_VBox);

      //Add the child widgets to the custom container:
      m_MyContainer.set_child_widgets(m_Button_One, m_Button_Two);
      m_Button_One.show();
      m_Button_Two.show();
      m_VBox.pack_start(m_MyContainer, Gtk::PACK_EXPAND_WIDGET);
      m_MyContainer.show();

      m_VBox.pack_start(m_ButtonBox, Gtk::PACK_SHRINK);

      m_ButtonBox.pack_start(m_Button_Quit, Gtk::PACK_SHRINK);
      m_ButtonBox.set_border_width(6);
      m_ButtonBox.set_layout(Gtk::BUTTONBOX_END);
      m_Button_Quit.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_quit) );

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_quit()
    {
      hide();
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

File: mycontainer.cc

    #include <iostream>
    #include "mycontainer.h"

    MyContainer::MyContainer()
    : m_child_one(0), m_child_two(0)
    {
      set_flags(Gtk::NO_WINDOW);
      set_redraw_on_allocate(false);
    }

    MyContainer::~MyContainer()
    {
    }

    void MyContainer::set_child_widgets(Gtk::Widget& child_one, Gtk::Widget& child_two)
    {
      m_child_one = &child_one;
      m_child_two = &child_two;

      //Note that we use gtk_widget_set_parent(),
      //because Gtk::Widget::set_parent() is protected.
      //This is a bug that should be fixed in a future version of gtkmm. TODO
      gtk_widget_set_parent(m_child_one->gobj(), GTK_WIDGET(gobj()));
      gtk_widget_set_parent(m_child_two->gobj(), GTK_WIDGET(gobj()));
    }

    void MyContainer::on_size_request(Gtk::Requisition* requisition)
    {
      //Initialize the output parameter:
      *requisition = Gtk::Requisition();

      //Discover the total amount of minimum space needed by this container widget, by examining its child widgets.
      //The layouts in this custom container will be arranged vertically, one above the other.

       Gtk::Requisition child_requisition_one, child_requisition_two;
       if(m_child_one && m_child_one->is_visible())
         gtk_widget_size_request(m_child_one->gobj(), &child_requisition_one);

       if(m_child_two && m_child_two->is_visible())
         gtk_widget_size_request(m_child_two->gobj(), &child_requisition_two);
       //Note that we use gtk_widget_size_request(), because Gtk::Widget::size_request() is const. This is a bug that will be fixed in a later version of gtkmm.

      //See which one has the most width:
      int max_width = MAX(child_requisition_one.width, child_requisition_two.width);

      //Add the heights together:
      int total_height = child_requisition_one.height + child_requisition_two.height;

      //Request the width for this container based on the sizes requested by its child widgets:
      requisition->height = total_height;
      requisition->width = max_width;
    }

    void MyContainer::on_size_allocate(Gtk::Allocation& allocation)
    {
      //Do something with the space that we have actually been given:
      //(We will not be given heights or widths less than we have requested, though we might get more)

      //Use the offered allocation for this container:
      set_allocation(allocation);

      //Assign sign space to the child:
      Gtk::Allocation child_allocation_one, child_allocation_two;

      //Place the first child at the top-left,
      child_allocation_one.set_x( allocation.get_x() );
      child_allocation_one.set_y( allocation.get_y() );

      //Make it take up the full width available:
      child_allocation_one.set_width( allocation.get_width() );

      //Make it take up half the height available:
      child_allocation_one.set_height( allocation.get_height() / 2);

      if(m_child_one && m_child_one->is_visible())
        m_child_one->size_allocate(child_allocation_one);

      //Place the second child below the first child:
      child_allocation_two.set_x( allocation.get_x() );
      child_allocation_two.set_y( allocation.get_y() + child_allocation_one.get_height());

      //Make it take up the full width available:
      child_allocation_two.set_width( allocation.get_width() );

      //Make it take up half the height available:
      child_allocation_two.set_height( allocation.get_height() - child_allocation_one.get_height());

      if(m_child_two && m_child_two->is_visible())
        m_child_two->size_allocate(child_allocation_two);
    }

    void MyContainer::forall_vfunc(gboolean /* include_internals */, GtkCallback callback, gpointer callback_data)
    {
      if(m_child_one)
        callback(m_child_one->gobj(), callback_data);

      if(m_child_two)
        callback(m_child_two->gobj(), callback_data);
    }

    void MyContainer::on_add(Gtk::Widget* child)
    {
      if(!m_child_one)
      {
        m_child_one = child;

        gtk_widget_set_parent(child->gobj(), GTK_WIDGET(gobj()));
        //This is protected, but should be public: child.set_parent(*this);
      }
      else if(!m_child_two)
      {
        m_child_two = child;

        gtk_widget_set_parent(child->gobj(), GTK_WIDGET(gobj()));
      }
    }

    void MyContainer::on_remove(Gtk::Widget* child)
    {
      if(child)
      {
        const bool visible = child->is_visible();
        bool found = false;

        if(child == m_child_one)
        {
          m_child_one = 0;
          found = true;
        }
        else if(child == m_child_two)
        {
          m_child_two = 0;
          found = true;
        }

        if(found)
        {
          gtk_widget_unparent(child->gobj());

          if(visible)
            queue_resize();
        }
      }
    }

    GtkType MyContainer::child_type_vfunc() const
    {
      //If there is still space for one widget, then report the type of widget that may be added.
      if(!m_child_one || !m_child_two)
        return Gtk::Widget::get_type();
      else
      {
        //No more widgets may be added.
        return G_TYPE_NONE;
      }
    }

### Custom Widgets

By deriving directly from `Gtk::Widget` you can do all the drawing for your widget directly, instead of just arranging child widgets. For instance, a Gtk::Label draws the text of the label, but does not do this by using other widgets.

#### Example

This example implements a widget which draws a square.

##### Custom Widget

Source Code

File: examplewindow.h

    #ifndef GTKMM_EXAMPLEWINDOW_H
    #define GTKMM_EXAMPLEWINDOW_H

    #include <gtkmm.h>
    #include "mywidget.h"

    class ExampleWindow : public Gtk::Window
    {
    public:
      ExampleWindow();
      virtual ~ExampleWindow();

    protected:
      //Signal handlers:
      virtual void on_button_quit();

      //Child widgets:
      Gtk::VBox m_VBox;
      MyWidget m_MyWidget;
      Gtk::HButtonBox m_ButtonBox;
      Gtk::Button m_Button_Quit;
    };

    #endif //GTKMM_EXAMPLEWINDOW_H

File: mywidget.h

    #ifndef GTKMM_CUSTOM_WIDGET_MYWIDGET_H
    #define GTKMM_CUSTOM_WIDGET_MYWIDGET_H

    #include <gtkmm/widget.h>

    class MyWidget : public Gtk::Widget
    {
    public:
      MyWidget();
      virtual ~MyWidget();

    protected:

      //Overrides:
      virtual void on_size_request(Gtk::Requisition* requisition);
      virtual void on_size_allocate(Gtk::Allocation& allocation);
      virtual void on_map();
      virtual void on_unmap();
      virtual void on_realize();
      virtual void on_unrealize();
      virtual bool on_expose_event(GdkEventExpose* event);

      Glib::RefPtr<Gdk::Window> m_refGdkWindow;
      Glib::RefPtr<Gdk::GC> m_refGC;
    };

    #endif //GTKMM_CUSTOM_WIDGET_MYWIDGET_H

File: examplewindow.cc

    #include <iostream>
    #include "examplewindow.h"

    ExampleWindow::ExampleWindow()
    : m_Button_Quit("Quit")
    {
      set_title("Custom Widget example");
      set_border_width(6);
      set_default_size(400, 200);

      add(m_VBox);
      m_VBox.pack_start(m_MyWidget, Gtk::PACK_EXPAND_WIDGET);
      m_MyWidget.show();

      m_VBox.pack_start(m_ButtonBox, Gtk::PACK_SHRINK);

      m_ButtonBox.pack_start(m_Button_Quit, Gtk::PACK_SHRINK);
      m_ButtonBox.set_border_width(6);
      m_ButtonBox.set_layout(Gtk::BUTTONBOX_END);
      m_Button_Quit.signal_clicked().connect( sigc::mem_fun(*this, &ExampleWindow::on_button_quit) );

      show_all_children();
    }

    ExampleWindow::~ExampleWindow()
    {
    }

    void ExampleWindow::on_button_quit()
    {
      hide();
    }

File: main.cc

    #include <gtkmm/main.h>
    #include "examplewindow.h"

    int main(int argc, char *argv[])
    {
      Gtk::Main kit(argc, argv);

      ExampleWindow window;
      Gtk::Main::run(window); //Shows the window and returns when it is closed.

      return 0;
    }

File: mywidget.cc

    #include <iostream>
    #include "mywidget.h"

    MyWidget::MyWidget()
    {
      set_flags(Gtk::NO_WINDOW);
      //add_events(Gdk::EXPOSURE_MASK);
    }

    MyWidget::~MyWidget()
    {
    }

    void MyWidget::on_size_request(Gtk::Requisition* requisition)
    {
      //Initialize the output parameter:
      *requisition = Gtk::Requisition();

      //Discover the total amount of minimum space needed by this widget.

      //Let's make this simple example widget always need 50 by 50:
      requisition->height = 50;
      requisition->width = 50;
    }

    void MyWidget::on_size_allocate(Gtk::Allocation& allocation)
    {
      //Do something with the space that we have actually been given:
      //(We will not be given heights or widths less than we have requested, though we might get more)

      //Use the offered allocation for this container:
      set_allocation(allocation);

      if(m_refGdkWindow)
        m_refGdkWindow->move_resize( allocation.get_x(), allocation.get_y(), allocation.get_width(), allocation.get_height() );
    }

    void MyWidget::on_map()
    {
      //Call base class:
      Gtk::Widget::on_map();
    }

    void MyWidget::on_unmap()
    {
      //Call base class:
      Gtk::Widget::on_unmap();
    }

    void MyWidget::on_realize()
    {
      //Call base class:
      Gtk::Widget::on_realize();

      //TODO: Not sure whether this is necessary:
      set_flags(Gtk::REALIZED);
      set_window( get_parent_window() );
      GtkWidget* cWidget = (GtkWidget*)gobj();
      cWidget->style = gtk_style_attach(cWidget->style, get_window()->gobj());

      if(!m_refGdkWindow)
      {
        //Create the GdkWindow:

        GdkWindowAttr attributes;
        memset(&attributes, 0, sizeof(attributes));

        Gtk::Allocation allocation = get_allocation();

        //Set initial position and size of the Gdk::Window:
        attributes.x = allocation.get_x();
        attributes.y = allocation.get_y();
        attributes.width = allocation.get_width();
        attributes.height = allocation.get_height();

        attributes.window_type = GDK_WINDOW_CHILD;
        attributes.wclass = GDK_INPUT_OUTPUT;

        m_refGdkWindow = Gdk::Window::create(
          get_window() /* parent */,
          &attributes,
          GDK_WA_X | GDK_WA_Y);

        //Allocate a GC for use in on_expose_event():
        m_refGC = Gdk::GC::create(m_refGdkWindow);
      }
    }

    void MyWidget::on_unrealize()
    {
      m_refGdkWindow.clear();
      m_refGC.clear();

      //Call base class:
      Gtk::Widget::on_unrealize();
    }

    bool MyWidget::on_expose_event(GdkEventExpose* /* event */)
    {
      if(m_refGdkWindow)
      {
        //Draw on the Gdk::Window:

        Glib::RefPtr<Gdk::Colormap> colormap = get_default_colormap ();
        Gdk::Color color_blue("blue");
        Gdk::Color color_red("red");
        colormap->alloc_color(color_blue);
        colormap->alloc_color(color_red);

        m_refGdkWindow->set_background( color_red );
        m_refGdkWindow->clear();
        m_refGC->set_foreground( color_blue );
        m_refGdkWindow->draw_line(m_refGC, 1, 1, 100, 100);
      }

      return true;
    }

## Recommended Techniques

This section is simply a gathering of wisdom, general style guidelines and hints for creating gtkmm applications.

Use GNU autoconf and automake! They are your friends :) Automake examines C files, determines how they depend on each other, and generates a Makefile so the files can be compiled in the correct order. Autoconf permits automatic configuration of software installation, handling a large number of system quirks to increase portability..

Subclass Widgets to better organise your code. You should probably subclass your main Window at least. Then you can make your child Widgets and signal handlers members of that class.

Create your own signals instead of passing pointers around. Objects can communicate with each other via signals and signal handlers. This is much simpler than objects holding pointers to each other and calling each other's methods. gtkmm's classes uses special versions of Sigc::Signal, but you should use normal sigc::signals, as described in the libsigc++ documentation.

### Application lifetime

Most applications will have only one window, or only one main window. These applications can use the Gtk::Main::run(Gtk::Window&) overload. It shows the window and returns when the window has been hidden. This might happen when the user closes the window, or when your code decides to hide() the window. You can prevent the user from closing the window (for instance, if there are unsaved changes) by overriding Gtk::Window::on_delete_event().

Most of our examples use this technique.

### Using a gtkmm widget

Our examples all tend to have the same structure. They follow these steps for using a Widget:

1. Declare a variable of the type of Widget you wish to use, generally as member variable of a derived container class. You could also declare a pointer to the Widget type, and then create it with `new` in your code. Even when using the widget via a pointer, it's still probably best to make that pointer a member variable of a container class so that you can access it later.

2. Set the attributes of the widget. If the Widget has no default constructor, then you will need to initialize the widget in the initalizer list of your container class's constructor.

3. Connect any signals you wish to use to the appropriate handlers.

4. Pack the widget into a container using the appropriate call, e.g. `Gtk::Container::add()` or `pack&lowbar;start()`.

5. Call `show()` to display the widget.

`Gtk::Widget::show()` lets gtkmm know that we have finished setting the attributes of the widget, and that it is ready to be displayed. You can use `Gtk::Widget::hide()` to make it disappear again. The order in which you show the widgets is not important, but we do suggest that you show the top-level window last; this way, the whole window will appear with its contents already drawn. Otherwise, the user will first see a blank window, into which the widgets will be gradually drawn.

## Contributing

This document, like so much other great software out there, was created for free by volunteers. If you are at all knowledgeable about any aspect of gtkmm that does not already have documentation, please consider contributing to this document.

Ideally, we would like you to provide a patch to the docs/tutorial/gtkmm-tut.xml file. This file is currently in the gtkmm2 module in gnome cvs.

If you do decide to contribute, please post your contribution to the gtkmm mailing list at <gtkmm-list@gnome.org>. Also, be aware that the entirety of this document is free, and any addition you provide must also be free. That is, people must be able to use any portion of your examples in their programs, and copies of this document (including your contribution) may be distributed freely.

## The RefPtr smartpointer

Glib::RefPtr is a smartpointer. Specifically, it is a reference-counting smartpointer. You might be familiar with `std::auto_ptr<>`, which is also a smartpointer, but `Glib::RefPtr<>` is much simpler, and more useful. We expect a future version of the C++ Standard Library to contain a reference-counting shared smartpointer, so a future version of gtkmm will probably use that instead.

Reference

A smartpointer acts much like a normal pointer. Here are a few examples.

### Copying

You can copy RefPtrs, just like normal pointers. But unlike normal pointers, you don't need to worry about deleting the underlying instance

    Glib::RefPtr<Gdk::Bitmap> refBitmap = Gdk::Bitmap::create(window,
    data, width, height);
    Glib::RefPtr<Gdk::Bitmap> refBitmap2 = refBitmap;

Of course this means that you can store RefPtrs in standard containers, such as std::vector or std::list.

    std::list< Glib::RefPtr<Gdk::Pixmap> > listPixmaps;
    Glib::RefPtr<Gdk::Pixmap> refPixmap = Gdk::Pixmap::create(window,
    width, height, depth);
    listPixmaps.push_back(refPixmap);

### Dereferencing

You can dereference a smartpointer with the -> operator, to call the methods of the underlying instance, just like a normal pointer.

    Glib::RefPtr<Gdk::Bitmap> refBitmap = Gdk::Bitmap::create(window,
    data, width, height);
    int depth = refBitmap->get_depth();

But unlike most smartpointers, you can't use the * operator to access the underlying instance.

    Glib::RefPtr<Gdk::Bitmap> refBitmap = Gdk::Bitmap::create(window,
    data, width, height);
    Gdk::Bitmap* underlying = *refBitmap; //Syntax error - will not compile.

### Casting

You can cast RefPtrs to base types, just like normal pointers.

    Glib::RefPtr<Gtk::TreeStore> refStore = Gdk::TreeStore::create(columns);
    Glib::RefPtr<Gtk::TreeModel> refModel = refStore;

This means that any method which takes a `const Glib::RefPtr<BaseType>` argument can also take a `const Glib::RefPtr<DerivedType>`. The cast is implicit, just as it would be for a normal pointer.

You can also cast to a derived type, but the syntax is a little different than with a normal pointer.

    Glib::RefPtr<Gtk::TreeStore> refStore =
    Glib::RefPtr<Gtk::TreeStore>::cast_dynamic(refModel);
    Glib::RefPtr<Gtk::TreeStore> refStore2 =
    Glib::RefPtr<Gtk::TreeStore>::cast_static(refModel);

### Checking for null

Just like normal pointers, you can check whether a RefPtr points to anything.

    Glib::RefPtr<Gtk::TreeModel> refModel = m_TreeView.get_model();
    if(refModel)
    {
      int cols_count = refModel->get_n_columns();
      ...
    }

But unlike normal pointers, RefPtrs are automatically initialized to null so you don't need to remember to do that yourself.

### Constness

The use of the const keyword in C++ is not always clear. You might not realise that `const Something*` declares a pointer to a const Something, The pointer can be changed, but not the Something that it points to.

Therefore, the RefPtr equivalent of `Something*` for a method parameter is `const Glib::RefPtr<Something>&`, and the equivalent of `const Something*` is `const Glib::RefPtr<const Something>&`.

The `const ... &` around both is just for efficiency, like using `const std::string&` instead of `std::string` for a method parameter to avoid unnecessary copying.

## Signals

### Connecting signal handlers

gtkmm widget classes have signal accessor methods, such as Gtk::Button::signal_clicked, which allow you to connect your signal handler. Thanks to the flexibility of libsigc++, the callback library used by gtkmm, the signal handler can be almost any kind of function, but you will probably want to use a class method. Among GTK+ C coders, these signal handlers are often named callbacks.

Here's an example of a signal handler being connected to a signal:

    #include <gtkmm/button.h>

    void on_button_clicked()
    {
        std::cout << "Hello World" << std::endl;
    }

    main()
    {
        Gtk::Button button("Hello World");
        button.signal_clicked().connect(sigc::mem_fun(&on_button_clicked));
    }

There's rather a lot to think about in this (non-functional) code. First let's identify the parties involved:

- The signal handler is `on_button_clicked()`.

- We're hooking it up to the `Gtk::Button` object called `button`.

- When the Button emits its `clicked` signal, `on_button_clicked()` will be called.

Now let's look at the connection again::

        ...
        button.signal_clicked().connect(sigc::ptr_fun(&on_button_clicked));
        ...

Note that we don't pass a pointer to `on_button_clicked()` directly to the signal's `connect()` method. Instead, we call `sigc::ptr_fun()`, and pass the result to `connect()`. What's that `sigc::ptr_fun()` function for?

sigc::ptr_fun() is a `factory function` which generates `sigc::pointer_functors` that are implicitly converted into sigc::slots. A slot is an object which looks and feels like a function, but is actually an object. These are also known as `function objects`, or `functors`. `sigc::pointer_functors` are functors as well and there are many other functor types like, e.g., `sigc::mem_functors` which are generated by sigc::mem_fun(). Any functor that can be called with the argument types of the slot can be implicitely converted into a slot, i.e. you can pass any compatible functor into a function that expects a sigc::slot.

Here's a slightly larger example of slots in action:

    void on_button_clicked();

    class some_class
    {
        void on_button_clicked();
    };

    some_class some_object;

    main()
    {
        Gtk::Button button;
        button.signal_clicked().connect( sigc::ptr_fun(&on_button_clicked) );
        button.signal_clicked().connect( sigc::mem_fun(some_object, &some_class::on_button_clicked) );
    }

The first call to `connect()` is just like the one we saw last time; nothing new here. The next is more interesting. `sigc::mem_fun()` is called with two arguments. The first argument is "some_object", which is the object that our new slot will be pointing at; the second argument is a pointer to one of its methods. This particular version of `sigc::mem_fun()` creates a slot which will, when "called", call the pointed-to method of the specified object, in this case some_object.on_button_clicked().

Another thing to note about this example is that we placed the call to `connect()` twice for the same signal object. This is perfectly fine - when the button is clicked, both signal handlers will be called.

We just told you that the button's `clicked` signal is expecting to call a method with no arguments. All signals have requirements like this; you can't hook a function with two arguments to a signal expecting none (unless you use an adapter, such as sigc::bind, of course). Therefore, it's important to know what type of signal handler you'll be expected to connect to a given signal.

### Writing signal handlers

To find out what type of signal handler you can connect to a signal, you can look it up in the reference documentation or the header file. Here's an example of a signal declaration you might see in the gtkmm headers:

    Glib::SignalProxy1<bool, GtkDirectionType> signal_focus()

Other than the signal's name (`focus`), two things are important to note here: the number following the word `SignalProxy` at the beginning (1, in this case), and the types in the list (`bool` and `GtkDirectionType`). The number indicates how many arguments the signal handler should have; the first type, `bool`, is the type that the signal handler should return; and the next type, `GtkDirectionType`, is the type of this signal's first, and only, argument. By looking at the reference documentation, you can see the names of the arguments too.

The same principles apply for signals which have more arguments. Here's one with three (taken from `<gtkmm/editable.h>`):

    Glib::SignalProxy3<void, const Glib::ustring&, int, int*> signal_insert_text()

It follows the same form. The number 3 at the end of the type's name indicates that our signal handler will need three arguments. The first type in the type list is `void`, so that should be our signal handler's return type. The following three types are the argument types, in order. Our signal handler's prototype could look like this:

    void on_insert_text(const Glib::ustring& text, int length, int* position);

### Disconnecting signal handlers

Let's take another look at a Signal's `connect` method:

    sigc::signal<void,int>::iterator signal<void,int>::connect( const sigc::slot<void,int>& );

Notice that the return value is of type `sigc::signal<void,int>::iterator`. This can be implicitely converted into a `sigc::connection` which in turn can be used to control the connection. By keeping a connection object you can disconnect its associated signal handler using the method `sigc::connection::disconnect()`.

### Overriding default signal handlers

So far we've told you to perform actions in response to button-presses and the like by handling signals. That's certainly a good way to do things, but it's not the only way.

Instead of laboriously connecting signal handlers to signals, you can simply make a new class which inherits from a widget - say, a Button - and then override the default signal handler, such as Button::on_clicked(). This can be a lot simpler than hooking up signal handlers for everything.

Subclassing isn't always the best way to accomplish things. It is only useful when you want the widget to handle its own signal by itself. If you want some other class to handle the signal then you'll need to connect a separate handler. This is even more true if you want several objects to handle the same signal, or if you want one signal handler to respond to the same signal from different objects.

gtkmm classes are designed with overriding in mind; they contain virtual member methods specifically intended to be overridden.

Let's look at an example of overriding:

    #include <gtkmm/button.h>

    class OverriddenButton : public Gtk::Button
    {
    protected:
        virtual void on_clicked();
    }

    void OverriddenButton::on_clicked()
    {
        std::cout << "Hello World" << std::endl;

        // call the base class's version of the method:
        Gtk::Button::on_clicked();
    }

Here we define a new class called `OverriddenButton`, which inherits from `Gtk::Button`. The only thing we change is the `on_clicked` method, which is called whenever `Gtk::Button` emits the `clicked` signal. This method prints "Hello World" to `stdout`, and then calls the original, overridden method, to let `Gtk::Button` do what it would have done had we not overridden.

You don't always need to call the parent's method; there are times when you might not want to. Note that we called the parent method after writing "Hello World", but we could have called it before. In this simple example, it hardly matters much, but there are times when it will. With signals, it's not quite so easy to change details like this, and you can do something here which you can't do at all with connected signal handlers: you can call the parent method in the middle of your custom code.

### Binding extra arguments

If you use one signal handler to catch the same signal from several widgets, you might like that signal handler to receive some extra information. For instance, you might want to know which button was clicked. You can do this with `sigc::bind()`. Here's some code from the helloworld2 example, which you will encounter later.

    m_button1.signal_clicked().connect( sigc::bind<Glib::ustring>( sigc::mem_fun(*this, &HelloWorld::on_button_clicked), "button 1") );

This says that we want the signal to send an extra Glib::ustring argument to the signal handler, and that the value of that argument should be "button 1". Of course we will need to add that extra argument to the declaration of our signal handler:

    virtual void on_button_clicked(Glib::ustring data);

Of course, a normal "clicked" signal handler would have no arguments.

sigc::bind() is not commonly used, but you might find it helpful sometimes. If you are familiar with GTK+ programming then you have probably noticed that this is similar to the extra `gpointer data` arguments which all GTK+ callbacks have. This is generally overused in GTK+ to pass information that should be stored as member data in a derived Widget, but Widget derivation is very difficult in C. We have far less need of this hack in gtkmm.

### X Event signals

The Widget class has some special signals which correspond to the underlying X-Windows events. These are suffixed by `_event`; for instance, `Widget::signal_button_pressed_event()`.

You might occasionally find it useful to handle X events when there's something you can't accomplish with normal signals. `Gtk::Button`, for example, does not send mouse-pointer coordinates with its `clicked` signal, but you could handle `button&lowbar;pressed&lowbar;event` if you needed this information. X events are also often used to handle key-presses.

These signals behave slightly differently. The value returned from the signal handler indicates whether it has fully "handled" the event. If the value is `false` then gtkmm will pass the event on to the next signal handler. If the value is `true` then no other signal handlers will need to be called.

Handling an X event doesn't affect the Widget's other signals. If you handle `button&lowbar;pressed&lowbar;event` for `Gtk::Button`, you'll still be able to get the `clicked` signal. They are emitted at (nearly) the same time.

Here's a simple example:

    bool on_button_press(GdkEventButton* event);
    Gtk::Button button("label");
    button.signal_button_press_event().connect( sigc::ptr_fun(&on_button_press) );

When the mouse is over the button and a mouse button is pressed, `on&lowbar;button&lowbar;pressed()` will be called.

`GdkEventButton` is a structure containing the event's parameters, such as the coordinates of the mouse pointer at the time the button was pressed. There are several different types of `GdkEvent` structures for the various events.

## Creating your own signals

Now that you've seen signals and signal handlers in gtkmm, you might like to use the same technique to allow interaction between your own classes. That's actually very simple by using the libsigc++ library directly.

This isn't purely a gtkmm or GUI issue. gtkmm uses libsigc++ to implement its proxy wrappers for the GTK+ signal system, but for new, non-GTK+ signals, you can create pure C++ signals, using the sigc::signal<> template.

For instance, to create a signal that sends 2 parameters, a bool and an integer, just declare a sigc::signal, like so:

    sigc::signal<void, bool int> signal_something;

You could just declare that signal as a public member variable, but some people find that distasteful and prefer to make it available via an accessor method, like so:

    class Server
    {
      //signal accessor:
      typedef sigc::signal<void, bool, int> type_signal_something;
      type_signal_something signal_something();

    protected:
      type_signal_something m_signal_something;
    };

    Server::type_signal_something Server::signal_something()
    {
      return m_signal_something;
    }

You can then connect to the signal using the same syntax used when connecting to gtkmm signals. For instance,

    server.signal_something().connect(
      sigc::mem_fun(client, &Client::on_server_something) );

See examples/book/signals/custom/ for a full working example.

## Comparison with other signalling systems

TODO: Rewrite this paragraph and talk about QT's moc. (An aside: GTK+ calls this scheme "signalling"; the sharp-eyed reader with GUI toolkit experience will note that this same design is often seen under the name of "broadcaster-listener" (e.g., in Metrowerks' PowerPlant framework for the Macintosh). It works in much the same way: one sets up `broadcasters`, and then connects `listeners` to them; the broadcaster keeps a list of the objects listening to it, and when someone gives the broadcaster a message, it calls all of its objects in its list with the message. In gtkmm, signal objects play the role of broadcasters, and slots play the role of listeners - sort of. More on this later.)

gtkmm signal handlers are strongly-typed, whereas GTK+ C code allows you to connect a callback with the wrong number and type of arguments, leading to a segfault at runtime. And, unlike QT, gtkmm achieves this without modifying the C++ language.

Re. Overriding signal handlers: You can do this in the straight-C world of GTK+ too; that's what GTK's object system is for. But in GTK+, you have to go through some complicated procedures to get object-oriented features like inheritance and overloading. In C++, it's simple, since those features are supported in the language itself; you can let the compiler do the dirty work.

This is one of the places where the beauty of C++ really comes out. One wouldn't think of subclassing a GTK+ widget simply to override its action method; it's just too much trouble. In GTK+, you almost always use signals to get things done, unless you're writing a new widget. But because overriding methods is so easy in C++, it's entirely practical - and sensible - to subclass a button for that purpose.

## gtkmm and Win32

One of the major advantages of gtkmm is that it is crossplatform. gtkmm programs written on other platforms such as GNU/Linux can generally be transferred to Windows (and vice versa) with few modifications to the source.

gtkmm currently only works with the MingW/GCC3.2 compiler on the Windows platform. This is unlikely to change in the near future, unless Microsoft upgrades its compilers in Visual Studio to fully support the C++ standard. Information about the gtkmm and the latest Microsoft C++ compiler might be on the mailing list.

Installation of MingW is beyond the scope of this document, though not excessively difficult. However, a good GPL'd C++ IDE for windows called Dev-C++ has a convenient Windows installer that installs both the IDE and the MingW/GCC3.2 compiler, and we can recommend it. We will now show step by step how to install gtkmm and properly set up Dev-C++ as your gtkmm development environment. The following instructions should work for Dev-C++ versions 4.9.8.0 or higher. For people who prefer command line compiler tools, a solution based on the cygwin distribution will be described in the last section of this chapter.

### The Dev-C++ IDE

#### Pre-Installation Issues

We strongly recommend that Dev-C++ is installed and tested before installing any of the GTK+ or gtkmm libraries, as we will be installing all the libraries into the Dev-C++ directory. Ensure that you are able to successfully compile and run a simple C++ program from Dev-C++ before proceeding to the next step. For instance, try a simple Hello World program.

Note: Currently (as of v4.9.8.0) Dev-C++ does not like to be installed in directories with spaces in them. Installing Dev-C++ to the "Program Files" directory may cause problems at a later stage when it looks for the include and lib directories.

#### Dependencies

The gtkmm Windows installer requires you to first install the following dependencies:

- GTK+ 2.x

  Before installing gtkmm, you need to install the latest GTK+ 2.x. You can find the latest windows installer at Glade/Gtk+ for Win32. The Windows installer will correctly install any dependencies that GTK+ 2.x may need.

  You will need to download and install the Gtk+/Win32 Development Environment. This includes the runtime, devel, docs, and glade. Start with the Development GTK+ installer, and allow the installation to proceed to the default directory.

#### Installation

Now you are ready to install gtkmm. You can find a link to an installer on the gtkmm web site's download page. The gtkmm Windows installer includes both the development and the runtime files.

Since we are going to be using Dev-C++ as our IDE, it is strongly suggested that you install gtkmm into the base Dev-C++ directory (ie. d:\dev-cpp). This will make things easier later on when setting up the include and lib directories in Dev-C++.

You should now be ready to execute Win32 gtkmm compiled binaries. Note: Some older versions of Windows may require a reboot before the installer's change to the PATH variable takes effect.

#### Compiling gtkmm Apps with Dev-C++

Now we need to set some project options to create our first gtkmm project in Dev-C++.

First, we need to let Dev-C++ know what files and libraries to include when it invokes MingW/GCC3.2. To find out what arguments need to be passed to GCC, we need to open a command prompt and type the following:

`pkg-config --cflags gtkmm-2.4`

If the pkg-config command cannot be found, you can cd to the bin/ directory of where you installed Dev-C++ and execute the above line from there. Depending on where you installed gtkmm, you will get output that looks similar to the following:

    	    -Id:/dev-c++/include/gtkmm-2.4
    	    -Id:/dev-c++/lib/gtkmm-2.4/include
    	    -Id:/dev-c++/include/gtk-2.0
    	    -Id:/dev-c++/lib/sigc++-2.0/include
    	    -Id:/dev-c++/include/sigc++-2.0
    	    -Id:/dev-c++/include/glib-2.0
    	    -Id:/dev-c++/lib/glib-2.0/include
    	    -Id:/dev-c++/lib/gtk-2.0/include
    	    -Id:/dev-c++/include/pango-1.0 -Id:/dev-c++/include/atk-1.0
    	    -Ld:/dev-c++/lib

The next step is to obtain the list of libraries by issuing the following command:

`pkg-config --libs gtkmm-2.4`

Your results may look something similar to this:

    	    -lgtkmm-2.4 -lgdkmm-2.4 -latkmm-1.0
    	    -lgtk-win32-2.0 -lpangomm-1.4 -lglibmm-2.4 -lsigc-2.0
    	    -lgdk-win32-2.0 -latk-1.0 -lgdk_pixbuf-2.0 -lpangowin32-1.0
    	    -lgdi32 -lpango-1.0 -lgobject-2.0 -lgmodule-2.0 -lglib-2.0
    	    -lintl -liconv

##### Dev-C++ Project Options

Now create a new Project. We will make this project work with gtkmm. After creating a new project, select `Project Options` from the menu, and under the `Parameters` tab, we will need to enter the information we obtained earlier: In the `Additional commandline options` for the C++ compiler, paste the include and lib directories you obtained with the --cflags argument. (The commandline options preceeded by either an -I or a -L).

Now we must tell the linker what libraries to include, by pasting the libraries into the `Additional commandline options` for the Linker. (These commandline options are preceeded by a -l).

Congratulations. You have successfully created a new project in Dev-C++ that works with gtkmm. Try compiling some of the examples in this tutorial.

### Command line tools

To build your gtkmm application with command line tools, we recommend you either use mingw combined with cygwin () or msys (). If you use mingw/cygwin, make sure that the directory that contains the mingw executables is first in your PATH (by checking with g++ -v). Then

1. Add the directories with the gtkmm and gtk+ DLLs and the gtk+ executables (particularly the one containing pkg-config.exe) to your path. If you have selected the corresponding option in the gtkmm installer, both the gtkmm and gtk+ runtime will already be in your PATH. Make sure pkg-config is available by typing `'pkg-config --version'`.

2. Set the PKG_CONFIG_PATH environment variable to point to the various lib/pkgconfig directories. Look for files with the .pc extension in the gtk+ and gtkmm developer packages. It's the same syntax as on linux but the directories are separated by semicolons.

3. Check the gtkmm distribution by typing `'pkg-config --modversion --cflags --libs gtkmm-2.4'`. You should get something like

       		2.2.1
       		-IC:/target/libsigc/lib/sigc++-2.0/include
       		-IC:/target/libsigc/include/sigc++-2.0
       		-IC:/target/gtkmm/include/gtkmm-2.4
       		-IC:/target/gtkmm/lib/gtkmm-2.4/include
       		-IC:/target/gtk-2.0/include/gtk-2.0
       		-IC:/target/gtk-2.0/include/glib-2.0
       		-IC:/target/gtk-2.0/lib/glib-2.0/include
       		-IC:/target/gtk-2.0/lib/gtk-2.0/include
       		-IC:/target/gtk-2.0/include/pango-1.0
       		-IC:/target/gtk-2.0/include/atk-1.0
       		-LC:/target/libsigc/lib
       		-LC:/target/gtkmm/lib
       		-LC:/target/gtk-2.0/lib -lgtkmm-2.4
       		-lgdkmm-2.4 -latkmm-1.4 -lgtk-win32-2.0 -lpangomm-1.4
       		-lglibmm-2.4 -lsigc-2.0 -lgdk-win32-2.0 -latk-1.0
       		-lgdk_pixbuf-2.0 -lpangowin32-1.0 -lgdi32 -lpango-1.0
       		-lgobject-2.0 -lgmodule-2.0 -lglib-2.0 -lintl
       		-liconv

   Of course, the target directories will show your local installation tree.

4. You can compile a single source file like so:

   `g++ `pkg-config --cflags gtkmm-2.4` my_programs.cc -o my_program `pkg-config --libs gtkmm-2.4``

See the gtkmm FAQ for more build help.

### Building gtkmm on Win32

Please see the appropriate README file in the source distribution.