# Programming with &gtkmm;

Murray
Cumming
Bernhard
Rieder
Chapter on "Timeouts".
Jonathon
Jongsma
Chapter on "Drawing with Cairo".
Chapter on "Working with CVS".
Chapter on "Recent Files".
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".
Marko
Anastasov
Chapter on "Printing".
Parts of chapter on "Internationalization".
Alan
Ott
Appendix on "Visual Studio 2005.".

We 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-2006
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

### Dependencies

Before attempting to install &gtkmm; 2.4, you might first need to install these other packages.

- libsigc++ 2.0

- GTK+ 2.4

- cairomm

These dependencies have their own dependencies, including the following applications and libraries:

- pkg-config

- glib

- ATK

- Pango

- cairo

### Unix and Linux

#### Prebuilt Packages

Recent versions of &gtkmm; are packaged by nearly every major Linux distribution these days. So, if you use Linux, you can probably get started with &gtkmm; by installing the package from the official repository for your distribution. Distributions that include &gtkmm; in their repositories include Debian, Ubuntu, Red Hat, Fedora, Mandriva, Suse, and many others.

The names of the &gtkmm; packages vary from distribution to distribution (e.g. libgtkmm2.4-dev on Debian and Ubuntu or gtkmm24-devel on Red Hat Fedora), so check with your distribution's package management program for the correct package name and install it like you would any other package.

The package names will not change when new API/ABI-compatible versions of &gtkmm; are released. Otherwise they would not be API/ABI-compatible. So don't be surprised, for instance, to find &gtkmm; 2.8 supplied by Debian's libgtkmm2.4-dev package.

#### Installing From Source

If your distribution does not provide a pre-built &gtkmm; package, or if you want to install a different version than the one provided by your distribution, you can also install &gtkmm; from source. The source code for &gtkmm; can be downloaded from .

After you've installed all of the dependencies, download the &gtkmm; source code, unpack it, and change to the newly created directory. &gtkmm; can be built and installed with the following sequence of commands:

    # ./configure
    # make
    # make install

Remember that on a Unix or Linux operating system, 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.

The `configure` script will check to make sure all of the required dependencies are already installed. If you are missing any dependencies, it will exit and display an error.

By default, &gtkmm; will be installed under the `/usr/local` directory. On some systems you may 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

You should be very careful when installing to standard system prefixes such as `/usr`. Linux distributions install software packages to `/usr`, so installing a source package to this prefix could corrupt or conflict with software installed using your distribution's package-management system. Ideally, you should use a separate prefix for all software you install from source.

If you want to help develop &gtkmm; or experiment with new features, you can also install &gtkmm; from CVS. Most users will never need to do this, but if you're interested in helping with &gtkmm; development, see the Working with CVS appendix.

### 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 Windows-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 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. This is usually not a good idea, because 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.

### Headers and Linking

Although we have shown the compilation command for the 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.

However, this is even simpler when using the `PKG_CHECK_MODULES()` macro in a standard configure.ac file with autoconf and automake. For instance:

    PKG_CHECK_MODULES([MYAPP], [gtkmm-2.4 >= 2.8.0])

This checks for the presence of gtkmm and defines MYAPP_LIBS and MYAPP_CFLAGS for use in your Makefile.am files.

gtkmm-2.4 is the name of the current stable API. There was an older API called gtkmm-2-0 which installs in parallel when it is available. There are several versions of gtkmm-2.4, such as gtkmm 2.10. Note that the API name does not change for every version because that would be an incompatible API and ABI break. Theoretically, there might be a future gtkmm-3.0 API which would install in parallel with gtkmm-2.4 without affecting existing applications.

Note that if you mention extra modules in addition to gtkmm-2.4, they should be separated by spaces, not commas.

Openismus has more basic help with automake and autoconf.

### 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.

Although &gtkmm; widget instances have lifetimes and scopes just like those of other C++ classes, &gtkmm; has an optional time-saving feature that you will see in some of the examples. `Gtk::manage()` allows you to say that a child widget is owned by the container into which you place it. This is allows you to `new()` the widget, add it to the container and forget about deleting it. You can learn more about &gtkmm; memory management techniques in the Memory Management 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&uuml;&szlig; 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

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_button` object the label "Hello World".

Next we call the Window's `set_border_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_button`'s `clicked` signal. This prints our friendly greeting to `stdout`.

Next, we use the Window's `add()` method to put `m_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

#### Constructors

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

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 `ToggleButton`, you can use the `get_active()` method. This returns `true` if the button is "down". You can also set the toggle button's state, with `set_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

### 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 other `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 = Gtk::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_active()`:

Reference

#### Example

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

##### RadioButton

Source Code

## 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 `Scrollbar`s, 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_changed` signal. The update policies, set with the `set_update_policy()` method, are:

- `Gtk::UPDATE_CONTINUOUS` - This is the default. The `value_changed` signal is emitted continuously, i.e. whenever the slider is moved by even the tiniest amount.

- `Gtk::UPDATE_DISCONTINUOUS` - The `value_changed` signal is only emitted once the slider has stopped moving and the user has released the mouse button.

- `Gtk::UPDATE_DELAYED` - The `value_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

## 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

### 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

### 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_increment`: value to increment/decrement when pressing mouse button 1 on a button

- `page_increment`: value to increment/decrement when pressing mouse button 2 on a button

- `page_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_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_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

### 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

### 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

#### 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

#### 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_AUTOMATIC` or `Gtk::POLICY_ALWAYS`. `Gtk::POLICY_AUTOMATIC` will cause the scrolled window to display the scrollbar only if the contained widget is larger than the visible area. `Gtk::POLICY_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

#### 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.

###### AspectFrame

Source Code

#### 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

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

After building and running this program, try resizing the window to see the behaviour. Also, try playing with the options to `pack_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_size()`

- `empty()`

- `insert()`

- `push_front()`

- `push_back()`

- `pop_front()`

- `pop_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 `_Helpers`. For example, the helper namespace for the notebook widget is `Gtk::Notebook_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_back()` (this should be familiar to those who know STL).

The object that the `pages()` method returns is called a `Notebook_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_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_justify()` on it before adding it to the menu. The trouble is that there is no `right_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_back()`, causing the real menu item to be created. We've then called `right_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_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_start()` and `pack_end()` methods place widgets inside these containers. The `pack_start()` method will start at the top and work its way down in a `VBox`, or pack left to right in an `HBox`. `pack_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_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_start()` method).

This is the declaration of the `pack_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 `Button`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

#### 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.

`ButtonBox`es 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

#### 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_attach` and `right_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_attach` would be 1, `right_attach` 2, `top_attach` 1, and `bottom_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_attach` = 0, `right_attach` = 2, `top_attach` = 0, and `bottom_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_row_spacing()` and `set_col_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

#### Notebook

A `Notebook` has a set of stacked `pages`, each of which contains widgets. Labelled `tabs` allow the user to select the pages. `Notebook`s 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

##### 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 `TreeModelColumnRecord` 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 `TreeModelColumnRecord` which has your `TreeModelColumn` instances as member data.

    class ModelColumns : public Gtk::TreeModelColumnRecord
    {
    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:

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

#### "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 should then cast that `Gtk::CellRenderer*` to the specific `CellRenderer` that you expect, so you can use specific API.

For instance, for a CellRendererText, you would set the cell's editable property to true, like so:

    cell.property_editable() = true;

For a CellRendererToggle, you would set the activatable property instead.

You can 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 `Row`s:

    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()`, `selected_foreach_path()`, or `selected_foreach_iter()`, like so:

    refTreeSelection->selected_foreach_iter(
        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);

### Sorting

The standard tree models (`TreeStore` and `ListStore` derive from `TreeSortable`, so they offer sorting functionality. For instance, call `set_sort_column()`, to sort the model by the specified column. Or supply a callback function to `set_sort_func()` to implement a more complicated sorting algorithm.

TreeSortable Reference

#### Sorting by clicking on columns

So that a user can click on a `TreeView`'s column header to sort the `TreeView`'s contents, call `Gtk::TreeViewModel::set_sort_column()`, supplying the model column on which model should be sorted when the header is clicked. For instance:

    Gtk::TreeView::Column* pColumn = treeview.get_column(0);
    if(pColumn)
      pColumn->set_sort_column(m_columns.m_col_id);

#### Independently sorted views of the same model

The `TreeView` already allows you to show the same `TreeModel` in two `TreeView` widgets. If you need one of these TreeViews to sort the model differently than the other then you should use a `TreeModelSort` instead of just, for instance, `Gtk::TreeViewModel::set_sort_column()`. `TreeModelSort` is a model that contains another model, presenting a sorted version of that model. For instance, you might add a sorted version of a model to a `TreeView` like so:

    Glib::RefPtr<Gtk::TreeModelSort> sorted_model =
        Gtk::TreeModelSort::create(model);
    sorted_model->set_sort_column(columns.m_col_name, Gtk::SORT_ASCENDING);
    treeview.set_model(sorted_model);

Note, however, that the TreeView will provide iterators to the sorted model. You must convert them to iterators to the underlying child model in order to perform actions on that model. For instance:

    void ExampleWindow::on_button_delete()
    {
      Glib::RefPtr<Gtk::TreeSelection> refTreeSelection =
          m_treeview.get_selection();
      if(refTreeSelection)
      {
        Gtk::TreeModel::iterator sorted_iter =
            m_refTreeSelection->get_selected();
        if(sorted_iter)
        {
          Gtk::TreeModel::iterator iter =
              m_refModelSort->convert_iter_to_child_iter(sorted_iter);
          m_refModel->erase(iter);
        }
      }
    }

TreeModelSort Reference

### 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

#### 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

#### 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

#### 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

#### 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

## Combo Boxes

The `ComboBox` and `ComboBoxEntry` widgets offers a list (or tree) of choices in a dropdown menu. If appropriate, they can show extra information about each item, such as text, a picture, a checkbox, or a progress bar. The `ComboBox` widget restricts the user to the available choices, but the `ComboBoxEntry` contains an `Entry`, allowing the user to enter arbitrary text if the none of the available choices are suitable.

For both widgets, the list is provided via a `TreeModel`, and columns from this model are added to the ComboBox's view with the `ComboBox::pack_start()`. This provides a great deal of flexibility and compile-time type-safety, but the `ComboBoxText` and `ComboBoxEntryText` classes provide a simple text-based specialisation in case that flexibility is not required.

### ComboBox

Reference

#### The model

The model for a ComboBox can be defined and filled exactly as for a `TreeView`. For instance, you might derive a ComboBox class with one integer and one text columns, like so:

    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;

After appending rows to this model, you should provide the model to the `ComboBox` with the `set_model()` method. Then use the `pack_start()` or `pack_end()` methods to specify what methods will be displayed in the ComboBox. As with the TreeView you may either use the default cell renderer by passing the `TreeModelColumn` to the pack methods, or you may instantiate a specific `CellRenderer` and specify a particular mapping with either `add_attribute()` or `set_cell_data_func()`. Note that these methods are in the `CellLayout` base class.

#### The chosen item

To discover what item, if any, the user has chosen from the ComboBox, call `ComboBox::get_active()`. This returns a `TreeModel::iterator` that you can dereference to a `Row` in order to read the values in your columns. For instance, you might read an integer ID value from the model, even though you have chosen only to show the human-readable description in the Combo. For instance:

    Gtk::TreeModel::iterator iter = m_Combo.get_active();
    if(iter)
    {
      Gtk::TreeModel::Row row = *iter;

      //Get the data for the selected row, using our knowledge
      //of the tree model:
      int id = row[m_Columns.m_col_id];
      set_something_id_chosen(id); //Your own function.
    }
    else
      set_nothing_chosen(); //Your own function.

#### Responding to changes

You might need to react to every change of selection in the ComboBox, for instance to update other widgets. To do so, you should handle the "changed" signal. For instance:

    m_combo.signal_changed().connect( sigc::mem_fun(*this,
          &ExampleWindow::on_combo_changed) );

#### Full Example

##### ComboBox

Source Code

#### Simple Text Example

##### ComboBox

Source Code

### ComboBoxEntry

Reference

#### The text column

Unlike a regular `ComboBox`, a `ComboBoxEntry` contains a `Entry` widget for entering of arbitrary text. So that this Entry can interact with the drop-down list of choices, you must specify which of your model columns are the text column, with `set_text_column()`. For instance:

    m_combo.set_text_column(m_columns.m_col_name);

When you select a choice from the drop-down menu, the value from this column will be placed in the `Entry`.

#### The entry

Because the user may enter arbitrary text, an active model row isn't enough to tell us what text the user has inputted. Therefore, you should retrieve the `Entry` widget with the `ComboBoxEntry::get_entry()` method and call `get_text()` on that.

#### Full Example

##### ComboBoxEntry

Source Code

#### Simple Text Example

##### ComboBoxEntryText

Source Code

## 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 `Tag`s you should add them to the `TagTable`. For instance:

    Glib::RefPtr<Gtk::TextBuffer::TagTable> refTagTable =
        Gtk::TextBuffer::TagTable::create();
    refTagTable->add(refTagMatch);
    //Hopefully a future version of &gtkmm; will have a set_tag_table() method,
    //for use after creation of the buffer.
    Glib::RefPtr<Gtk::TextBuffer> refBuffer =
        Gtk::TextBuffer::create(refTagTable);

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 `Tag`s 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

## Menus and Toolbars

There are specific APIs for Menus and toolbars, but you should usually deal with them together, using the `UIManager` to define `Action`s 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) );

