An application consists of a number of files:
The binary |
This gets installed in /usr/bin. |
A desktop file |
The desktop file provides important information about the application to the desktop shell, such as its name, icon, D-Bus name, commandline to launch it, etc. It is installed in /usr/share/applications. |
An icon |
The icon gets installed in /usr/share/icons/hicolor/48x48/apps, where it will be found regardless of the current theme. |
A settings schema |
If the application uses GSettings, it will install its schema
in /usr/share/glib-2.0/schemas, so that tools
like dconf-editor can find it. |
Other resources |
Other files, such as GtkBuilder ui files, are best loaded from
resources stored in the application binary itself. This eliminates the
need for most of the files that would traditionally be installed in
an application-specific location in /usr/share. |
GTK+ includes application support that is built on top of
GApplication. In this tutorial we'll build a simple application by
starting from scratch, adding more and more pieces over time. Along
the way, we'll learn about GtkApplication, templates, resources,
application menus, settings, GtkHeaderBar, GtkStack, GtkSearchBar,
GtkListBox, and more.
The full, buildable sources for these examples can be found
in the examples/ directory of the GTK+ source distribution, or
online in the GTK+ git repository.
You can build each example separately by using make with the Makefile.example
file. For more information, see the README included in the
examples directory.
When using GtkApplication, the main() function can be very
simple. We just call g_application_run() and give it an instance
of our application class.
All the application logic is in the application class, which
is a subclass of GtkApplication. Our example does not yet have any
interesting functionality. All it does is open a window when it is
activated without arguments, and open the files it is given, if it
is started with arguments.
To handle these two cases, we override the activate() vfunc,
which gets called when the application is launched without commandline
arguments, and the open() vfunc, which gets called when the application
is launched with commandline arguments.
To learn more about GApplication entry points, consult the
GIO documentation.
Another important class that is part of the application support
in GTK+ is GtkApplicationWindow. It is typically subclassed as well.
Our subclass does not do anything yet, so we will just get an empty
window.
As part of the initial setup of our application, we also
create an icon and a desktop file.
Note that @bindir@ needs to be replaced
with the actual path to the binary before this desktop file can be used.
Here is what we've achieved so far:
This does not look very impressive yet, but our application
is already presenting itself on the session bus, it has single-instance
semantics, and it accepts files as commandline arguments.
In this step, we use a GtkBuilder template to associate a
GtkBuilder ui file with our application window class.
Our simple ui file puts a GtkHeaderBar on top of a GtkStack
widget. The header bar contains a GtkStackSwitcher, which is a
standalone widget to show a row of 'tabs' for the pages of a GtkStack.
To make use of this file in our application, we revisit
our GtkApplicationWindow subclass, and call
gtk_widget_class_set_template_from_resource() from the class init
function to set the ui file as template for this class. We also
add a call to gtk_widget_init_template() in the instance init
function to instantiate the template for each instance of our
class.
You may have noticed that we used the _from_resource() variant
of the function that sets a template. Now we need to use GLib's resource functionality
to include the ui file in the binary. This is commonly done by listing
all resources in a .gresource.xml file, such as this:
This file has to be converted into a C source file that will be
compiled and linked into the application together with the other source
files. To do so, we use the glib-compile-resources utility:
glib-compile-resources exampleapp.gresource.xml --target=resources.c --generate-source
Our application now looks like this:
In this step, we make our application show the content of
all the files that it is given on the commandline.
To this end, we add a private struct to our application
window subclass and keep a reference to the GtkStack there.
The gtk_widget_class_bind_template_child_private() function
arranges things so that after instantiating the template, the
stack member of the private struct will point to the widget of
the same name from the template.
Now we revisit the example_app_window_open() function that
is called for each commandline argument, and construct a GtkTextView
that we then add as a page to the stack:
Note that we did not have to touch the stack switcher
at all. It gets all its information from the stack that it
belongs to. Here, we are passing the label to show for each
file as the last argument to the gtk_stack_add_titled()
function.
Our application is beginning to take shape:
An application menu is shown by GNOME shell at the top of the
screen. It is meant to collect infrequently used actions that affect
the whole application.
Just like the window template, we specify our application menu
in a ui file, and add it as a resource to our binary.
To associate the app menu with the application, we have to call
gtk_application_set_app_menu(). Since app menus work by activating
GActions, we also have to add a suitable set of actions to our
application.
Both of these tasks are best done in the startup() vfunc,
which is guaranteed to be called once for each primary application
instance:
Our preferences menu item does not do anything yet,
but the Quit menu item is fully functional. Note that it
can also be activated by the usual Ctrl-Q shortcut. The
shortcut was added with gtk_application_set_accels_for_action().
The application menu looks like this:
A typical application will have a some preferences that
should be remembered from one run to the next. Even for our
simple example application, we may want to change the font
that is used for the content.
We are going to use GSettings to store our preferences.
GSettings requires a schema that describes our settings:
Before we can make use of this schema in our application,
we need to compile it into the binary form that GSettings
expects. GIO provides macros
to do this in autotools-based projects.
Next, we need to connect our settings to the widgets
that they are supposed to control. One convenient way to do
this is to use GSettings bind functionality to bind settings
keys to object properties, as we do here for the transition
setting.
The code to connect the font setting is a little more involved,
since there is no simple object property that it corresponds to, so
we are not going to go into that here.
At this point, the application will already react if you
change one of the settings, e.g. using the gsettings commandline
tool. Of course, we expect the application to provide a preference
dialog for these. So lets do that now. Our preference dialog will
be a subclass of GtkDialog, and we'll use the same techniques that
we've already seen: templates, private structs, settings
bindings.
Lets start with the template.
Next comes the dialog subclass.
Now we revisit the preferences_activated() function in our
application class, and make it open a new preference dialog.
After all this work, our application can now show
a preference dialog like this:
We continue to flesh out the functionality of our application.
For now, we add search. GTK+ supports this with GtkSearchEntry and
GtkSearchBar. The search bar is a widget that can slide in from the
top to present a search entry.
We add a toggle button to the header bar, which can be used
to slide out the search bar below the header bar.
Implementing the search needs quite a few code changes that
we are not going to completely go over here. The central piece of
the search implementation is a signal handler that listens for
text changes in the search entry.
With the search bar, our application now looks like this:
As another piece of functionality, we are adding a sidebar,
which demonstrates GtkMenuButton, GtkRevealer and GtkListBox.
The code to populate the sidebar with buttons for the words
found in each file is a little too involved to go into here. But we'll
look at the code to add the gears menu.
As expected by now, the gears menu is specified in a GtkBuilder
ui file.
To connect the menuitem to the show-words setting, we use
a GAction corresponding to the given GSettings key.
What our application looks like now:
Widgets and other objects have many useful properties.
Here we show some ways to use them in new and flexible ways,
by wrapping them in actions with GPropertyAction or by binding them
with GBinding.
To set this up, we add two labels to the header bar in our
window template, named lines_label and lines, and bind them to
struct members in the private struct, as we've seen a couple of times
by now.
We add a new "Lines" menu item to the gears menu, which
triggers the show-lines action:
To make this menu item do something, we create a property
action for the visible property of the lines label, and add it to the
actions of the window. The effect of this is that the visibility
of the label gets toggled every time the action is activated.
Since we want both labels to appear and disappear together,
we bind the visible property of the lines_label widget to the
same property of the lines widget.
We also need a function that counts the lines of the currently
active tab, and updates the lines label. See the
full source
if you are interested in the details.
This brings our example application to this appearance:
Our application already uses a GtkHeaderBar, but so far it
still gets a 'normal' window titlebar on top of that. This is a
bit redundant, and we will now tell GTK+ to use the header bar
as replacement for the titlebar. To do so, we move it around to
be a direct child of the window, and set its type to be titlebar.
A small extra bonus of using a header bar is that we get
a fallback application menu for free. Here is how the
application now looks, if this fallback is used.
If we set up the window icon for our window, the menu button
will use that instead of the generic placeholder icon you see
here.