Note that this is where we specify the names of the actions as they will be seen by users in menus and toolbars. Therefore, this is where you should make strings translatable, by putting them inside the _() macro. When we use the Gtk::Stock items, of course, translations are automatically available.

### 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);

Remember that these names are just the identifiers that we used when creating the actions. They are not the text that the user will see in the menus and toolbars. We provided those human-readable names when we created the actions.

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(*pMenuBar, Gtk::PACK_SHRINK);

### Popup Menus

`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 displayed when the user clicks their right mouse button.

The UI layout for a popup menu should use the `popup` node. For instance:

    Glib::ustring ui_info =
        "<ui>"
        "  <popup name='PopupMenu'>"
        "    <menuitem action='ContextEdit'/>"
        "    <menuitem action='ContextProcess'/>"
        "    <menuitem action='ContextRemove'/>"
        "  </popup>"
        "</ui>";

    m_refUIManager->add_ui_from_string(ui_info);

To show the popup menu, use `Gtk::Menu`'s `popup()` method, providing the button identifier and the time of activation, as 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

#### Popup Menu example

##### Popup Menu

Source Code

## 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_increment` argument specifies the smaller of the two increments by which the user can change the value, while the `page_increment` is the larger one. The `page_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 automatically when you share an `Adjustment` object between a `Scrollbar` and another adjustable widget; all adjustable widgets connect signal handlers to their adjustment's `value_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::Button
    Gtk::CheckButton
    Gtk::Fixed
    Gtk::Image
    Gtk::Item
    Gtk::Label
    Gtk::MenuItem
    Gtk::Notebook
    Gtk::Paned
    Gtk::Pixmap
    Gtk::RadioButton
    Gtk::Range
    Gtk::ScrolledWindow
    Gtk::Separator
    Gtk::Table
    Gtk::Toolbar
    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

## 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. `Gtk::MessageDialog` is used 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

`MessageDialog` 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 the `Gtk::ButtonsType` enum.

Reference

#### Example

##### MessageDialog

Source Code

### FileChooserDialog

The `FileChooserDialog` is suitable for use with "Open" or "Save" menu items.

Most of the useful member methods for this class are actually in the `Gtk::FileChooser` base class.

Reference

#### Example

##### FileChooser

Source Code

### ColorSelectionDialog

The `ColorSelectionDialog` allows the user to choose a color.

Reference

#### Example

##### ColorSelectionDialog

Source Code

### FontSelectionDialog

The `FontSelectionDialog` allows the user to choose a font.

Reference

#### Example

##### FontSelectionDialog

Source Code

## The Drawing Area Widget

The `DrawingArea` widget is a blank 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 your own expose event signal handler to determine how the contents of the widget will be drawn. This is most often done by overriding the virtual `on_expose_event()` member function.

Before &gtkmm; version 2.10, drawing was mostly done with Graphics Contexts (`Gdk::GC`) and other GDK drawing functions, but this has been largely superceded by the Cairo graphics library and its C++ binding Cairomm. See the Gdk Appendix for a description of the deprecated GDK techniques. In general, the Cairo drawing API is simpler than the GDK one, and it is generally recommended to use the Cairo drawing methods wherever possible in preference to the older GDK drawing methods.

You can draw very sophisticated shapes using Cairo, but the methods to do so are quite basic. Cairo provides methods for drawing straight lines, curved lines, and arcs (including circles). These basic shapes can be combined to create more complex shapes and paths which can be filled with solid colors, gradients, patterns, and other things. In addition, Cairo can perform complex transformations, do compositing of images, and render antialiased text.

### Cairo and Pango

Although Cairo can render text, it's not meant to be a replacement for Pango. Pango is a better choice if you need to perform more advanced text rendering such as wrapping or ellipsizing text. Drawing text with Cairo should only be done if the text is part of a graphic.

In this section of the tutorial, we'll cover the basic Cairo drawing model, describe each of the basic drawing elements in some detail (with examples), and then present a simple application that uses Cairo to draw a custom clock widget.

### The Cairo Drawing Model

The basic concept of drawing in Cairo involves defining 'invisible' paths and then stroking or filling them to make them visible.

To do any drawing in &gtkmm; with Cairo, you must first create a `Cairo::Context` object. This class holds all of the graphics state parameters that describe how drawing is to be done. This includes information such as line width, color, the surface to draw to, and many other things. This allows the actual drawing functions to take fewer arguments to simplify the interface. In &gtkmm;, a `Cairo::Context` is created by calling the `Gdk::Window::create_cairo_context()` function. Since Cairo context are reference-counted objects, this function returns a `Cairo::RefPtr<Cairo::Context>` object.

The following example shows how to set up a Cairo context with a foreground color of red and a width of 2. Any drawing functions that use this context will use these settings.

    Gtk::DrawingArea myArea;
    Cairo::RefPtr<Cairo::Context> myContext = myArea.get_window()->create_cairo_context();
    myContext->set_source_rgb(1.0, 0.0, 0.0);
    myContext->set_line_width(2.0);

Each `Cairo::Context` is associated with a particular `Gdk::Window`, so the first line of the above example creates a `Gtk::DrawingArea` widget and the second line uses its associated `Gdk::Window` to create a `Cairo::Context` object. The final two lines change the graphics state of the context.

There are a number of graphics state variables that can be set for a Cairo context. The most common context attributes are color (using `set_source_rgb()` or `set_source_rgba()` for translucent colors), line width (using `set_line_width()`), line dash pattern (using `set_dash()`), line cap style (using `set_line_cap()`), and line join style (using `set_line_join()`), and font styles (using `set_font_size()`, `set_font_face()` and others). There are many other settings as well, such as transformation matrices, fill rules, whether to perform antialiasing, and others. For further information, see the Cairomm API documentation.

The current state of a `Cairo::Context` can be saved to an internal stack of saved states and later be restored to the state it was in when you saved it. To do this, use the `save()` method and the `restore()` method. This can be useful if you need to temporarily change the line width and color (or any other graphics setting) in order to draw something and then return to the previous settings. In this situation, you could call `Cairo::Context::save()`, change the graphics settings, draw the lines, and then call `Cairo::Context::restore()` to restore the original graphics state. Multiple calls to `save()` and `restore()` can be nested; each call to `restore()` restores the state from the matching paired `save()`.

It is good practice to put all modifications to the graphics state between `save()`/`restore()` function calls. For example, if you have a function that takes a `Cairo::Context` reference as an argument, you might implement it as follows:

    void doSomething(Cairo::RefPtr<Cairo::Context> context, int x)
    {
        context->save();
        // change graphics state
        // peform drawing operations
        context->restore();
    }

### Drawing Straight Lines

Now that we understand the basics of the Cairo graphics library, we're almost ready to start drawing. We'll start with the simplest of drawing elements: the straight line. But first you need to know a little bit about Cairo's coordinate system. The origin of the Cairo coordinate system is located in the upper-left corner of the window with positive x values to the right and positive y values going down.

Since the Cairo graphics library was written with support for multiple output targets (the X window system, PNG images, OpenGL, etc), there is a distinction between user-space and device-space coordinates. The mapping between these two coordinate systems defaults to one-to-one so that integer values map roughly to pixels on the screen, but this setting can be adjusted if desired. Sometimes it may be useful to scale the coordinates so that the full width and height of a window both range from 0 to 1 (the 'unit square') or some other mapping that works for your application. this can be done with the `Cairo::Context::scale()` function.

#### Example

In this example, we'll construct a small but fully functional &gtkmm; program and draw some lines into the window. The lines are drawn by creating a path and then stroking it. A path is created using the functions `Cairo::Context::move_to()` and `Cairo::Context::line_to()`. The function `move_to()` is similar to the act of lifting your pen off of the paper and placing it somewhere else -- no line is drawn between the point you were at and the point you moved to. To draw a line between two points, use the `line_to()` function.

After you've finished creating your path, you still haven't drawn anything visible yet. To make the path visible, you must use the function `stroke()` which will stroke the current path with the line width and style specified in your `Cairo::Context` object. After stroking, the current path will be cleared so that you can start on your next path.

Many Cairo drawing functions have a `_preserve()` variant. Normally drawing functions such as `clip()`, `fill()`, or `stroke()` will clear the current path. If you use the `_preserve()` variant, the current path will be retained so that you can use the same path with the next drawing function.

##### Drawing Area - Lines

Source Code

This program contains a single class, `MyArea`, which 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. This function is passed a pointer to a `GdkEventExpose` structure which defines the area that needs to be redrawn. We use these values to create a rectangle path in Cairo (using the `rectangle()` function) and then `clip()` to this path. The `clip()` function sets a clip region. The current clip region affects all drawing operations by effectively masking out any changes to the surface that are outside the current clip region. This allows us to limit our redrawing to only the area that needs to be redrawn. The actual drawing code sets the color we want to use for drawing by using `set_source_rgb()` which takes arguments defining the Red, Green, and Blue components of the desired color (valid values are between 0 and 1). After setting the color, we created a new path using the functions `move_to()` and `line_to()`, and then stroked this path with `stroke()`.

##### Drawing with relative coordinates

In the example above we drew everything using absolute coordinates. You can also draw using relative coordinates. For a straight line, this is done with the function `Cairo::Context::rel_line_to()`.

#### Line styles

In addition to drawing basic straight lines, there are a number of things that you can customize about a line. You've already seen examples of setting a line's color and width, but there are others as well.

If you've drawn a series of lines that form a path, you may want them to join together in a certain way. Cairo offers three different ways to join lines together: Miter, Bevel, and Round. These are show below:

##### Different join types in Cairo

The line join style is set using the function `Cairo::Context::set_line_join()`.

Line ends can have different styles as well. The default style is for the line to start and stop exactly at the destination points of the line. This is called a Butt cap. The other options are Round (uses a round ending, with the center of the circle at the end point) or Square (uses a squared ending, with the center of the square at the end point). This setting is set using the function `Cairo::Context::set_line_cap()`.

There are other things you can customize as well, including creating dashed lines and other things. For more information , see the Cairo API documentation.

### Drawing Curved Lines

In addition to drawing straight lines Cairo allows you to easily draw curved lines (technically a cubic Bézier spline) using the `Cairo::Context::curve_to()` and `Cairo::Context::rel_curve_to()` functions. These functions take coordinates for a destination point as well as coordinates for two 'control' points. This is best explained using an example, so let's dive in.

#### Example

This simple application draws a curve with Cairo and displays the control points for each end of the curve.

##### Drawing Area - Lines

Source Code

The only difference between this example and the straight line example is in the `on_expose_event()` function, but there are a few new concepts and functions introduced here, so let's examine them briefly.

Note that we clip to the area that needs re-exposing just as we did in the last example. After clipping, however, we make a call to `Cairo::Context::scale()`, passing in the width and height of the drawing area. This scales the user-space coordinate system such that the the width and height of the widget are both equal to 1.0 'units'. There's no particular reason to scale the coordinate system in this case, but sometimes it can make drawing operations easier.

The call to `Cairo::Context::curve_to()` should be fairly self-explanatory. The first pair of coordinates define the control point for the beginning of the curve. The second set of coordinates define the control point for the end of the curve, and the last set of coordinates define the destination point. To make the concept of control points a bit easier to visualize, a line has been draw from each control point to the end-point on the curve that it is associated with. Note that these control point lines are both translucent. This is achieved with a variant of `set_source_rgb()` called `set_source_rgba()`. This function takes a fourth argument specifying the alpha value of the color (valid values are between 0 and 1).

### Drawing Arcs and Circles

With Cairo, the same function is used to draw arcs, circles, or ellipses: `Cairo::Context::arc()`. This function takes five arguments. The first two are the coordinates of the center point of the arc, the third argument is the radius of the arc, and the final two arguments define the start and end angle of the arc. All angles are defined in radians, so drawing a circle is the same as drawing an arc from 0 to 2 * M_PI radians. An angle of 0 is in the direction of the positive X axis (in user-space). An angle of M_PI/2 radians (90 degrees) is in the direction of the positive Y axis (in user-space). Angles increase in the direction from the positive X axis toward the positive Y axis. So with the default transformation matrix, angles increase in a clockwise direction.

To draw an ellipse, you can scale the current transformation matrix by different amounts in the X and Y directions. For example, to draw an ellipse in the box given by `x`, `y`, `width`, `height`:

    context->save();
    context->translate(x, y);
    context->scale(width / 2.0, height / 2.0);
    context->arc(0.0, 0.0, 1.0, 0.0, 2 * M_PI);
    context->restore();

Note that this contradicts the advice given in the official Cairo documentation, but it seems to work.

#### Example

Here's an example of a simple program that draws an arc, a circle and an ellipse into a drawing area.

##### Drawing Area - Arcs

Source Code

There are a couple of things to note about this example code. Again, the only real difference between this example and the previous ones is the `on_expose_event()` function, so we'll limit our focus to that function. In addition, the first part of the function is nearly identical to the previous examples, so we'll skip that portion.

Note that in this case, we've expressed nearly everything in terms of the height and width of the window, including the width of the lines. Because of this, when you resize the window, everything scales with the window. Also note that there are three drawing sections in the function and each is wrapped with a `save()`/`restore()` pair so that we're back at a known state after each drawing.

The section for drawing an arc introduces one new function, `close_path()`. This function will in effect draw a straight line from the current point back to the first point in the path. There is a significant difference between calling `close_path()` and manually drawing a line back to the starting point, however. If you use `close_path()`, the lines will be nicely joined together. If you use `line_to()` instead, the lines will end at the same point, but Cairo won't do any special joining.

##### Drawing counter-clockwise

The function `Cairo::Context::arc_negative()` is exactly the same as `Cairo::Context::arc()` but the angles go the opposite direction.

### Drawing Text

#### Drawing Text with Pango

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 a `Gdk::GC` object, an x-position, a y-position and the layout itself. TODO: Update this section for Cairo instead of Gdk::GC.

### Drawing Images

#### Drawing Images with Gdk

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;
    }

### Example Application: Creating a Clock with Cairo

Now that we've covered the basics of drawing with Cairo, let's try to put it all together and create a simple application that actually does something. The following example uses Cairo to create a custom `Clock` widget. The clock has a second hand, a minute hand, and an hour hand, and updates itself every second.

Source Code

As before, almost all of the interesting stuff is done in the expose event handler `on_expose_event()`. Before we dig into the expose event handler, notice that the constructor for the `Clock` widget connects a handler function `onSecondElapsed()` to a timer with a timeout period of 1000 milliseconds (1 second). This means that `onSecondElapsed()` will get called once per second. The sole responsibility of this function is to invalidate the window so that &gtkmm; will be forced to redraw it.

Now let's take a look at the code that performs the actual drawing. The first section of `on_expose_event()` should be pretty familiar by now as it's mostly 'boilerplate' code for getting the `Gdk::Window`, creating a `Cairo::Context`, and clipping to the area that we want to re-draw. This example again scales the coordinate system to be a unit square so that it's easier to draw the clock as a percentage of window size so that it will automatically scale when the window size is adjusted. Furthermore, the coordinate system is scaled over and down so that the (0, 0) coordinate is in the very center of the window.

The function `Cairo::Context::paint()` is used here to set the background color of the window. This function takes no arguments and fills the current surface (or the clipped portion of the surface) with the source color currently active. After setting the background color of the window, we draw a circle for the clock outline, fill it with white, and then stroke the outline in black. Notice that both of these actions use the `_preserve` variant to preserve the current path, and then this same path is clipped to make sure than our next lines don't go outside the outline of the clock.

After drawing the outline, we go around the clock and draw ticks for every hour, with a larger tick at 12, 3, 6, and 9. Now we're finally ready to implement the time-keeping functionality of the clock, which simply involves getting the current values for hours, minutes and seconds, and drawing the hands at the correct angles.

## 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:

- 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::TargetEntry` (`std::list<Gtk::TargetEntry>` or `std::vector<Gtk::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

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_string();
      //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_targets()` 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.
    }

### 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

#### 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

## Printing

Printing support is available in &gtkmm; version 2.10 and later.

At the application development level, &gtkmm;'s printing API provides dialogs that are consistent across applications and allows us of Cairo's common drawing API, with Pango-driven text rendering. In the implementation of this common API, platform-specific backends and printer-specific drivers are used.

### PrintOperation

The primary object is `Gtk::PrintOperation`, allocated for each print operation. To handle page drawing connect to its signals, or inherit from it and override the default virtual signal handlers. `PrintOperation` automatically handles all the settings affecting the print loop.

#### Signals

The `PrintOperation::run()` method starts the print loop, during which various signals are emitted:

- `begin_print`: You must handle this signal, because this is where you create and set up a `Pango::Layout` using the provided `Gtk::PrintContext`, and break up your printing output into pages.

- `paginate`: Pagination is potentially slow so if you need to monitor it you can call the `PrintOperation::set_show_progress()` method and handle this signal.

- For each page that needs to be rendered, the following signals are emitted:

  - `request_page_setup`: Provides a `PrintContext`, page number and `Gtk::PageSetup`. Handle this signal if you need to modify page setup on a per-page basis.

  - `draw_page`: You must handle this signal, which provides a `PrintContext` and a page number. The `PrintContext` should be used to create a `Cairo::Context` into which the provided page should be drawn. To render text, iterate over the `Pango::Layout` you created in the `begin_print` handler.

- `end_print`: A handler for it is a safe place to free any resources related to a `PrintOperation`. If you have your custom class that inherits from `PrintOperation`, it is naturally simpler to do it in the destructor.

- `done`: This signal is emitted when printing is finished, meaning when the print data is spooled. Note that the provided `Gtk::PrintOperationResult` may indicate that an error occurred. In any case you probably want to notify the user about the final status.

- `status_changed`: Emitted whenever a print job's status changes, until it is finished. Call the `PrintOperation::set_track_print_status()` method to monitor the job status after spooling. To see the status, use `get_status()` or `get_status_string()`.

Reference

### Page setup

The `PrintOperation` class has a method called `set_default_page_setup()` which selects the default paper size, orientation and margins. To show a page setup dialog from your application, use the `Gtk::run_page_setup_dialog()` method, which returns a `Gtk::PageSetup` object with the chosen settings. Use this object to update a `PrintOperation` and to access the selected `Gtk::PaperSize`, `Gtk::PageOrientation` and printer-specific margins.

You should save the chosen `Gtk::PageSetup` so you can use it again if the page setup dialog is shown again.

For instance,

    //Within a class that inherits from Gtk::Window and keeps m_refPageSetup and m_refSettings as members...
    Glib::RefPtr<Gtk::PageSetup> new_page_setup = Gtk::run_page_setup_dialog(*this, m_refPageSetup, m_refSettings);
    m_refPageSetup = new_page_setup;

Reference

The Cairo coordinate system, in the `draw_page` handler, is automatically rotated to the current page orientation. It is normally within the printer margins, but you can change that via the `PrintOperation::set_use_full_page()` method. The default measurement unit is device pixels. To select other units, use the `PrintOperation::set_unit()` method.

### Rendering text

Text rendering is done using Pango. The `Pango::Layout` object for printing should be created by calling the `PrintContext::create_pango_layout()` method. The `PrintContext` object also provides the page metrics, via `get_width()` and `get_height()`. The number of pages can be set with `PrintOperation::set_n_pages()`. To actually render the Pango text in `on_draw_page`, get a `Cairo::Context` with `PrintContext::get_cairo_context()` and show the `Pango::LayoutLine`s that appear within the requested page number.

See an example of exactly how this can be done.

### Asynchronous operations

By default, `PrintOperation::run()` returns when a print operation is completed. If you need to run a non-blocking print operation, call `PrintOperation::set_allow_async()`. Note that `set_allow_async()` is not supported on all platforms, however the `done` signal will still be emitted.

`run()` may return `PRINT_OPERATION_RESULT_IN_PROGRESS`. To track status and handle the result or error you need to implement signal handlers for the `done` and `status_changed` signals:

For instance,

    // in class ExampleWindow's method...
    Glib::RefPtr<PrintOperation> op = PrintOperation::create();
    // ...set up op...
    op->signal_done().connect(sigc::bind(sigc::mem_fun(*this, &ExampleWindow::on_printoperation_done), op));
    // run the op

Second, check for an error and connect to the `status_changed` signal. For instance:

    void ExampleWindow::on_printoperation_done(Gtk::PrintOperationResult result, const Glib::RefPtr<PrintOperation>& op)
    {
      if (result == Gtk::PRINT_OPERATION_RESULT_ERROR)
        //notify user
      else if (result == Gtk::PRINT_OPERATION_RESULT_APPLY)
        //Update PrintSettings with the ones used in this PrintOperation

      if (! op->is_finished())
        op->signal_status_changed().connect(sigc::bind(sigc::mem_fun(*this, &ExampleWindow::on_printoperation_status_changed), op));
    }

Finally, check the status. For instance,

    void ExampleWindow::on_printoperation_status_changed(const Glib::RefPtr<PrintFormOperation>& op)
    {
      if (op->is_finished())
        //the print job is finished
      else
        //get the status with get_status() or get_status_string()

      //update UI
    }

### Export to PDF

The 'Print to file' option is available in the print dialog, without the need for extra implementation. However, it is sometimes useful to generate a pdf file directly from code. For instance,

    Glib::RefPtr<Gtk::PrintOperation> op = Gtk::PrintOperation::create();
    // ...set up op...
    op->set_export_filename("test.pdf");
    Gtk::PrintOperationResult res = op->run(Gtk::PRINT_OPERATION_ACTION_EXPORT);

### Extending the print dialog

You may add a custom tab to the print dialog:

- Set the title of the tab via `PrintOperation::set_custom_tab_label()`, create a new widget and return it from the `create_custom_widget` signal handler. You'll probably want this to be a container widget, packed with some others.

- Get the data from the widgets in the `custom_widget_apply` signal handler.

Although the `custom_widget_apply` signal provides the widget you previously created, to simplify things you can keep the widgets you expect to contain some user input as class members. For example, let's say you have a `Gtk::Entry` called `m_Entry` as a member of your `CustomPrintOperation` class:

    Gtk::Widget* CustomPrintOperation::on_create_custom_widget()
    {
      set_custom_tab_label("My custom tab");

      Gtk::HBox* hbox = new Gtk::HBox(false, 8);
      hbox->set_border_width(6);

      Gtk::Label* label = Gtk::manage(new Gtk::Label("Enter some text: "));
      hbox->pack_start(*label, false, false);
      label->show();

      hbox->pack_start(m_Entry, false, false);
      m_Entry.show();

      return hbox;
    }

    void CustomPrintOperation::on_custom_widget_apply(Gtk::Widget* /* widget */)
    {
      Glib::ustring user_input = m_Entry.get_text();
      //...
    }

The example in examples/book/printing/advanced demonstrates this.

### Preview

The native GTK+ print dialog has a preview button, but you may also start a preview directly from an application:

    // in a class that inherits from Gtk::Window...
    Glib::RefPtr<PrintOperation> op = PrintOperation::create();
    // ...set up op...
    op->run(Gtk::PRINT_OPERATION_ACTION_PREVIEW, *this);

On Unix, the default preview handler uses an external viewer program. On Windows, the native preview dialog will be shown. If necessary you may override this behaviour and provide a custom preview dialog. See the example located in /examples/book/printing/advanced.

### Example

#### Simple

The following example demonstrates how to print some input from a user interface. It shows how to implement `on_begin_print` and `on_draw_page`, as well as how to track print status and update the print settings.

##### Printing - Simple

Source Code

## Recently Used Documents

Recent Files support is available in &gtkmm; version 2.10 and later

&gtkmm; provides an easy way to manage recently used documents. The classes involved in implementing this functionality are `RecentManager`, `RecentChooserDialog`, `RecentChooserMenu`, `RecentChooserWidget`, and `RecentFilter`.

Each item in the list of recently used files is identified by its URI, and can have associated metadata. The metadata can be used to specify how the file should be displayed, a description of the file, its mime type, which application registered it, whether it's private to the registering application, and several other things.

### RecentManager

`RecentManager` acts as the central database of recently used files. You use this class to register new files, remove files from the list, or look up recently used files.

You can create a new `RecentManager`, but you'll most likely just want to use the default one. You can get a reference to the default `RecentManager` with `get_default()`.

#### Adding Items to the List of Recent Files

To add a new file to the list of recent documents, in the simplest case, you only need to provide the URI. For example:

    Glib::RefPtr<Gtk::RecentManager> recent_manager = Gtk::RecentManager::get_default();
    recent_manager->add_item(uri);

If you want to register a file with metadata, you can pass a `RecentManager::Data` parameter to `add_item()`. The metadata that can be set on a particular file item is as follows:

- `app_exec`: The command line to be used to launch this resource. This string may contain the "f" and "u" escape characters which will be expanded to the resource file path and URI respectively

- `app_name`: The name of the application that registered the resource

- `description`: A short description of the resource as a UTF-8 encoded string

- `display_name`: The name of the resource to be used for display as a UTF-8 encoded string

- `groups`: A list of groups associated with this item. Groups are essentially arbitrary strings associated with a particular resource. They can be thought of as 'categories' (such as "email", "graphics", etc) or tags for the resource.

- `is_private`: Whether this resource should be visible only to applications that have registered it or not

- `mime_type`: The MIME type of the resource

In addition to adding items to the list, you can also look up items from the list and modify or remove items.

#### Looking up Items in the List of Recent Files

To look up recently used files, `RecentManager` provides several functions. To look up a specific item by its URI, you can use the `lookup_item()` function, which will return a `RecentInfo` class. If the specified URI did not exist in the list of recent files, the `RecentInfo` object will be invalid. `RecentInfo` provides an implementation for `operator bool()` which can be used to test for validity. For example:

    Gtk::RecentInfo info = recent_manager->lookup_item(uri);
    if (info)
    {
      // item was found
    }

A `RecentInfo` object is essentially an object containing all of the metadata about a single recently-used file. You can use this object to look up any of the properties listed above. FIXME - add cross-reference.

If you don't want to look for a specific URI, but instead want to get a list of all recently used items, `RecentManager` provides the `get_items()` function. The return value of this function can be assigned to any standard C++ container (e.g. `std::vector`, `std::list`, etc) and contains a list of all recently-used files up to a user-defined limit (FIXME: what's the default limit?). The following code demonstrates how you might get a list of recently-used files:

    std::vector<Gtk::RecentInfo> info_list = recent_manager->get_items();

The limit on the number of items returned can be set by `set_limit()`, and queried with `get_limit()`.

#### Modifying the List of Recent Files

There may be times when you need to modify the list of recent files. For instance, if a file is moved or renamed, you may need to update the file's location in the recent files list so that it doesn't point to an incorrect location. You can update an item's location by using `move_item()`.

In addition to changing a file's URI, you can also remove items from the list, either one at a time or by clearint them all at once. The former is accomplished with `remove_item()`, the latter with `purge_items()`.

The functions `move_item()`, `remove_item()` and `purge_items()` have no effect on the actual files that are referred to by the URIs, they only modify the list of recent files.

### RecentChooser

Recent Files support is available in &gtkmm; version 2.10 and later

`RecentChooser` is an interface that can be implemented by widgets displaying the list of recently used files. &gtkmm; provides three built-in implementations for choosing recent files: `RecentChooserWidget`, `RecentChooserDialog`, and `RecentChooserMenu`.

`RecentChooserWidget` is a simple widget for displaying a list of recently used files. `RecentChooserWidget` is the basic building block for `RecentChooserDialog`, but you can embed it into your user interface if you want to.

The last class that implements the `RecentChooser` interface is `RecentChooserMenu`. This class allows you to list recently used files as a menu.

#### Simple RecentChooserWidget example

Shown below is a simple example of how to use the `RecentChooserDialog` class in a program. This simple program has a menubar with a "Recent Files Dialog" menu item. When you select this menu item, a dialog pops up showing the list of recently used files.

If this is the first time you're using a program that uses the Recent Files framework, the dialog may be empty at first. Otherwise it should show the list of recently used documents registered by other applications.

After selecting the Recent Files Dialog menu item, you should see something similar to the following window.

Source Code

The constructor for `ExampleWindow` creates the menu using `UIManager` (see for more information). It then adds the menu and the toolbar to the window.

#### Filtering Recent Files

For any of the `RecentChooser` classes, if you don't wish to display all of the items in the list of recent files, you can filter the list to show only those that you want. You can filter the list with the help of the `RecentFilter` class. This class allows you to filter recent files by their name (`add_pattern()`), their mime type (`add_mime_type()`), the application that registered them (`add_application()`), or by a custom filter function (`add_custom()`). It also provides the ability to filter based on how long ago the file was modified and which groups it belongs to.

After you've created and set up the filter to match only the items you want, you can apply a filter to a chooser widget with the `RecentChooser::add_filter()` function.

## Plugs and Sockets

### Overview

From time to time, it may be useful to be able to embed a widget from another application within your application. &gtkmm; allows you to do this with the `Gtk::Socket` and `Gtk::Plug` classes. It is not anticipated that very many applications will need this functionality, but in the rare case that you need to display a widget that is running in a completely different process, these classes can be very helpful.

The communication between a `Socket` and a `Plug` follows the XEmbed protocol. This protocol has also been implemented in other toolkits (e.g. Qt), which allows the same level of integration when embedding a Qt widget in GTK+ or vice versa.

The way that `Sockets` and `Plugs` work together is through their window ids. Both a `Socket` and a `Plug` have IDs that can be retrieved with their `get_id()` member functions. The use of these IDs will be explained below in .

#### Sockets

A `Socket` is a special kind of container widget that provides the ability to embed widgets from one process into another process in a way that is transparent to the user.

#### Plugs

A `Plug` is a special kind of Window that can be plugged into a `Socket`. Besides the normal properties and methods of `Gtk::Window`, a `Plug` provides a constructor that takes the ID of a `Socket`, which will automatically embed the `Plug` into the `Socket` that matches that ID.

Since a `Plug` is just a special type of `Gtk::Window` class, you can add containers or widgets to it like you would to any other window.

#### Connecting Plugs and Sockets

After a `Socket` or `Plug` object is realized, you can obtain its ID with its `get_id()` function. This ID can then be shared with other processes so that other processes know how to connect to eachother.

There are two basic strategies that can be used:

- Create a `Socket` object in one process and pass the ID of that `Socket` to another process so that it can create a `Plug` object by specifying the given `Socket` ID in its constructor. There is no way to assign a `Plug` to a particular `Socket` after creation, so you must pass the `Socket` ID to the `Plug`'s constructor.

- Create a `Plug` independantly from any particular `Socket` and pass the ID of the `Plug` to other processes that need to use it. The ID of the `Plug` can be associated with a particular `Socket` object using the `Socket::add_id()` function. This is the approach used in the example below.

### Plugs and Sockets Example

The following is a simple example of using sockets and plugs. The method of communication between processes is deliberately kept very simple: The `Plug` writes its ID out to a text file named `plug.id` and the process with the socket reads the ID from this files. In a real program, you may want to use a more sophisticated method of inter-process communication.

Source Code

This example creates two executable programs: `socket` and `plug`. The idea is that `socket` has an application window that will embed a widget from the `plug` program. The way this example is designed, `plug` must be running first before starting `socket`. To see the example in action, execute the following commands in order from within the example directory:

Start the `plug` program and send it to the background (or just use a different terminal).

    $ ./plug &

After which you should see something like the following:

    The window ID is: 69206019

Then start the `socket` program:

    $ ./socket

After starting `socket`, you should see the following output in the terminal:

    I've been embedded.
    A plug was added

The first line of output is from `plug`, after it has been notified that it has been embedded inside of a `Socket`. The second line was emitted by `socket` in response to its `plug_added` signal. If everything was done as described above, the `socket` window should look roughly like the following:

If for some reason the `Socket` couldn't attach the `Plug`, the window would look something like this:

## 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 using its `disconnect()` method:

    my_connection.disconnect();

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" << std::endl; 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

### Monitoring I/O

TODO: This is now in Glib, not Gdk.

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 Glib::Main::SignalInput::connect(const SlotType& sd, int source,
                                        Glib::InputCondition 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_INPUT_READ - Call your method when there is data ready for reading on your file descriptor.

- GDK_INPUT_WRITE - Call your method when the file descriptor is ready for writing.

- GDK_INPUT_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 example follows. To use the example just execute it from a terminal; it doesn't create a window. It will create a pipe named `testfifo` in the current directory. Then start another shell and execute `echo "Hello" > testfifo`. The example will print each line you enter until you execute `echo "Q" > testfifo`.

Source Code

### Idle Functions

If you want to specify a method that gets called when nothing else is happening, use the following:

    sigc::connection  Glib::Main::SignalIdle::connect(const 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_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

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()` function 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 objects of type `MyWidget` are 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 the `MyWidget` object.

&gtkmm; also provides the `set_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_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 `Gdk::Pixmap`s and `Pango::Font`s, 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.

### Headers and Linking

To use libglade, you must include the header file, like so:

    #include <libglademm.h>

You must also link to the libglademm library. For instance, you can add libglademm-2.4 to your list of pkg-config modules, as described in the Headers and Linking section for gtkmm.

### 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.

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_widget_derived("DialogBasic", pDialog);

Your derived class must have a constructor that takes a pointer to the underlying C type, and the `Gnome::Glade::Xml` instance. All relevant classes of &gtkmm; typedef their underlying C type as `BaseObjectType` (`Gtk::Dialog` typedefs `BaseObjectType` as GtkDialog, for 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-European languages such as Chinese and right-to-left languages such as Arabic. An appropriately-written and translated &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, sometimes abbreviated as `l10n`, provides translated text for other languages, based on that source code.

The main activity in the internationalization process is finding strings seen by users and marking them for translation. You do not need to do it all at once - if you set up the necessary project infrastructure correctly then your application will work normally regardless of how many strings you've covered.

String literals should be typed in the source code in English, but surrounded by a macro. The gettext (or intltool) utility can then extract the marked strings for tramslation, and substitute the translated text at runtime.

### Preparing your project

In the instructions below we will assume that you will not be using gettext directly, but intltool, which was written specifically for `GNOME`. intltool uses `gettext()`, which extracts strings from source code, but intltool can also combine strings from other files, for example from desktop menu details, and GUI resource files such as Glade files, into standard gettext `.pot/.po` files.

We also assume that you are using autotools (e.g. automake and autoconf) to build your project, and that you are using `./autogen.sh` from gnome-common, which, among other things, takes care of some intltool initialization.

Create a sub-directory named `po` in your project's root directory. This directory will eventually contain all of your translations. Within it, create a file named `LINGUAS` and a file named `POTFILES.in`. It is common practice to also create a `ChangeLog` file in the `po` directory so that translators can keep track of translation changes.

`LINGUAS` contains an alphabetically sorted list of codes identifying the languages for which your program is translated (comment lines starting with a `#` are ignored). Each language code listed in the `LINGUAS` file must have a corresponding `.po` file. So, if your program has German and Japanese translations, your `LINGUAS` file would look like this:

    # keep this file sorted alphabetically, one language code per line
    de
    ja

(In addition, you'd have the files `ja.po` and `de.po` in your `po` directory which contain the German and Japanese translations, respectively.)

`POTFILES.in` is a list of paths to all files which contain strings marked up for translation, starting from the project root directory. So for example, if your project sources were located in a subdirectory named `src`, and you had two files that contained strings that should be translated, your `POTFILES.in` file might look like this:

    src/main.cc
    src/other.cc

If you are using gettext directly, you can only mark strings for translation if they are in source code file. However, if you use intltool, you can mark strings for translation in a variety of other file formats, including Glade UI files, xml, .desktop files and several more. So, if you have designed some of the application UI in Glade then also add your `.glade` files to the list in `POTFILES.in`.

Now that there is a place to put your translations, you need to initialize intltool and gettext. Add the following code to your `configure.ac`, substituting 'programname' with the name of your program:

    IT_PROG_INTLTOOL([0.35.0])

    GETTEXT_PACKAGE=programname
    AC_SUBST(GETTEXT_PACKAGE)
    AC_DEFINE_UNQUOTED([GETTEXT_PACKAGE], ["$GETTEXT_PACKAGE"],
                       [The domain to use with gettext])
    AM_GLIB_GNU_GETTEXT

    PROGRAMNAME_LOCALEDIR=[${datadir}/locale]
    AC_SUBST(PROGRAMNAME_LOCALEDIR)

This `PROGRAMNAME_LOCALEDIR` variable will be used later in the `Makefile.am` file, to define a macro that will be used when you initialize gettext in your source code.

In the top-level Makefile.am:

- Add `po` to the `SUBDIRS` variable. Without this, your translations won't get built and installed when you build the program

- Define `INTLTOOL_FILES` as:

      INTLTOOL_FILES = intltool-extract.in \
                       intltool-merge.in \
                       intltool-update.in

- Add `INTLTOOL_FILES` to the `EXTRA_DIST` list of files. This ensures that when you do a `make dist`, these commands will be included in the source tarball.

- Update your `DISTCLEANFILES`:

      DISTCLEANFILES = ... intltool-extract \
                       intltool-merge \
                       intltool-update \
                       po/.intltool-merge-cache

In your `src/Makefile.am`, update your `AM_CPPFLAGS` to add the following preprocessor macro definition:

    AM_CPPFLAGS = ... -DPROGRAMNAME_LOCALEDIR=\"${PROGRAMNAME_LOCALEDIR}\"

This macro will be used when you initialize `gettext` in your source code.

### Marking strings for translation

String literals should be typed in the source code in English, 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.

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.

However, Glib defines `gettext()` support macros which are shorter wrappers in an easy-to-use form. To use these macros, include `<glibmm/i18n.h>`, and then, for example, substitute:

    display_message("Getting ready for i18n.");

with:

    display_message(_("Getting ready for i18n."));

For reference, it is possible to generate a file which contains all strings which appear in your code, even if they are not marked for translation, together with file name and line number references. To generate such a file named `my-strings`, execute the following command, within the source code directory:

    xgettext -a -o my-strings --omit-header *.cc *.h

Finally, to let you program use the translation for the current locale, add this code to the beginning of your `main.cc` file, to initialize gettext.

    bindtextdomain(GETTEXT_PACKAGE, PROGRAMNAME_LOCALEDIR);
    bind_textdomain_codeset(GETTEXT_PACKAGE, "UTF-8");
    textdomain(GETTEXT_PACKAGE);

#### How gettext works

intltool / xgettext script extracts the strings and puts them in a `mypackage.pot` file. The translators of your application create their translations by first copying this `.pot` file to a `localename.po` file. 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 regenerated `.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, for example `/usr/share/locale/`.

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 of a particular string. If none is found, the original string is used.

#### Testing and adding translations

To convince yourself that you've done well, you may wish to add a translation for a new locale. In order to do that, go to the `po` subdirectory of your project and execute the following command:

    intltool-update --pot

That will create a file named `programname.pot`. Now copy that file to `languagecode.po`, such as `de.po` or `hu.po`. Also add that language code to `LINGUAS`. The `.po` file contains a header and a list of English strings, with space for the translated strings to be entered. Make sure you set the encoding of the `.po` file (specified in the header, but also as content) to `UTF-8`.

It's possible that certain strings will be marked as `fuzzy` in the `.po` file. These translations will not substitute the original string. To make them appear, simply remove the `fuzzy` tag.

#### Resources

More information about what lies behind the internationalization and localization process is presented and demonstrated in:

- Internationalizing GNOME applications

- Intltool README

- How to use GNOME CVS as a Translator

- gettext manual

- `gtkmm_hello` example package

- `gnomemm_hello` example package

### 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::ustring`s 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 (&copy;).

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

### 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 Penrose triangle.

##### Custom Widget

Source Code

## 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::signal`s, 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_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 `gtkmm` module in GNOME cvs. See

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, and a future version of &gtkmm; might possibly use that instead.

Reference

A smartpointer acts much like a normal pointer. Here are a few examples.

### Copying

You can copy `RefPtr`s, 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 = Gtk::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, `RefPtr`s 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::ptr_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()`.

`sigc::ptr_fun()` generates a `sigc::slot`. 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::ptr_fun()` generates a slot for a standalone function or static method. `sigc::mem_fun()` generates a slot for a member method of a particular instance.

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 made 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, Gtk::DirectionType> 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 Gtk::DirectionType). 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, Gtk::DirectionType, 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_pressed_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_pressed_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_button_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.

#### Signal Handler sequence

By default, your signal handlers are called after any previously-connected signal handlers. However, this can be a problem with the X Event signals. For instance, the existing signal handlers, or the default signal handler, might return true to stop other signal handlers from being called. To specify that your signal handler should be called before the other signal handlers, so that will always be called, you can specify `false` for the optional `after` parameter. For instance,

    button.signal_button_press_event().connect( sigc::ptr_fun(&on_mywindow_button_press), false );

## 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 int, 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.

## Drawing With GDK

The GDK drawing API described here is now deprecated, in favour of Cairo. See the DrawingArea chapter for information about the Cairo API.

Gdk graphics contexts (`Gdk::GC`) 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.

Graphics contexts are central to drawing with Gdk, because nearly all Gdk drawing functions and many Pango functions take a `Gdk::GC` object as an argument. So although Cairo has largely superceded many Gdk drawing functions, you're still likely to run into `Gdk::GC` objects quite often, so it's important to know what they are and how they're used.

## Working with CVS

If you are interested in helping out with the development of &gtkmm;, or fixing a bug in &gtkmm;, you'll probably need to build the development version of &gtkmm;. You don't want to install a development version over your stable version, you want to install it alongside your existing &gtkmm; installation.

The easiest way to do this is using jhbuild. jhbuild is a program that makes building GNOME software much easier by calculating dependencies and building things in the correct order. This section will give a brief explanation of how to set up jhbuild to build and install &gtkmm; from CVS. For up-to-date information on jhbuild, please refer to the jhbuild website. If you need assistance using jhbuild, you should ask for help on the gnome-love mailing list.

Note that to build &gtkmm; from CVS, you'll need to build all of its dependencies from CVS as well. jhbuild makes this easier than it would normally be, but it will take quite a while to build and install them all.

### Setting up jhbuild

To set up jhbuild, follow the basic installation instructions from the jhbuild manual. After you've gotten jhbuild installed, you should copy the sample jhbuild configuration file into your home directory by executing the following command from the jhbuild directory: `$ cp sample.jhbuildrc ~/.jhbuildrc`

The &gtkmm; module is defined in the GNOME moduleset (i.e. `gnome-2.xx.modules`, so edit your `.jhbuildrc` file and set your moduleset setting to the latest version of GNOME like so:

    moduleset = 'gnome-2.16'

After setting the correct moduleset, you need to tell jhbuild which module or modules to build. To build &gtkmm; and all of its dependencies, set `modules` like so:

    modules = [ 'gtkmm', ]

You can build all GNOME C++ modules by setting the `modules` variable to the meta-package named `meta-gnome-c++` or build all of the core GNOME modules with `meta-gnome-desktop`. The `modules` variable specifies which modules that will be built when you don't explicitly specify anything on the command line. You can always build a different moduleset later by specifying it on the commandline (e.g. `jhbuild build gtkmm`).

Note that the GNOME moduleset is most likely set up to build the branch of &gtkmm; that will be included with that GNOME release, so it may not build &gtkmm; HEAD by default. The branch name is specified in the `revision` attribute of the `cvsmodule` element. In order to build the HEAD version of &gtkmm;, edit your moduleset file and delete the `revision` attribute.

#### Setting a prefix

By default, jhbuild's configuration is configured to install all software built with jhbuild under the `/opt/gnome2` prefix. You can choose a different prefix, but it is recommended that you keep this prefix different from other software that you've installed (don't set it to `/usr`!) This way you can keep using your stable versions without conflict and use the CVS versions when you want to. You may want to choose a prefix that your user account has write access to so that you don't need to run jhbuild as `root`.

### Installing and Using the CVS version of &gtkmm;

Once you've configured jhbuild as described above, building &gtkmm; should be relatively straightforward. The first time you run jhbuild, you should run the following sequence of commands to ensure that jhbuild has the required tools and verify that it is set up correctly:

    $ jhbuild bootstrap
    $ jhbuild sanitycheck

#### Installing &gtkmm; with jhbuild

If everything worked correctly, you should be able to build &gtkmm; and all of its dependencies from CVS by executing `jhbuild build` (or, if you didn't specify &gtkmm; in the `modules` variable, with the command `jhbuild build gtkmm`).

This command will build and install a series of modules and will probably take quite a long time the first time through. After the first time, however, it should go quite a bit faster since it only needs to rebuild files than changed since the last build. Alternatively, after you've built and installed &gtkmm; the first time, you can rebuild &gtkmm; by itself (without rebuilding all of its dependencies) with the command `jhbuild buildone gtkmm`.

#### Using the CVS version of &gtkmm;

After you've installed the CVS version of &gtkmm;, you're ready to start using and experimenting with it. In order to use the new version of &gtkmm; you've just installed, you need to set some environment variables so that your `configure` script knows where to find the new libraries. Fortunately, jhbuild offers an easy solution to this problem. Executing the command `jhbuild shell` will start a new shell with all of the correct environment variables set. Now if you re-configure and build your project just as you usually do, it should link against the newly installed libraries. To return to your previous environment, simply exit the jhbuild shell.

Once you've built your software, you'll need to run your program within the jhbuild environment as well. To do this, you can again use the `jhbuild shell` command to start a new shell with the jhbuild environment set up. Alternatively, you can execute a one-off command in the jhbuild environment using the following command: `jhbuild run command-name`. In this case, the command will be run with the correct environment variables set, but will return to your previous environment after the program exits.

## Wrapping C Libraries with gmmproc

gtkmm uses the gmmproc tool to generate most of its source code, using .defs files that define the APIs of GObject-based libraries. So it's quite easy to create additional gtkmm-style wrappers of other glib/GObject-based libraries.

This involves a variety of tools and some copying of existing build files, but it does at least work, and has been used successfully by several projects.

### The build structure

Generation of the source code for a gtkmm-style wrapper API requires use of tools such as gmmproc and generate_wrap_init.pl. In theory you could write your own build files to use these appropriately, but in practice it's usually easier to simply copy an existing project and modify it for your needs. Note however, that there is plenty of scope for improvement in the build structure that we use, so try to copy the latest version, and feel free to suggest improvements to make it more generic.

For instance, let's pretend that we are wrapping a C library called libexample. It provides a GObject-based API with types named, for instance, ExampleThing and ExampleStuff.

#### Copying an existing project

Typically our wrapper library would be called libexamplemm. We can start by copying an existing *mm library, such as libgdamm, after checking it out from cvs.

    $ cvs -z3 co gnomemm/libgdamm
    $ cp -r gnomemm/libgdamm libsomethingmm

This provides a directory structure for the source .hg and .ccg files and the generated .h and .cc files, with Makefile.am fragments that can specify the various files in use, in terms of generic Makefile.am variables. The directory structure usually looks like this, after we have renamed the directories appropriately:

- libsomethingmm: The top-level directory.

  - libsomething: Contains the main include file and the pkg-config .pc file.

    - src: Contains .hg and .ccg source files.

    - libsomethingmm: Contains generated and hand-written .h and .cc files.

      - private: Contains generated *_p.h files.

As well as renaming the directories, we should rename some of the source files. For instance:

    $ mv libsomething/libgdamm-2.0.pc.in libsomething/libsomethingmm-1.0.pc.in
    $ mv libsomething/libgdammconfig.h.in libsomething/libsomethingmmconfig.h.in
    $ mv libsomething/libgdamm.h libsomething/libsomethingmm.h
    $
    $ mv libsomething/src/libgda.defs libsomething/src/libsomething.defs
    $ mv libsomething/src/libgda_enums.defs libsomething/src/libsomething_enums.defs
    $ mv libsomething/src/libgda_methods.defs libsomething/src/libsomething_methods.defs
    $ mv libsomething/src/libgda_others.defs libsomething/src/libsomething_others.defs
    $ mv libsomething/src/libgda_signals.defs libsomething/src/libsomething_signals.defs
    $ mv libsomething/src/libgda_vfuncs.defs libsomething/src/libsomething_vfuncs.defs
    $ mv libsomething/src/libgda_docs.xml libsomething/src/libsomething_docs.xml
    $ mv libsomething/src/libgda_docs_override.xml libsomething/src/libsomething_docs_override.xml

A multiple-file renaming tool, such as prefixsuffix might help with this. We will provide the contents of these files later.

Note that files ending in .in will be used to generate files with the same name but without the .in suffix, by replacing some variables with actual values during the configure stage.

#### Modifying build files

Now we edit the files to adapt them to to our needs. You might prefer to use a multiple-file search-replace too for this, such as regexxer.

##### autogen.sh

For instance, in autogen.sh:

- PKG_NAME must contain the new package name, such as libexamplemm.

- The test script lines must check for appropriate directory names, such as $srcdir/libsomething/src.

##### configure.in

In configure.in (or configure.ac in newer projects),

- The AC_INIT() line must mention a file in our library. We can edit this later if we don't yet know the names of any of the files that we will create.

- The PACKAGE variable must be changed to the correct name of the project, such as libsomethingmm.

- The version numbers should be reset to something small, such as 0.0.1. You may want to rename the version variables if they are not something generic. For instance, we would rename LIBGDAMM_MAJOR_VERSION to LIBSOMETHINGMM_MAJOR_VERSION or LIBGENERICMM_MAJOR_VERSION.

- The AM_CONFIG_HEADER() line must mention the correctly named config header file.

- The PKG_CHECK_MODULES() line must be modified to check for the correct dependencies. For instance, it might be changed to PKG_CHECK_MODULES(LIBGENERICMM, gtkmm-2.4 >= 2.6.0 libsomething-1.0 >= 1.0.0).

- The AC_OUTPUT() block must mention the correct directory names, as described above.

- The m4 script to generate doxygen input directory paths must mention the correct directory.

##### Makefile.am files

Next we must adapt the various Makefile.am files:

- The top-level Makefile.am must mention the correct child directory in the SUBDIRS variable.

- The libexample/Makefile.am must mention:

  - The correct child directories in the SUBDIRS variable.

  - The correct filenames in EXTRA_DIST.

  - The correct filenames in *_includedir, *_include_HEADERS, *_configdir, and *_config_DATA.

- In libexample/libexamplemm/Makefile.am we must mention the correct names in the generic variables that are used elsewhere in the build system:

  - sublib_name: The name of the library, such as libsomethingmm.

  - sublib_libname: The versioned name of the library, such as libsomethingmm-1.0

  - sublib_namespace: The name of the C++ namespace to use for this library, such as Something.

  - files_defs: The list of .defs and *docs*.xml files.

  - The lib_LTLIBRARIES variable must mention the correct library name, and this library name must be used to form the _SOURCES, _LDFLAGS, and _LIBADD variable names.

- In libexample/libexamplemm/private/Makefile.am, private_includedir must contain the correct path.

- In examples/Makefile.am_fragment, local_libgenericmm_lib and all_includes must contain the correct paths.

- In libexample/src/Makefile.am we must set some more generic variables:

  - sublib_name: The name of the library, as in libexample/libexamplemm/Makefile.am.

  - sublib_namespace: The name of the C++ namespace, as in libexample/libexamplemm/Makefile.am

  - sublib_parentdir: The name of the directory containing the generated files, such as libexamplemm.

  - files_defs: The list of .defs and *docs*.xml files.

- In build_shared/Makefile_gensrc.am_fragment, you should remove the --namespace=Gnome option from the gen_wrap_init_args variable if your namespace will not be under the Gnome namespace. This should be the only place that you need to edit the generic build_shared/ files.

##### Creating .hg and .ccg files

We should now create our first .hg and .ccg files, to wrap one of the objects in the C library. We will delete any existing .hg and .ccg files:

    $ rm -rf libexample/src/*.hg
    $ rm -rf libexample/src/*.ccg

and create new files:

    $ touch libexample/src/thing.hg
    $ touch libexample/src/thing.ccg

We must mention all of our .hg and .ccg files in the libexample/src/Makefile_list_of_hg.am_fragment file, in the files_hg variable.

Any extra non-generated .h and .cc source files may be placed in libexample/libexamplemm/ and mentioned in libexample/libexamplemm/Makefile.am, in the files_extra_h and files_extra_cc variables.

In the .hg and .ccg files section you can learn about the syntax used in these files.

### Generating the .defs files.

The .defs file are text files, in a lisp format, that describe the API of a C library, including its

- objects (GObjects, widgets, interfaces, boxed-types and plain structs)

- functions

- enums

- signals

- properties

- vfuncs

At the moment, we have separate tools for generating different parts of these .defs, so we split them up into separate files. For instance, in gtkmm/gtk/src, you will find these files:

- gtk.defs: Includes the other files.

- gtk_methods.defs: Objects and functions.

- gtk_enums.defs: Enums.

- gtk_signals.def: Signals and properties.

- gtk_vfuncs.defs: vfuncs (function pointer member fields in structs), written by hand.

#### Generating the methods .defs

This .defs file describes objects and their functions. It is generated by the h2defs.py script which you can find in pygtk's codegen directory. For instance,

    $ ./h2defs.py /usr/include/gtk-2.0/gtk/*.h > gtk_methods.defs

#### Generating the enums .defs

This .defs files describes enum types and their possible values. It is generated by the enums.pl script which you can find in glibmm's tools directory. For instance,

    $ ./enum.pl /usr/include/gtk-2.0/gtk/*.h > gtk_enums.defs

#### Generating the signals and properties .defs

This .defs file describes signals and properties. It is generated by the special extra_defs utility that is in every wrapping project, such as gtkmm/tools/extra_defs_gen/. For instance ``

    $ cd tools/extra_defs_gen
    $ ./generate_extra_defs > gtk_signals.defs

You must edit the source code of your own extra_defs_gen tool in order to generate the .defs for the C types that you wish to wrap. Start by renaming the file:

    $ cd tools/extra_defs_gen
    $ mv generate_defs_gda.cc generate_defs_example.cc

Then edit the Makefile.am so that it mentions the new file name, and edit the new .cc file to specify the correct types. For instance, your main() function might look like this:

    #include <libsomething.h>

    int main (int argc, char *argv[])
    {
        libexample_init(argc, argv);

        std::cout << get_defs(EXAMPLE_TYPE_SOMETHING)
                  << get_defs(EXAMPLE_TYPE_THING);
        return 0;
    }

#### Writing the vfuncs .defs

### The .hg and .ccg files

The .hg and .ccg source files are very much like .h anc .cc C++ source files, but they contain extra macros, such as _CLASS_GOBJECT() and _WRAP_METHOD(), from which gmmproc generates appropriate C++ source code, usually at the same position in the header. Any additional C++ source code will be copied verbatim into the corresponding .h or .cc file.

A .hg file will typically include some headers and then declare a class, using some macros to add API or behaviour to this class. For instance, gtkmm's button.hg looks roughly like this:

    #include <gtkmm/bin.h>
    #include <gtkmm/stockid.h>
    _DEFS(gtkmm,gtk)
    _PINCLUDE(gtkmm/private/bin_p.h)

    namespace Gtk
    {

    class Button : public Bin
    {
      _CLASS_GTKOBJECT(Button,GtkButton,GTK_BUTTON,Gtk::Bin,GtkBin)
    public:

      _CTOR_DEFAULT
      explicit Button(const Glib::ustring& label, bool mnemonic = false);
      explicit Button(const StockID& stock_id);

      _WRAP_METHOD(void set_label(const Glib::ustring& label), gtk_button_set_label)

      ...

      _WRAP_SIGNAL(void clicked(), "clicked")

      ...

      _WRAP_PROPERTY("label", Glib::ustring)
    };

    } // namespace Gtk

The macros in this example do the following:

- _DEFS(): Specifies the destination directry for generated sources, and the name of the main .defs file that gmmproc should parse.

- _PINCLUDE(): Tells gmmproc to include a header from the generated private/button_p.h file.

- _CLASS_GTKOBJECT(): Tells gmmproc to add some typedefs, constructors, and standard methods to this class, as appropriate when wrapping a GtkObject-derived type.

- _WRAP_METHOD(), _WRAP_SIGNAL(), and _WRAP_PROPERTY() add methods to wrap parts of the C API.

The .h and .cc files will be generated from the .hg and .ccg files by processing them with gmmproc like so, though this happens automatically when using the above build structure:

    $ cd gtk/src
    $ /usr/lib/glibmm-2.4/proc/gmmproc -I ../../tools/m4 --defs . button . ./../gtkmm

Notice that we provided gmmproc with the path to the .m4 convert files, the path to the .defs file, the name of a .hg file, the src directory, and the destination directory.

You should avoid including the C header from your C++ header, to avoid polluting the global namespace, and to avoid exporting unnecessary public API. But you will need to include the necessary C headers from your .ccg file.

The macros are explained in more detail in the following sections.

#### Class macros

The class macro declares the class itself and its relationship with the underlying C type. It generates some internal constructors, the member gobject_, typedefs, the gobj() accessors, type registration, and the Glib::wrap() method, among other things.

Other macros, such as _WRAP_METHOD() and _SIGNAL() may only be used after a call to a _CLASS_* macro.

##### _CLASS_GOBJECT

This macro declares a wrapper for a type that is derived from GObject, but which is not derived from GtkObject.

`_CLASS_GOBJECT( C++ class, C class, C casting macro, C++ base class, C base class )`

For instance, from accelgroup.hg:

    _CLASS_GOBJECT(AccelGroup, GtkAccelGroup, GTK_ACCEL_GROUP, Glib::Object, GObject)

##### _CLASS_GTKOBJECT

This macro declares a wrapper for a type that is derived from GtkObject, such as a widget or dialog.

`_CLASS_GTKOBJECT( C++ class, C class, C casting macro, C++ base class, C base class )`

For instance, from button.hg:

    _CLASS_GTKOBJECT(Button, GtkButton, GTK_BUTTON, Gtk::Bin, GtkBin)

##### _CLASS_BOXEDTYPE

This macro declares a wrapper for a non-GObject struct, registed with g_boxed_type_register_static().

`_CLASS_BOXEDTYPE( C++ class, C class, new function, copy function, free function )`

For instance, for Gdk::Color:

    _CLASS_BOXEDTYPE(Color, GdkColor, NONE, gdk_color_copy, gdk_color_free)

##### _CLASS_BOXEDTYPE_STATIC

This macro declares a wrapper for a simple assignable struct such as GdkRectangle. It is similar to _CLASS_BOXEDTYPE, but the C struct is not allocated dynamically.

`_CLASS_BOXEDTYPE_STATIC( C++ class, C class )`

For instance, for Gdk::Rectangle:

    _CLASS_BOXEDTYPE_STATIC(Rectangle, GdkRectangle)

##### _CLASS_OPAQUE_COPYABLE

This macro declares a wrapper for an opaque struct that has copy and free functions. The new, copy and free functions will be used to instantiate the default constructor, copy constructor and destructor.

`_CLASS_OPAQUE_COPYABLE( C++ class, C class, new function, copy function, free function )`

For instance, for Gdk::Region:

    _CLASS_OPAQUE_COPYABLE(Region, GdkRegion, gdk_region_new, gdk_region_copy, gdk_region_destroy)

##### _CLASS_OPAQUE_REFCOUNTED

This macro declares a wrapper for a reference-counted opaque struct. The C++ wrapper can not be directly instantiated and can only be used with Glib::RefPtr.

`_CLASS_OPAQUE_COPYABLE( C++ class, C class, new function, ref function, unref function )`

For instance, for Pango::Coverage:

    _CLASS_OPAQUE_REFCOUNTED(Coverage, PangoCoverage, pango_coverage_new, pango_coverage_ref, pango_coverage_unref)

##### _CLASS_GENERIC

This macro can be used to wrap structs which don't fit into any specialized category.

`_CLASS_GENERIC( C++ class, C class )`

For instance, for Pango::AttrIter:

    _CLASS_GENERIC(AttrIter, PangoAttrIterator)

#### Constructor macros

The _CTOR_DEFAULT() and _WRAP_CTOR() macros add constructors, wrapping the specified *_new() C functions. These macros assume that the C object has properties with the same names as the function parameters, as is usually the case, so that it can supply the parameters directly to a g_object_new() call. These constructors never actually call the *_new() C functions, because gtkmm must actually instantiate derived GTypes, and the *_new() C functions are meant only as convenience functions for C programmers.

When using _CLASS_GOBJECT(), the constructors should be protected (rather than public) and each constructor should have a corresponding _WRAP_CREATE() in the public section. This prevents the class from being instantiated without using a RefPtr. For instance,

    class ActionGroup : public Glib::Object
    {
      _CLASS_GOBJECT(ActionGroup, GtkActionGroup, GTK_ACTION_GROUP, Glib::Object, GObject)

    protected:
      _WRAP_CTOR(ActionGroup(const Glib::ustring& name = Glib::ustring()), gtk_action_group_new)

    public:
      _WRAP_CREATE(const Glib::ustring& name = Glib::ustring())

##### _CTOR_DEFAULT

This macro creates a default constructor with no arguments.

##### _WRAP_CTOR

This macro creates a constructor with arguments, equivalent to a *_new() C function. It takes a C++ constructor signature, and a C function name.

##### Hand-coding constructors

When a constructor must be partly hand written because, for instance, the *_new() C function's parameters do not correspond directly to object properties, or because the *_new() C function does more than call g_object_new(), the _CONSTRUCT() macro may be used in the .ccg file to save some work. The _CONSTRUCT macro takes a series of property names and values. For instance, from button.ccg:

    Button::Button(const Glib::ustring& label, bool mnemonic)
    :
      _CONSTRUCT("label", label.c_str(), "use_underline", gboolean(mnemonic))
    {}

#### Method macros

##### _WRAP_METHOD

This macro generates the C++ method to wrap a C function.

`_WRAP_METHOD( C++ method signature, C function name)`

For instance, from entry.hg:

    _WRAP_METHOD(void set_text(const Glib::ustring& text), gtk_entry_set_text)

The C function (e.g. gtk_entry_set_text) is described more fully in the .defs file, and the convert*.m4 files contain the necessary conversion from the C++ parameter type to the C parameter type. This macro also generates doxygen documentation comments based on the *_docs.xml and *_docs_override.xml files.

There are some optional extra arguments:

- refreturn: Do an extra reference() on the return value, in case the C function does not provide a reference.

- errthrow: Use the last GError* parameter of the C function to throw an exception.

- deprecated: Puts the generated code in #ifdef blocks. Text about the deprecation can be specified as an optional parameter.

- constversion: Just call the non-const version of the same function, instead of generating almost duplicate code.

Though it's usually obvious what C++ types should be used in the C++ method, here are some hints:

- Objects used via RefPtr: Pass the RefPtr as a const reference. For instance, const Glib::RefPtr<Gtk::Action>& action.

- Const Objects used via RefPtr: If the object should not be changed by the function, then make sure that the object is const, even if the RefPtr is already const. For instance, const Glib::RefPtr<const Gtk::Action>& action.

- Wrapping GList* and GSList* parameters: First, you need to discover what objects are contained in the list's data field for each item, usually by reading the documentation for the C function. The list can then be wrapped by an appropriate intermediate type, such as Glib::ListHandle or Glib::SListHandle. These are templates, so you can specify the item type. For instance, Glib::ListHandle< Glib::RefPtr<Action> >. Existing typedefs exist for some common list types. You may need to define a Traits type to specify how the C and C++ types should be converted.

- Wrapping GList* and GSList* return types: You must discover whether the caller should free the list and whether it should release the items in the list, again by reading the documentation of the C function. With this information you can choose the ownership (none, shallow or deep) for the m4 conversion rule, which you should probably put directly into the .hg file because the ownership depends on the function rather than the type. For instance:

      #m4 _CONVERSION(`GSList*', `Glib::SListHandle<Widget*>', `$2($3, Glib::OWNERSHIP_NONE)')

##### _WRAP_METHOD_DOCS_ONLY

This macro is like _WRAP_METHOD(), but it generates only the documentation for a C++ method that wraps a C function. Use this when you must hand-code the method, but you want to use the documentation that would be generated if the method was generated.

`_WRAP_METHOD( C++ method signature, C function name)`

For instance, from container.hg:

    _WRAP_METHOD_DOCS_ONLY(gtk_container_remove)

##### _IGNORE()

gmmproc will warn you on stdout about functions that you have forgotten to wrap, helping to ensure that you are wrapping the complete API. Buf if you don't want to wrap some functions or if you chose to hand-code some methods then you can use the _IGNORE() macro the make gmmproc stop complaining.

`_IGNORE(C function name 1, C function name2, etc)`

For instance, from buttonbox.hg:

    _IGNORE(gtk_button_box_set_spacing, gtk_button_box_get_spacing,

##### _WRAP_SIGNAL

This macro generates the C++ libsigc++-style signal to wrap a C GObject signal. It actually generates a public accessor method, such as signal_clicked(), which returns a proxy object. gmmproc uses the .defs file to discover the C parameter types and the .m4 convert files to discover appropriate type conversions.

`_WRAP_SIGNAL( C++ signal handler signature, C signal name)`

For instance, from button.hg:

    _WRAP_SIGNAL(void clicked(),"clicked")

Signals usually have function pointers in the GTK struct, with a corresponding enum value. and a g_signal_new() in the .c file.

There are some optional extra arguments:

- no_default_handler: Do not generate an on_something() virtual method to allow easy overriding of the default signal handler. Use this when adding a signal with a default signal handler would break the ABI by increasing the size of the class's virtual function table.

##### _WRAP_PROPERTY

This macro generates the C++ method to wrap a C GObject property. You must specify the property name and the wanted C++ type for the property. gmmproc uses the .defs file to discover the C type and the .m4 convert files to discover appropriate type conversions.

`_WRAP_PROPERTY(C property name, C++ type)`

For instance, from button.hg:

    _WRAP_PROPERTY("label", Glib::ustring)

Signals usually have function pointers in the GTK struct, with a corresponding enum value. and a g_signal_new() in the .c file.

There are some optional extra arguments:

- no_default_handler: Do not generate an on_something() virtual method to allow easy overriding of the default signal handler. Use this when adding a signal with a default signal handler would break the ABI by increasing the size of the class's virtual function table.

#### Other macros

##### _WRAP_ENUM()

This macro generates a C++ enum, usually in a C++ namespace, to wrap a C enum from the globabl namespace. You must specify the desired C++ name and the name of the underlying C enum.

For instance, from widget.hg:

    _WRAP_ENUM(WindowType, GdkWindowType)

### Hand-coded source files

You might want to contain extra source files that will not be generated by gmmproc from .hg and .ccg files. You can simply place these in your libsomething/libsomethingmm directory and mention them in the Makefile.am in the files_extra_h and files_extra_cc variables.

### Initialization

Your library must be initialized before it can be used, to register the new types that it makes available. Also, the C library that you are wrapping might have its own initialization function that you should call. You can do this in an init() function that you can place in hand-coded init.h and init.cc files. This function should initialize your dependencies (such as the C function, and gtkmm) and call your generated wrap_init() function. For instance:

    void init()
    {
      Gtk::Main::init_gtkmm_internals(); //Sets up the g type system and the Glib::wrap() table.
      wrap_init(); //Tells the Glib::wrap() table about the libsomethingmm classes.
    }

The implemenation of the wrap_init() method in wrap_init.cc is generated by generate_wrap_init.pl, but the declaration in wrap_init.h is hand-coded, so you will need to adjust wrap_init.h so that the init() function appears in the correct C++ namespace.

### Problems in the C API.

You are likely to encounter some problems in the library that you are wrapping, particularly if it is a new project. Here are some common problems, with solutions.

#### Unable to predeclare structs

By convention, structs are declared in glib/GTK+-style headers like so:

    typedef struct _ExampleWidget ExampleWidget;

    struct _ExampleWidget
    {
      ...
    };

The extra typedef allows the struct to be used in a header without including its full defintion, simply by predeclaring it, by repeating that typedef. This means that you don't have to include the C library's header in your C++ header, thus keeping it out of your public API. gmmproc assumes that this technique was used, so you will see compiler errors if that is not the case.

This compiler error might look like this:

    example-widget.h:56: error: using typedef-name 'ExampleWidget' after 'struct'
    ../../libexample/libexamplemm/example-widget.h:34: error: 'ExampleWidget' has a previous declaration here
    make[4]: *** [example-widget.lo] Error 1

or this:

    example-widget.h:60: error: '_ExampleWidget ExampleWidget' redeclared as different kind of symbol
    ../../libexample/libexamplemm/example-widget.h:34: error: previous declaration of 'typedef struct _ExampleWidget ExampleWidget'

This is easy to correct in the C library, so do send a patch to the relevant maintainer.

#### Lack of properties

By convention, glib/GTK+-style objects have *_new() functions, such as example_widget_new() that do nothing more than call g_object_new() and return the result. The input parameters are supplied to g_object_new() along with the names of the properties for which they are values. For instance,

    GtkWidget* example_widget_new(int something, const char* thing)
    {
            return g_object_new (EXAMPLE_TYPE_WIDGET, "something", something, "thing", thing, NULL);
    }

This allows language bindings to implement their own equivalents (such as C++ constructors), without using the *_new() function. This is often necessary so that they can actually instantiate a derived GType, to add their own hooks for signal handlers and vfuncs.

At the least, the _new() function should not use any private API (functions that are only in a .c file). Even when there are no functions, we can sometimes reimplement 2 or 3 lines of code in a _new() function as long as those lines of code use API that is available to us.

Another workaround is to add a *_construct() function that the C++ constructor can call after instantiating its own type. For instance,

    GtkWidget* example_widget_new(int something, const char* thing)
    {
    	ExampleWidget* widget;
            widget = g_object_new (EXAMPLE_TYPE_WIDGET, NULL);
    	example_widget_construct(widget, "something", something, "thing", thing);
    }

    void example_widget_construct(ExampleWidget* widget, int something, const char* thing)
    {
    	//Do stuff that uses private API:
    	widget->priv->thing = thing;
    	do_something(something);
    }

Adding properties, and ensuring that they interact properly with each other, is relatively difficult to correct in the C library, but it is possible, so do file a bug and try to send a patch to the relevant maintainer.

### Documentation

In general, gtkmm-style projects use Doxygen, which reads specially formatted C++ comments and generates HTML documentation. You may write these doxygen comments directly in the header files.

#### Reusing C documentation

You might wish to reuse documentation that exists for the C library that you are wrapping. GTK-style C libraries typically use gtk-doc and therefore have source code comments formatted for gtk-doc and some extra documentation in .tmpl files. The docextract_to_xml.py script, from pygtk's codegen directory, can read these files and generate an .xml file that gmmproc can use to generate doxygen comments. gmmproc will even try to transform the documentation to make it more appropriate for a C++ API.

For instance,

    ./docextract_to_xml.py -s /gnome/head/cvs/gtk+/gtk/ -s /gnome/head/cvs/gtk+/docs/reference/gtk/tmpl/ > gtk_docs.xml

Because this automatic transformation is not always appropriate, you might want to provide hand-written text for a particular method. You can do this by copying the XML node for the function from your something_docs.xml file to the something_docs_override.xml file and changing the contents.

#### Documentation build structure

If you copied the structure of an existing project then you will already have a suitable Makefile and doxygen file. The standard makefile target uses the Doxyfile doxygen file to process the .h and .cc files and output generated documentation to the html directory.

## Optional API

The gtkmm API is meant to be easy and convenient. However, some of these conveniences are not worth the overhead on reduced resources devices, such as the Nokia 770 internet tablet. For instance, with regular gtkmm you can implement a signal handler by deriving the class and overriding its virtual on_thesignalname() method. But that additional API increases code size. And in the case of virtual methods, it increases per-object memory size, and demands that the linker loads the method's symbol even if you don't use it. Therefore, gtkmm can be built with a reduced API. In general, the optional API is rarely used, and there are slightly less convenient alternatives for all of the optional API.

When gtkmm has been built with optional API disabled, macros will be undefined, indicating that the API is not available. If you attempt to compile an application that uses this optional API, against a version of gtkmm that has disabled that API, you will see compiler warnings about missing functions.

The following sections describe the available configure options used to disable optional API. Most developers will rarely need to provide these configure options, because they will rarely build glibmm or gtkmm, preferring to use official packages or installers. However, if you are developing for an embedded device, you might need to be aware of these options.

### Optional API when building glibmm

#### --enable-deprecated-api=no

When enable-deprecated-api is disabled, no deprecated classes or methods will be available in glibmm. For instance, the Date::set_time(GTime time) method overload will not be provided. The reference documentation contains a full list of deprecated glibmm API.

If deprecated glibmm API is available, the GLIBMM_DISABLE_DEPRECATED macro will not be defined.

#### --enable-api-exceptions=no

When enable-api-exceptions is disabled, no exceptions will be used in the glibmm or gtkmm API, and no exceptions will be thrown. This allows applications to be built without support for exceptions. For intance, the g++ -fno-exceptions option may be used. Where a method would normally throw an exception, that method will instead take an additional std::auto_ptr<Glib::Error>& output parameter. If you are not using exceptions then you should check whether this parameter was set and handle any error appropriately.

If exceptions are not available, the GLIBMM_EXCEPTIONS_ENABLED macro will not be defined.

#### --enable-api-properties=no

When enable-api-properties is disabled, no property accessors will be available in the glibmm or gtkmm API. For instance, the `Gtk::Button::property_label()` method will not be available. "getter" and "setter" methods, such as `Gtk::Button::set_label()` will still be available.

When you really need to set or get the property value directly, for instance when using the `Gtk::CellRenderer` API, you can use the alternative `set_property()` and `get_property()` methods. For instance:

    #ifdef GLIBMM_PROPERTIES_ENABLED
      m_cellrenderer.property_editable() = true;
    #else
      m_cellrenderer.set_property("editable", true);
    #endif

If property accessors are not available, the GLIBMM_PROPERTIES_ENABLED macro will not be defined.

#### --enable-api-vfuncs=no

When enable-api-exceptions is disabled, no _vfunc virtual methods will be available in the glibmm or gtkmm API. These methods allow the developer to override some low-level behaviour of the underlying GTK+ objects, and they are therefore rarely used. For instance, `Gtk::Frame::compute_child_allocation_vfunc()` will not be available.

However, if you really need to override a _vfunc, for instance when implementing a custom `Gtk::TreeModel`, you may directly access the underlying GObject via the `gobj()` method.

If vfuncs are not available, the GLIBMM_VFUNCS_ENABLED macro will not be defined.

#### --enable-api-default-signal-handlers=no

When enable-api-exceptions is disabled, no virtual signal handler methods will be available in the glibmm or gtkmm API. For instance, the `Gtk::Button::on_clicked()` method will not be provided. Instead you must connect a signal handler by using the signal_clicked() accessor. This option offers a considerable code size and per-object memory reduction.

Note, however, that the compiler will not complain if you attempt to override a default signal handler when they are not supported by &gtkmm;, because the compiler cannot know that you expected to override a virtual method.

If default signal handlers are not available, the GLIBMM_DEFAULT_SIGNAL_HANDLERS_ENABLED macro will not be defined.

### Optional API when building gtkmm

#### --enable-deprecated-api=no

When enable-deprecated-api is disabled, no deprecated classes or methods will be available in gtkmm. For instance, the Gtk::FileSelection dialog will not be provided, because it is replaced by Gtk::FileChooserDialog. The reference documentation contains a full list of deprecated gtkmm API.

If deprecated gtkmm API is available, the GTKMM_DISABLE_DEPRECATED macro will not be defined.

#### --enable-api-atk=no

When enable-api-atk is disabled, no atkmm API will be available in gtkmm. For instance, Gtk::Widget will not inherit from Atk::Implementor.

If the atkmm API is not available, the GTKMM_ATKMM_ENABLED macro will not be defined.

## Using &gtkmm; with Visual Studio 2005

### Installing and Configuring Visual Studio 2005 Express

You may wish to build and run &gtkmm; applications on Microsoft Windows with the free-of-cost Visual Studio 2005 Express Edition. The following instructions descibe how to configure a workstation to build &gtkmm; applications easily. If you already have Visual Studio 2005 Standard Edition or above, skip to the section titled Installing Gtkmm

Download Visual Studio 2005 Express from Microsoft's Visual C++ Download Page.

After installing VS 2005 Express, you'll need to download the Windows Platform SDK. Because Microsoft requires that you validate your Windows install using the GenuineAdvantage ActiveX control, you must download it using Internet Explorer from a Windows box with a valid license.

The Platform SDK can be downloaded from the platform SDK download page.

After installing the Platform SDK, use the instructions from Brian Johnson's MSDN page to configure Visual Studio to build native Win32 Applications.

### Installing &gtkmm;

Once Visual Studio is installed and has been configured to build native Win32 applications, you must install the Gtk+ and &gtkmm; development packages. First, download and install the Gtk+ development package (listed as `gtk+-win32-devel`) from the GladeWin32 website. Next, download the &gtkmm; development package from the Gnome FTP site. Make sure you get the same version of both packages. At the time of this writing, the latest version is 2.10. Do not be afraid of the size of the development packages as they are much larger than the runtime packages which your end users will depend on.

### Creating a New Project with Gtkmm Support

#### Getting Started

First, create a new project in Visual Studio by Selecting `New Project` in the `File` menu as shown in . From the `New Project` window, make sure to select `Win32` and `Console Application` as shown in . Also, give your project a name and a location. For this example, the name of the project is `gtkmm_test` and the location is `C:\work`.

##### Selecting `New Project` from the menu.

##### Selecting Win32 Console Application.

##### Verifying Application Settings.

Clicking `Finish` will create for you a new native Win32 console project. Now we need to modify this project to use Gtkmm.

##### New Project as Created by Visual Stuido.

#### Correct `main()` function

The first order of business for this new project is to correct the `main()` function. Visual Studio wants to use a translated main function called `_tmain()`. This is fine, but will give you a non-portable project, and one of the goals of &gtkmm; is to provide a framework for portable applications. That being said, remove `_tmain()` and replace it with good old fashioned `main()`, just like mom used to make.

##### Corrected `main()` function.

#### Correct `stdafx.h`

The next thing to alter is the `stdafx.h` precompiled header file. At the time of this writing, many Windows programmers are familiar with the concept of precompiled headers. However, many Unix programmers are not, as precompiled header support was only recently added to GCC (in version 3.4) and is still not used in most open source projects. Unix programmers may be tempted to just disable precompiled headers altogether, but think carefully before doing this. Proper use of precompiled headers provides a much improved compile time when using &gtkmm;, and will save you many hours over the course of a project.

shows how to change the default `stdafx.h` to be more portable, and also shows the include line for the `&gtkmm;.h` header file. The portability changes include removing the `#pragma once` line and replacing it with a standard `#ifdef` include guard as well as removing the `tchar.h` include. It is advisable to put all of your &gtkmm; related headers (e.g.: `libglademm.h, libxml++`, etc.) in this file as opposed to other files as this will greatly speed up the compilation of your project.

##### Corrected `stdafx.h` header file.

#### Add Code to Create a Simple &gtkmm; Window

Next, add the contents of a simple &gtkmm; program to the `main()` function. The example shown in the figure below is the one from

##### Simple &gtkmm; Program.

#### Add the MSVC Property Files for &gtkmm;

The next step is to add the MSVC Property files which come with the &gtkmm; distribution. As of the 2005 version, Visual Studio supports the use of property files for adding settings to a project. Property files can contain build settings of all kinds (e.g.: defines, include paths, link paths, and libraries) and make it easy to build against 3rd party packages. When a property file is added to a project, the project inherits all the build settings which the property file specifies. To keep your project portable (portable in the relative path vs. fixed path sense), you will want to copy the property files from the &gtkmm; distribution (commonly `C:\Gtk\MSVC\`) to the directory which contains your project (in our case `C:\work\&gtkmm;_test\`).

##### Visual Stuio Property files in the &gtkmm; Distribution.

Next, add the property files to your project. Do this by clicking the `Property Manager` tab of your Solution explorer as indicated in .

##### Property Manager (left) with `Property Manager` tab circled.

Right-Click on the `Debug | Win32` folder and select `Add Existing Property Sheet.` From the file browser, select the file `&gtkmm;-2.4`d`.vsprops`. Next, Right-Click on the `Release | Win32` folder and again select `Add Existing Property Sheet.` From the file browser, this time select the file `&gtkmm;-2.4.vsprops`. When you are done, the Property Manager should look like the one in .

##### Adding an Existing Property Sheet.

##### Property manager with &gtkmm; property files added.

#### Change a Few Project Settings

At this point we're almost done. The last part is to change a few settings in the `Project Properties` page. The easiest way to get to this page is to right-click on the project name in the Solution Explorer and click the `Properties` menu item as shown in .

##### Opening the Project Properties.

The first thing to do is remove the `$(NoInherit)` option from the linker settings as shown in . Get to the linker page using the tree on the left. Open `Configuration Properties,` then `Linker,` then click on `Input`. Now remove the `$(NoInherit)` token from the `Additional Dependencies` line. Make sure to do this in both `Debug` and `Release` modes.

##### Removing the `$(NoInherit)` flag.

At this point your application will build and run. However, The &gtkmm; headers will cause a harmless warning during the build. Fortunately, this warning can be disabled from the same Project Settings dialog. In the tree on the left of the dialog, open `Configuration Properties,` then `C/C++,` then click `Advanced`. Now type `4250` in the `Disable Specific Warnings` field as shown in . Make sure to make this change in both `Release` and `Debug` modes. Press `Ok` when done.

##### Disabling warning 4250.

#### About the Windows Console

If you build and run your application now, you will see a simple Gtk+ window appear with nothing on it. Your application will also pop up a console window with it. The console window is quite valuable for debugging a &gtkmm; application because many Gtk+ warnings will print to this console and nowhere else (unlike the `OutputDebugString()` or `TRACE()` functions which Windows programmers are familiar with).

When you release your application however, you will probably want to have it not pop up the console. This requires two small changes to the linker settings. From the tree on the left of the properties page, open `Configuration Properties,` then `Linker,` then `System`. Now change the value of the `Subsystem` field from `CONSOLE` to `WINDOWS` as shown in . This will disable the creation of the console window when your app starts. When you do this, you also have to change the entry point of your application. From the tree on the left, select `Advanced` then change the `Entry Point` field to read `mainCRTStartup` (make sure to use the proper case) as shown in .

Some users have found it convenient to leave the console active in Debug mode and disabled in Release mode. Others will want to have it the same in both modes. It is completely up to the preference of the developer. Press `Ok` when done.

##### Setting the Subsystem to `Windows` to disable the console.

##### Setting the correct entry point symbol for Windows programs using `main()`.

That's all there is to it. After this initial setup, your &gtkmm; app can be edited, built, and run just like any other Visual Studio project.