msgid "" msgstr "" "Project-Id-Version: PACKAGE VERSION\n" "POT-Creation-Date: 2024-11-12 13:54+0000\n" "PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n" "Last-Translator: FULL NAME \n" "Language-Team: LANGUAGE \n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" "Content-Transfer-Encoding: 8bit\n" #. Put one translator per line, in the form NAME , YEAR1, YEAR2 msgctxt "_" msgid "translator-credits" msgstr "" #. (itstool) path: info/title #: C/index-in.docbook:45 msgid "Programming with gtkmm 4" msgstr "" #. (itstool) path: authorgroup/author #: C/index-in.docbook:47 msgid "MurrayCumming" msgstr "" #. (itstool) path: authorgroup/author #: C/index-in.docbook:50 msgid "BernhardRieder Chapter on \"Timeouts\"." msgstr "" #. (itstool) path: authorgroup/author #: C/index-in.docbook:54 msgid "JonathonJongsma Chapter on \"Drawing with Cairo\". Chapter on \"Working with gtkmm's Source Code\". Chapter on \"Recent Files\"." msgstr "" #. (itstool) path: authorgroup/author #: C/index-in.docbook:60 msgid "OleLaursen Parts of chapter on \"Internationalization\"." msgstr "" #. (itstool) path: authorgroup/author #: C/index-in.docbook:64 msgid "MarkoAnastasov Chapter on \"Printing\". Parts of chapter on \"Internationalization\"." msgstr "" #. (itstool) path: authorgroup/author #: C/index-in.docbook:69 msgid "DanielElstner Section \"Build Structure\" of chapter on \"Wrapping C Libraries with gmmproc\"." msgstr "" #. (itstool) path: authorgroup/author #: C/index-in.docbook:73 msgid "ChrisVine Chapter on \"Multi-threaded programs\"." msgstr "" #. (itstool) path: authorgroup/author #: C/index-in.docbook:77 msgid "DavidKing Section on Gtk::Grid." msgstr "" #. (itstool) path: authorgroup/author #: C/index-in.docbook:81 msgid "PedroFerreira Chapter on \"Keyboard Events\"." msgstr "" #. (itstool) path: authorgroup/author #: C/index-in.docbook:85 msgid "KjellAhlstedt Update from gtkmm 3 to gtkmm 4. Chapter on \"Building applications\". Chapter on \"The DropDown Widget\". Chapter on \"ListView, GridView, ColumnView\"." msgstr "" #. (itstool) path: authorgroup/author #: C/index-in.docbook:92 msgid "DanielBoles Notes on need to remove widgets in non-managed wrappers from parents to dispose, other tweaks." msgstr "" #. (itstool) path: abstract/para #: C/index-in.docbook:100 msgid "This book explains key concepts of the gtkmm C++ API for creating user interfaces. It also introduces the main user interface elements (\"widgets\")." msgstr "" #. (itstool) path: info/copyright #: C/index-in.docbook:103 msgid "2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010 Murray Cumming" msgstr "" #. (itstool) path: legalnotice/para #: C/index-in.docbook:109 msgid "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." msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:120 msgid "Introduction" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:123 msgid "This book" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:125 msgid "This book explains key concepts of the gtkmm C++ API for creating user interfaces. It also introduces the main user interface elements (\"widgets\"). Although it mentions classes, constructors, and methods, it does not go into great detail. Therefore, for full API information you should follow the links into the reference documentation." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:127 msgid "This book assumes a good understanding of C++, and how to create C++ programs." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:129 msgid "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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:137 msgid "gtkmm" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:139 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:147 msgid "gtkmm was originally named gtk-- because GTK was originally named GTK+ and had 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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:152 msgid "Why use gtkmm instead of GTK?" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:154 msgid "gtkmm allows you to write code using normal C++ techniques such as encapsulation, derivation, and polymorphism. As a C++ programmer you probably already realize that this leads to clearer and better organized code." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:155 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:156 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:157 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:158 msgid "gtkmm involves less code compared to GTK, which uses prefixed function names and lots of cast macros." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:162 msgid "gtkmm compared to Qt" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:164 msgid "Trolltech's Qt is the closest competition to gtkmm, so it deserves discussion." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:166 msgid "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 standardized 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 cannot 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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:171 msgid "gtkmm is a wrapper" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:173 msgid "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." msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:181 msgid "Installation" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:184 msgid "Dependencies" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:186 msgid "Before attempting to install gtkmm-4.0, you might first need to install these other packages." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:191 msgid "sigc++-3.0" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:192 msgid "gtk4" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:193 msgid "glibmm-2.68" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:194 msgid "cairomm-1.16" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:195 msgid "pangomm-2.48" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:197 msgid "These dependencies have their own dependencies, including the following applications and libraries:" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:202 msgid "pkg-config" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:203 msgid "glib-2.0" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:204 msgid "pango" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:205 msgid "cairo" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:206 msgid "gdk-pixbuf-2.0" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:207 msgid "graphene-1.0" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:212 msgid "Unix and Linux" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:215 msgid "Prebuilt Packages" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:217 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:225 msgid "The names of the gtkmm packages vary from distribution to distribution (e.g. libgtkmm-4.0-dev on Debian and Ubuntu or gtkmm4.0-devel on Red Hat and Fedora), so check with your distribution's package management program for the correct package name and install it like you would any other package." msgstr "" #. (itstool) path: note/para #: C/index-in.docbook:233 msgid "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 4.8 supplied by Debian's libgtkmm-4.0-dev package." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:243 msgid "Installing From Source" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:245 msgid "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 ." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:251 msgid "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 with Meson. See the README file in the gtkmm version you've downloaded." msgstr "" #. (itstool) path: note/para #: C/index-in.docbook:258 msgid "Remember that on a Unix or Linux operating system, you will probably need to be root to install software. The su or sudo command will allow you to enter the root password and have root status temporarily." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:265 msgid "The configure script or meson 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." msgstr "" #. (itstool) path: para/screen #: C/index-in.docbook:276 #, no-wrap msgid "" "\n" "# meson setup --prefix=/usr <builddir> <srcdir>\n" "# meson configure --prefix=/usr\n" "# ./configure --prefix=/usr\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:270 msgid "By default, gtkmm if built with Meson or Autotools, 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 one of: <_:screen-1/>" msgstr "" #. (itstool) path: warning/para #: C/index-in.docbook:283 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:292 msgid "If you want to help develop gtkmm or experiment with new features, you can also install gtkmm from git. Most users will never need to do this, but if you're interested in helping with gtkmm development, see the Working with gtkmm's Source Code appendix." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:302 msgid "Microsoft Windows" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:304 msgid "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 page or the gtkmm and Win32 appendix for Windows-specific installation instructions and notes." msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:315 msgid "Basics" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:317 msgid "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." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:320 msgid "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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:325 #: C/index-in.docbook:3933 msgid "Simple Example" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:327 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:332 msgid "Source Code" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:334 msgid "We will now explain each part of the example" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:335 #, no-wrap msgid "" "#include <gtkmm.h>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:336 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:343 msgid "The next part of the program:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:344 #, no-wrap msgid "" "class MyWindow : public Gtk::Window\n" "{\n" "public:\n" " MyWindow();\n" "};\n" "\n" "MyWindow::MyWindow()\n" "{\n" " set_title(\"Basic application\");\n" " set_default_size(200, 200);\n" "}" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:355 msgid "defines the MyWindow class. Its default constructor sets the window's title and default (initial) size." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:360 msgid "The main() function's first statement:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:361 #, no-wrap msgid "" "auto app = Gtk::Application::create(\"org.gtkmm.examples.base\");" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:362 msgid "creates a Gtk::Application object, stored in a Glib::RefPtr smartpointer. This is needed in all gtkmm applications. The create() method for this object initializes gtkmm." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:367 msgid "The last line creates and shows a window and enters the gtkmm main processing loop, which will finish when the window is closed. Your main() function will then return with an appropriate success or error code. The argc and argv arguments, passed to your application on the command line, can be checked when make_window_and_run() is called, but this simple application does not use those arguments." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:373 #, no-wrap msgid "" "return app->make_window_and_run<MyWindow>(argc, argv);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:375 msgid "After putting the source code in simple.cc you can compile the above program with gcc using:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:379 #, no-wrap msgid "" "g++ simple.cc -o simple `pkg-config --cflags --libs gtkmm-4.0` -std=c++17" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:380 msgid "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. Note also that simple.cc must come before the pkg-config invocation on the command line. -std=c++17 is necessary only if your compiler is not C++17 compliant by default." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:391 msgid "Headers and Linking" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:393 msgid "Although we have shown the compilation command for the simple example, you really should use the Meson build system. The examples used in this book are included in the gtkmm-documentation package, with appropriate build files, so we won't show the build commands in future. The README file in gtkmm-documentation describes how to build the examples." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:401 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:411 msgid "However, this is even simpler when using the dependency() function in a meson.build file with Meson. For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:415 #, no-wrap msgid "" "gtkmm_dep = dependency('gtkmm-4.0', version: '>= 4.6.0')" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:416 msgid "This checks for the presence of gtkmm and defines gtkmm_dep for use in your meson.build files. For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:420 #, no-wrap msgid "" "exe_file = executable('my_program', 'my_source1.cc', 'my_source2.cc',\n" " dependencies: gtkmm_dep,\n" " win_subsystem: 'windows',\n" ")" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:424 msgid "gtkmm-4.0 is the name of the current stable API. There are older APIs called gtkmm-2.4 and gtkmm-3.0 which install in parallel when they are available. There are several versions of gtkmm-2.4, such as gtkmm 2.10 and there are several versions of the gtkmm-3.0 API. Note that the API name does not change for every version because that would be an incompatible API and ABI break. There might be a future gtkmm-5.0 API which would install in parallel with gtkmm-4.0 without affecting existing applications." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:431 msgid "If you start by experimenting with a small application that you plan to use just for yourself, it's easier to start with a meson.build similar to the meson.build files in the Building applications chapter." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:436 msgid "If you use the older Autotools build system, see also the GNU site. It has more information about autoconf and automake. There are also some books describing Autotools: \"GNU Autoconf, Automake, and Libtool\" by Gary Vaughan et al. and \"Autotools, A Practitioner's Guide to GNU Autoconf, Automake, and Libtool\" by John Calcote." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:447 #: C/index-in.docbook:6586 msgid "Widgets" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:449 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:450 msgid "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::Grid, are not visible - they exist only to arrange other widgets. Here is some example code that adds 2 Gtk::Button widgets to a Gtk::Box container widget:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:452 #, no-wrap msgid "" "m_box.append(m_Button1);\n" "m_box.append(m_Button2);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:454 msgid "and here is how to add the Gtk::Box, containing those buttons, to a Gtk::Frame, which has a visible frame and title:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:456 #, no-wrap msgid "" "m_frame.set_child(m_box);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:457 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:461 msgid "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 .ui XML files and load them at runtime with Gtk::Builder. See the Gtk::Builder chapter." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:467 msgid "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. The Gtk::make_managed() allows you to create a new widget and state that it will become owned by the container into which you place it. This allows you to create the widget, add it to the container and not be concerned about deleting it, since that will occur when the parent container (which may itself be managed) is deleted. You can learn more about gtkmm memory management techniques in the Memory Management chapter." msgstr "" #. (itstool) path: section/title #. (itstool) path: appendix/title #: C/index-in.docbook:481 #: C/index-in.docbook:5364 #: C/index-in.docbook:5607 #: C/index-in.docbook:8872 msgid "Signals" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:483 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:490 msgid "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\":" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:492 #, no-wrap msgid "" "m_button1.signal_clicked().connect( sigc::mem_fun(*this,\n" " &HelloWorld::on_button_clicked) );" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:495 msgid "For more detailed information about signals, see the appendix." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:496 msgid "For information about implementing your own signals rather than just connecting to the existing gtkmm signals, see the appendix." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:502 msgid "Glib::ustring" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:504 msgid "You might be surprised to learn that gtkmm doesn't use std::string in 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:505 msgid "std::string uses 8 bits per character, but 8 bits aren't enough to encode languages such as Arabic, Chinese, and Japanese. Although the encodings for these languages have been specified by the Unicode Consortium, the C and C++ languages do not yet provide any standardized Unicode support for UTF-8 encoding. 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:510 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:511 msgid "Note that UTF-8 isn't compatible with 8-bit encodings like ISO-8859-1. For instance, German umlauts are not in the ASCII range and need more than 1 byte in the UTF-8 encoding. If your code contains 8-bit string literals, you have to convert them to UTF-8 (e.g. the Bavarian greeting \"Grüß Gott\" would be \"Gr\\xC3\\xBC\\xC3\\x9F Gott\")." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:512 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:514 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:516 msgid "Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:518 msgid "See the Internationalization section for information about providing the UTF-8 string literals." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:523 msgid "Mixing C and C++ APIs" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:525 msgid "You can use C APIs which do not yet have convenient C++ interfaces. It is generally not a problem to use C APIs from C++, and gtkmm helps by providing access to the underlying C object, and providing an easy way to create a C++ wrapper object from a C object, provided that the C API is also based on the GObject system." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:531 msgid "To use a gtkmm instance with a C function that requires a C GObject instance, use the C++ instance’s gobj() function to obtain a pointer to the underlying C instance. For example:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:536 #, no-wrap msgid "" "Gtk::Button button(\"example\");\n" "gtk_button_do_something_that_gtkmm_cannot(button.gobj());\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:540 msgid "To obtain a gtkmm instance from a C GObject instance, use one of the many overloaded Glib::wrap() functions. The C instance’s reference count is not incremented, unless you set the optional take_copy argument to true. For example:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:546 #, no-wrap msgid "" "GtkButton* cbutton = get_a_button();\n" "Gtk::Button* button = Glib::wrap(cbutton);\n" "button->set_label(\"Now I speak C++ too!\");\n" "" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:552 msgid "it's a widget or other class that inherits from Gtk::Object, and" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:553 msgid "the C instance has a floating reference when the wrapper is created, and" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:554 msgid "Gtk::manage() has not been called on it (which includes if it was created with Gtk::make_managed()), or" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:555 msgid "Gtk::manage() was called on it, but it was never added to a parent." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:550 msgid "The C++ wrapper shall be explicitly deleted if <_:itemizedlist-1/> Glib::wrap() binds the C and C++ instances to each other. Don't delete the C++ instance before you want the C instance to die." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:560 msgid "In all other cases the C++ instance is automatically deleted when the last reference to the C instance is dropped. This includes all Glib::wrap() overloads that return a Glib::RefPtr." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:567 msgid "Hello World in gtkmm" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:569 msgid "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:" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:574 msgid "Source Code" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:576 msgid "Try to compile and run it before going on. You should see something like this:" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:581 msgid "Hello World" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:583 msgctxt "_" msgid "external ref='figures/helloworld.png' md5='02f7e986e608661d5a1524ac5f0c0b2e'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:587 msgid "Pretty thrilling, eh? Let's examine the code. First, the HelloWorld class:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:592 #, no-wrap msgid "" "class HelloWorld : public Gtk::Window\n" "{\n" "public:\n" " HelloWorld();\n" " ~HelloWorld() override;\n" "\n" "protected:\n" " //Signal handlers:\n" " void on_button_clicked();\n" "\n" " //Member widgets:\n" " Gtk::Button m_button;\n" "};" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:606 msgid "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 initialization work for the window, including setting up the signals. Here it is, with the comments omitted:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:615 #, no-wrap msgid "" "HelloWorld::HelloWorld()\n" ": m_button(\"Hello World\")\n" "{\n" " m_button.set_margin(10);\n" " m_button.signal_clicked().connect(sigc::mem_fun(*this,\n" " &HelloWorld::on_button_clicked));\n" " set_child(m_button);\n" "}" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:624 msgid "Notice that we've used an initializer statement to give the m_button object the label \"Hello World\"." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:629 msgid "Next we call the Button's set_margin() method. This sets the amount of space around the button." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:634 msgid "We then hook up a signal handler to m_button's clicked signal. This prints our friendly greeting to stdout." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:639 msgid "Next, we use the Window's set_child() method to put m_button in the Window. The set_child() method places the Widget in the Window." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:645 msgid "Now let's look at our program's main() function. Here it is, without comments:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:650 #, no-wrap msgid "" "int main(int argc, char* argv[])\n" "{\n" " auto app = Gtk::Application::create(\"org.gtkmm.example\");\n" " return app->make_window_and_run<HelloWorld>(argc, argv);\n" "}" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:656 msgid "First we instantiate an object stored in a Glib::RefPtr smartpointer called app. This is of type Gtk::Application. Every gtkmm program must have one of these." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:661 msgid "Next we call make_window_and_run() which creates an object of our HelloWorld class, shows that 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, make_window_and_run() will return, causing our main() function to return. The application will then finish." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:670 msgid "Like the simple example we showed earlier, this Hello World program does not use the command-line parameters." msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:679 msgid "Changes in gtkmm 3" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:681 msgid "gtkmm-3.0 is an old version of the gtkmm API that installs in parallel with the still older gtkmm-2.4 API and the new gtkmm-4.0 API. The last version of the gtkmm-2.4 API was gtkmm 2.24. gtkmm 3 has no major fundamental differences to gtkmm 2 but does make several small changes that were not possible while maintaining binary compatibility. If you never used the gtkmm-2.4 API then you can safely ignore this chapter." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:683 msgid "gtkmm 3's library is called libgtkmm-3.0 rather than libgtkmm-2.4 and installs its headers in a similarly-versioned directory, so your pkg-config check should ask for gtkmm-3.0 rather than gtkmm-2.4." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:685 msgid "gtkmm 3 added some new classes:" msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:688 msgid "Gtk::AppChooser, Gtk::AppChooserButton, Gtk::AppChooserDialog allow the user to select an installed application to open a particular type of content." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:689 msgid "Gtk::Grid is a new container widget that will eventually replace Gtk::Box and Gtk::Table. It arranges its children according to properties of those children rather than its own layout details." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:690 msgid "Gtk::Switch displays On/Off states more explicitly than Gtk::CheckButton. It may be useful, for instance, when allowing users to activate hardware." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:693 msgid "gtkmm 3 also made several small changes to the API, which you will probably encounter when porting code that used gtkmm-2.4. Here is a short list:" msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:698 msgid "Gtk::CellLayout, used by Gtk::IconView, Gtk::TreeView::Column and Gtk::ComboBox, now has a Gtk::CellArea which can be used to specify more details of how the CellRenderers are arranged and aligned." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:700 msgid "Gtk::ComboBox now derives from CellLayout, allowing easier layout and alignment of its Gtk::CellRenderers." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:702 msgid "Gtk::Adjustment and IconSet and Gdk::Cursor are now used via Glib::RefPtr." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:704 msgid "Gtk::Box, Gtk::ButtonBox, Gtk::IconView, Gtk::Paned, Gtk::ProgressBar, Gtk::ScaleButton, Gtk::Scrollbar and Gtk::Separator now derive from Gtk::Orientable, allowing their orientation (vertical or horizontal) to be specified without requiring the use of a derived class such as Gtk::HBox." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:707 msgid "Gtk::IconView, Gtk::TextView, Gtk::TreeView and other widgets derive from Scrollable instead of having their own methods such as get_vadjustment() and instead of having their own set_scroll_adjustments signal." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:709 msgid "Gtk::Style and Gtk::Rc were removed, replaced by Gtk::StyleContext, and Gtk::StyleProviders, such as Gtk::CssProvider." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:711 msgid "Widget::on_expose_event() was replaced by Widget::on_draw(), which assumes that cairomm is used for drawing, via the provided Cairo::Context and does not require you to call Cairo::Context::clip()." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:713 msgid "Gdk::RGBA replaces Color, adding an alpha component for opacity. Colormap was removed, along with its awkward use to allocate colors." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:715 msgid "Gdk::Pixmap and Gdk::Bitmap were removed in favor of Gdk::Pixbuf." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:717 msgid "Gdk::Drawable was removed, with its methods moving into Gdk::Window." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:719 msgid "We now use std::vector in several methods instead of the intermediate *Handle types to make the API clearer." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:724 msgid "All deprecated API was removed in gtkmm 3.0, though there have been new deprecations in later gtkmm 3.x versions." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:726 msgid "As a first step to porting your source code to gtkmm-3.0 you should probably ensure that your application builds with the deprecated gtkmm-2.4 API disabled, by defining macro such as GTKMM_DISABLE_DEPRECATED. There are some autotools macros that can help with this by defining them optionally at build time. See the gtkmm 3 porting wiki page for more details." msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:731 msgid "Changes in gtkmm-4.0 and glibmm-2.68" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:733 msgid "gtkmm-4.0 is a new version of the gtkmm API that installs in parallel with the older gtkmm-2.4 and gtkmm-3.0 APIs. The last version of the gtkmm-3.0 API is gtkmm 3.24. gtkmm 4 has no major fundamental differences to gtkmm 3 but does make several changes (both small and large ones) that were not possible while maintaining binary compatibility. If you never used the gtkmm-3.0 API then you can safely ignore this chapter." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:741 msgid "gtkmm 4's library is called libgtkmm-4.0 rather than libgtkmm-3.0 and installs its headers in a similarly-versioned directory, so your pkg-config check should ask for gtkmm-4.0 rather than gtkmm-3.0." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:747 msgid "gtkmm-4.0 is used in combination with glibmm-2.68, which sets the global locale for your program. The older glibmm-2.4 does not do that, and gtkmm-3.0 does it only to some extent. What this means is briefly that if your gtkmm-3.0 program contains a call to std::locale::global(std::locale(\"\")), you can probably remove it. If you don't want glibmm or gtkmm to set the global locale for you, you should add a call to Glib::set_init_to_users_preferred_locale(false) before any call to Glib::init() or Gtk::Application::create(). See the glibmm reference." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:759 msgid "There are lots and lots of differences between gtkmm-3.0 and gtkmm-4.0. The following lists are not complete." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:762 msgid "There are some important behavioural changes, to which you must adapt when migrating:" msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:765 msgid "Whereas in gtkmm-3.0, destruction of a non-managed C++ widget wrapper caused the wrapped GtkWidget to be destroyed, changes in GTK4 mean that in gtkmm-4.0 this canʼt always be the case. GTK4 has no uniform way to remove a widget from a parent, as GTK3 did with Gtk::Container::remove(), so gtkmm-4.0 canʼt do the removal for you as gtkmm-3.0 did. Hence, if a non-managed C++ widget instance is destructed while the widget is a child of another, gtkmm-4.0 wonʼt remove it from the parent, the parent retains a ref that stops the child being disposed, and the GtkWidget stays alive. The end result is that to destroy a non-managed widget with its C++ wrapper you must first remove it from its parent (however that parent allows) so the C++ wrapperʼs dtor can drop the final reference." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:778 msgid "Some new classes were added in gtkmm 4 and glibmm 2.68:" msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:780 msgid "Glib::ExtraClassInit and Gtk::Snapshot: These classes are needed only for writing custom widgets. See the Custom Widgets section." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:783 msgid "Gtk::EventControllerKey, Gtk::EventControllerMotion, Gtk::EventControllerScroll and Gtk::GestureStylus" msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:786 msgid "Gdk::Paintable, Gdk::Texture, Gtk::Picture and Gtk::WidgetPaintable" msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:789 msgid "Gdk::Window has been renamed to Gdk::Surface. (Gtk::Window keeps its name.)" msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:791 msgid "Gdk::DrawContext and Gdk::CairoContext are new. Gdk::DrawingContext has been removed." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:793 msgid "Gtk::Clipboard has been replaced by the new Gdk::Clipboard." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:795 msgid "Gdk::DragContext has been split into Gdk::Drag and Gdk::Drop." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:799 msgid "There have also been several changes to the API, which you will probably encounter when porting code that used gtkmm-3.0 and glibmm-2.4. Here is a short list:" msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:803 msgid "A C++17 compiler is required." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:804 msgid "Gtk::Button, Gtk::ToolButton, Gtk::MenuItem and Gtk::Switch implement the Gtk::Actionable interface instead of the removed Gtk::Activatable interface." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:808 msgid "Gtk::FontButton implements the Gtk::FontChooser interface." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:809 msgid "Gtk::Widget: The get_preferred_*_vfunc()s have been replaced by measure_vfunc(). This change only affects custom widgets." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:812 msgid "sigc::slots use the sigc::slot<R(Args...)> syntax. Example: sigc::slot<void(int, int)> instead of sigc::slot<void, int, int>." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:814 msgid "Gtk::DrawingArea uses a draw function instead of the draw signal." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:815 msgid "Glib::ArrayHandle, Glib::StringArrayHandle, Glib::ListHandle and Glib::SListHandle have been removed. They were used in glibmm-2.4, but not used in gtkmm-3.0. If you've ever used these classes, replace them with a standard C++ container, such as std::vector." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:819 msgid "Gtk::Container has been removed." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:820 msgid "Gtk::Widget::show_all() has been removed. The default value of Gtk::Widget::property_visible() has been changed from false to true." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:823 msgid "All event signals have been removed from Gtk::Widget. In most cases you can use one of the subclasses of Gtk::EventController as a replacement. For instance, use Gtk::GestureMultiPress instead of signal_button_press_event() and signal_button_release_event(), and Gtk::EventControllerKey instead of signal_key_press_event() and signal_key_release_event()." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:830 msgid "Glib::RefPtr is an alias for std::shared_ptr. If you make your own Glib::ObjectBase-derived classes with create() methods that return a Glib::RefPtr, you must use Glib::make_refptr_for_instance() in your create() methods." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:835 msgid "Gtk::Box::pack_start() and Gtk::Box::pack_end() have been removed. Use the new Gtk::Box methods append(), prepend(), insert_child_after() and insert_child_at_start()." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:840 msgid "Gtk::ButtonBox has been removed." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:841 msgid "Gtk::RadioButton and Gtk::RadioButtonGroup have been removed. Use Gtk::CheckButton or Gtk::ToggleButton with set_group()." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:846 msgid "All deprecated API was removed in gtkmm 4.0 and glibmm 2.68, though there will be new deprecations in future versions." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:849 msgid "As a first step to porting your source code to gtkmm-4.0 you should probably ensure that your application builds with the deprecated gtkmm-3.0 and glibmm-2.4 API disabled, by defining the macros GTKMM_DISABLE_DEPRECATED, GDKMM_DISABLE_DEPRECATED, GLIBMM_DISABLE_DEPRECATED and GIOMM_DISABLE_DEPRECATED. There are some autotools macros that can help with this by defining them optionally at build time. See the Porting from gtkmm-2.4 to gtkmm-3.0 wiki page for more details." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:856 msgid "See also Migrating from GTK 3.x to GTK 4." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:860 msgid "Deprecations in gtkmm 4.10" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:861 msgid "Many classes are deprecated since gtkmm 4.10. They can still be used in gtkmm4 applications, provided GTKMM_DISABLE_DEPRECATED and GDKMM_DISABLE_DEPRECATED are not defined. There are also many new classes in gtkmm 4.10, which replace some of the deprecated classes. Some example programs in this tutorial use classes deprecated since gtkmm 4.10. Some other programs use classes available since gtkmm 4.10." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:867 msgid "Deprecated classes: AppChooser, AppChooserButton, AppChooserDialog, AppChooserWidget, CellArea, CellAreaBox, CellAreaContext, CellLayout, CellRenderer, CellRendererAccel, CellRendererCombo, CellRendererPixbuf, CellRendererProgress, CellRendererSpin, CellRendererSpinner, CellRendererText, CellRendererToggle, CellView, ComboBox, ComboBoxText, EntryCompletion, IconView, ListStore, ListViewText, StyleContext, TreeDragDest, TreeDragSource, TreeIter and other classes in treeiter.h, TreeModel, TreeModelFilter, TreeModelSort, TreePath, TreeRowReference, TreeSelection, TreeSortable, TreeStore, TreeView, TreeViewColumn, namespace CellRenderer_Generation, namespace TreeView_Private, ColorButton, ColorChooser, ColorChooserDialog, FileChooser, FileChooserDialog, FileChooserNative, FileChooserWidget, FontButton, FontChooser, FontChooserDialog, FontChooserWidget, MessageDialog, TreeModelColumn, TreeModelColumnRecord, InfoBar, Assistant, AssistantPage, LockButton, Statusbar, VolumeButton." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:885 msgid "New classes and enums: AlertDialog, ColorDialog, ColorDialogButton, ColumnViewSorter, FileDialog, FontDialog, FontDialogButton, FileLauncher, UriLauncher, ATContext, enums DialogError, FontLevel, Collation." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:890 msgid "In most cases there are replacements for the deprecated classes. See the reference documentation." msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:898 msgid "Buttons" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:900 msgid "gtkmm provides four basic types of buttons:" msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:907 msgid "Push buttons" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:909 msgid "Gtk::Button. Standard buttons, usually marked with a label or picture. Pushing one triggers an action. See the Button section." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:916 msgid "Toggle buttons" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:918 msgid "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." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:926 msgid "Check buttons" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:928 msgid "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 CheckButton section." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:938 msgid "Radio buttons" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:940 msgid "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 ToggleButtons or CheckButtons (a small widget with a label at the side), but usually look different. There is no separate radio button class. Check buttons and toggle buttons can act as radio buttons. See the Radio Button section." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:954 msgid "Note that, due to GTK's theming system, the appearance of these widgets will vary. In the case of check buttons and radio buttons, they may vary considerably." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:961 msgid "Button" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:963 msgid "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()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:969 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:971 #, no-wrap msgid "" "Gtk::Button* pButton = new Gtk::Button(\"_Something\", true);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:973 msgid "Gtk::Button is also a container so you could put any other widget, such as a Gtk::Image into it." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:979 msgid "The Gtk::Button widget has the clicked signal which is emitted when the button is pressed and released." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:984 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:987 #: C/index-in.docbook:1041 #: C/index-in.docbook:1100 #: C/index-in.docbook:1216 #: C/index-in.docbook:1274 #: C/index-in.docbook:1592 #: C/index-in.docbook:1659 #: C/index-in.docbook:1682 #: C/index-in.docbook:1717 #: C/index-in.docbook:1771 #: C/index-in.docbook:1810 #: C/index-in.docbook:1851 #: C/index-in.docbook:1884 #: C/index-in.docbook:2174 #: C/index-in.docbook:2206 #: C/index-in.docbook:2260 #: C/index-in.docbook:2307 #: C/index-in.docbook:2468 #: C/index-in.docbook:2492 #: C/index-in.docbook:2516 #: C/index-in.docbook:2554 #: C/index-in.docbook:2582 #: C/index-in.docbook:2613 #: C/index-in.docbook:4499 #: C/index-in.docbook:4528 #: C/index-in.docbook:4555 #: C/index-in.docbook:4582 #: C/index-in.docbook:4614 #: C/index-in.docbook:4638 #: C/index-in.docbook:4816 #: C/index-in.docbook:4965 #: C/index-in.docbook:5041 #: C/index-in.docbook:5113 #: C/index-in.docbook:5181 #: C/index-in.docbook:5421 #: C/index-in.docbook:6271 #: C/index-in.docbook:6319 #: C/index-in.docbook:6383 #: C/index-in.docbook:6914 #: C/index-in.docbook:7032 #: C/index-in.docbook:7679 #: C/index-in.docbook:7740 #: C/index-in.docbook:7798 #: C/index-in.docbook:8023 #: C/index-in.docbook:9461 msgid "Example" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:989 msgid "This example creates a button with a picture and a label." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:994 msgid "buttons example" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:996 msgctxt "_" msgid "external ref='figures/buttons.png' md5='ab288a013ed7d6c0b797f5998961dea9'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1000 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1007 msgid "ToggleButton" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1009 msgid "ToggleButtons are like normal Buttons, but when clicked they remain activated, or pressed, until clicked again." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1011 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1018 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1023 msgid "Reference" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:1028 #: C/index-in.docbook:1044 msgid "CheckButton" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1030 msgid "Gtk::CheckButton inherits directly from Gtk::Widget. It is similar to Gtk::ToggleButton. The only real difference between the two is Gtk::CheckButton's appearance. You can check and set a check button using the same member methods as for Gtk::ToggleButton." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1038 msgid "Reference" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:1046 msgctxt "_" msgid "external ref='figures/checkbutton.png' md5='4d0e8f846ce98aeeada64227dd2f55a7'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1050 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1056 msgid "Radio Button" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1058 msgid "There is no separate class for radio buttons. Check buttons and toggle buttons act as radio buttons when they form a group. Only one button in a group can be selected at any one time." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1065 msgid "Groups" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1066 msgid "You create the buttons, and set up their group afterwards. In the following example, we put 3 radio buttons in a group:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:1071 #, no-wrap msgid "" "auto rb1 = Gtk::make_managed<Gtk::CheckButton>(\"button1\");\n" "auto rb2 = Gtk::make_managed<Gtk::CheckButton>(\"button2\");\n" "auto rb3 = Gtk::make_managed<Gtk::CheckButton>(\"button3\");\n" "rb2->set_group(*rb1);\n" "rb3->set_group(*rb1);\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1078 msgid "We told gtkmm to put all three CheckButtons in the same group by using set_group() to tell the other CheckButtons to share group with the first CheckButton." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1088 #: C/index-in.docbook:1553 #: C/index-in.docbook:5292 msgid "Methods" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1089 msgid "CheckButtons and ToggleButtons 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()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1095 msgid "Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1101 msgid "The following example demonstrates the use of grouped CheckButtons:" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:1107 msgid "RadioButton" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:1109 msgctxt "_" msgid "external ref='figures/radiobuttons.png' md5='49ad0ed4567104af07b1c6484ffb821e'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1113 msgid "Source Code" msgstr "" #. (itstool) path: chapter/title #. (itstool) path: figure/title #: C/index-in.docbook:1120 #: C/index-in.docbook:1227 msgid "Range Widgets" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:1122 msgid "Gtk::Scale inherits from Gtk::Range. Gtk::Scrollbar does not inherit from Gtk::Range, but it shares much functionality with Gtk::Scale. They both 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 behavior." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:1134 msgid "As will be explained in the Adjustments section, all range widgets are associated with an 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." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:1148 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1151 msgid "Scrollbar Widgets" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1153 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1160 msgid "The orientation of a Gtk::Scrollbar can be either horizontal or vertical." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1165 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1170 msgid "Scale Widgets" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1172 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1181 msgid "As with Scrollbars, the orientation can be either horizontal or vertical. The default constructor creates 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 behavior." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1190 msgid "Useful methods" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1192 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1198 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1205 msgid "Also, the value can be drawn in different positions relative to the trough, specified by the set_value_pos() method." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1210 msgid "Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1218 msgid "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." msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:1229 msgctxt "_" msgid "external ref='figures/range_widgets.png' md5='8bebdf457c84aa921681a7f44f46f244'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1233 msgid "Source Code" msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:1240 msgid "Miscellaneous Widgets" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:1243 #: C/index-in.docbook:1284 msgid "Label" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1245 msgid "Labels are the main method of placing non-editable text in windows, for instance to place a title next to an Entry widget. You can specify the text in the constructor, or later with the set_text() or set_markup() methods." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1252 msgid "The width of the label will be adjusted automatically. You can produce multi-line labels by putting line breaks (\"\\n\") in the label string." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1256 msgid "The label text can be justified using the set_justify() method. The widget is also capable of word-wrapping, which can be activated with set_wrap()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1262 msgid "Gtk::Label supports some simple formatting, for instance allowing you to make some text bold, colored, or larger. You can do this by providing a string to set_markup(), using the Pango Markup syntax. For instance, <b>bold text</b> and <s>strikethrough text</s> ." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1271 msgid "Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1275 msgid "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.) It is possible that the first character in m_Label_Normal is shown underlined only when you press the Alt key." msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:1286 msgctxt "_" msgid "external ref='figures/label.png' md5='107dd71338becc14c70fbd3a708caa89'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1290 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:1297 #: C/index-in.docbook:1353 msgid "Entry" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1300 msgid "Simple Use" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1302 msgid "Entry widgets allow the user to enter text. You can change the contents with the set_text() method, and read the current contents with the get_text() method." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1307 msgid "Occasionally you might want to make an Entry widget read-only. This can be done by passing false to the set_editable() method." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1313 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1319 msgid "You might want to be notified whenever the user types in a text entry widget. Gtk::Entry provides two signals, activate (since gtkmm 4.8) and changed, for 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. Moving the keyboard focus to another widget may also signal that the user has finished entering text. The leave signal in a Gtk::EventControllerFocus can notify you when that happens. The ComboBox with an Entry section contains example programs that use these signals." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1333 msgid "If you pass true to the set_activates_default() method, pressing Enter in the Gtk::Entry will activate the default widget for the window containing the Gtk::Entry. This is especially useful in dialog boxes. The default widget is usually one of the dialog buttons, which e.g. will close the dialog box. To set a widget as the default widget, use Gtk::Window::set_default_widget()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1342 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1345 msgid "Simple Entry Example" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1346 msgid "This example uses Gtk::Entry. It also has two CheckButtons, with which you can toggle the editable and visible flags." msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:1355 msgctxt "_" msgid "external ref='figures/entry.png' md5='ae877c1b982f8c6cadebc9867f6d9075'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1359 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:1366 #: C/index-in.docbook:1406 msgid "Entry Completion" msgstr "" #. (itstool) path: note/para #: C/index-in.docbook:1368 msgid "Gtk::EntryCompletion is deprecated since gtkmm 4.10. There is no replacement in gtkmm." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1372 msgid "An Entry widget can offer a drop-down list of pre-existing choices based on the first few characters typed by the user. For instance, a search dialog could suggest text from previous searches." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1377 msgid "To enable this functionality, you must create an EntryCompletion object, and provide it to the Entry widget via the set_completion() method." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1382 msgid "The EntryCompletion may use a TreeModel containing possible entries, specified with set_model(). You should then call set_text_column() to specify which of your model columns should be used to match possible text entries." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1388 msgid "Alternatively, if a complete list of possible entries would be too large or too inconvenient to generate, a callback slot may instead be specified with set_match_func(). This is also useful if you wish to match on a part of the string other than the start." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1394 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1397 msgid "Entry Completion Example" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1398 msgid "This example creates a Gtk::EntryCompletion and associates it with a Gtk::Entry widget. The completion uses a Gtk::TreeModel of possible entries, and some additional actions." msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:1408 msgctxt "_" msgid "external ref='figures/entry_completion.png' md5='5b9015c5bd9c04c2c51eb1de40ab7534'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1412 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1418 msgid "Entry Icons" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1420 msgid "An Entry widget can show an icon at the start or end of the text area. The icon can be specified by methods such as set_icon_from_paintable() or set_icon_from_icon_name(). An application can respond to the user pressing the icon by handling the signal_icon_press signal." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1428 msgid "Entry Icon Example" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1429 msgid "This example shows a Gtk::Entry widget with a named search icon, and prints text to the terminal when the icon is pressed." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:1435 msgid "Entry with Icon" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:1437 msgctxt "_" msgid "external ref='figures/entry_icon.png' md5='fb1db5f1b82bb2849d352170ada89191'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1441 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1447 msgid "Entry Progress" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1449 msgid "An Entry widget can show a progress bar inside the text area, under the entered text. The progress bar will be shown if the set_progress_fraction() or set_progress_pulse_step() methods are called." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1455 msgid "Entry Progress Example" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1456 msgid "This example shows a Gtk::Entry widget with a progress bar." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:1462 msgid "Entry with Progress Bar" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:1464 msgctxt "_" msgid "external ref='figures/entry_progress.png' md5='07a446c645744d0ab3516112271cf4e3'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1468 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:1476 #: C/index-in.docbook:1599 msgid "SpinButton" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1478 msgid "A SpinButton allows the user to select a value from a range of numeric values. It has an Entry widget with increment and decrement 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1486 msgid "The value can have an adjustable number of decimal places, and the step size is configurable. SpinButtons have an 'auto-repeat' feature as well: holding down the increment or decrement button can optionally cause the value to change more quickly the longer the button is held down." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:1500 msgid "value: value for the Spin Button" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:1506 msgid "lower: lower range value" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:1512 msgid "upper: upper range value" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:1517 msgid "step_increment: value to increment/decrement when pressing mouse button 1" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:1524 msgid "page_increment: value to increment/decrement when pressing mouse button 2" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:1531 msgid "page_size: unused" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1493 msgid "SpinButtons use an Adjustment object to hold information about the range of values. These Adjustment attributes are used by the Spin Button like so: <_:itemizedlist-1/>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1539 msgid "Additionally, mouse button 3 can be used to jump directly to the upper or lower values." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1544 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1555 msgid "The number of decimal places can be altered using the set_digits() method." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1560 msgid "You can set the spinbutton's value using the set_value() method, and retrieve it with get_value()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1565 msgid "The spin() method 'spins' the SpinButton, as if its increment or decrement button had been clicked. You need to specify a Gtk::SpinType to specify the direction or new position." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1572 msgid "To prevent the user from typing non-numeric characters into the entry box, pass true to the set_numeric() method." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1577 msgid "To make the SpinButton 'wrap' between its upper and lower bounds, use the set_wrap() method." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1582 msgid "To force it to snap to the nearest step_increment, use set_snap_to_ticks()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1587 msgid "Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1594 msgid "Here's an example of a SpinButton in action:" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:1601 msgctxt "_" msgid "external ref='figures/spinbutton.png' md5='2157244b231fea5619793aa8ba25d4d8'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1605 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:1612 #: C/index-in.docbook:1662 msgid "ProgressBar" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1614 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1620 msgid "To change the value shown, use the set_fraction() method, passing a double between 0.0 and 1.0 to provide the new fraction." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1625 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1631 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1634 msgid "Activity Mode" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1636 msgid "Besides indicating the amount of progress that has occurred, 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)." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1646 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1652 msgid "The progress bar can also display a configurable text string next to the bar, using the set_text() method." msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:1664 msgctxt "_" msgid "external ref='figures/progressbar.png' md5='c7dcbf44476378ef1d0c601f619c7918'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1668 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:1674 #: C/index-in.docbook:1689 msgid "InfoBar" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1676 msgid "An InfoBar may show small items of information or ask brief questions. Unlike a Dialog, it appears at the top of the current window instead of opening a new window. Its API is very similar to the Gtk::Dialog API." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1679 msgid "Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1684 msgid "The InfoBar widget is deprecated since gtkmm 4.10. The example shows an info bar consisting of a Box with a Label and a Button." msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:1691 msgctxt "_" msgid "external ref='figures/infobar.png' md5='4da1d3d7d3011221c3a1d896436b1931'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1695 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1702 msgid "Tooltips" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1704 msgid "Tooltips are the little information windows that pop up when you leave your pointer over a widget for a few seconds. Use set_tooltip_text() to set a text string as a tooltip on any Widget. Gtk::Tooltip is used for more advanced tooltip usage, such as showing an image as well as text." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1713 msgid "Widget Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1714 msgid "Tooltip Reference" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:1720 msgid "Tooltip" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:1722 msgctxt "_" msgid "external ref='figures/tooltip.png' md5='85a18bdc5b7301f2d4d4a1886176a38c'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1726 msgid "Source Code" msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:1733 msgid "Container Widgets" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:1735 msgid "Container widgets, like other widgets, derive from Gtk::Widget. Some container widgets, such as Gtk::Grid can hold many child widgets, so these typically have more complex interfaces. Others, such as Gtk::Frame contain only one child widget." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1743 msgid "Single-item Containers" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1745 msgid "Most single-item container widgets have set_child() and unset_child() methods for the child widget. Gtk::Button and Gtk::Window are technically single-item containers, but we have discussed them already elsewhere." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1752 msgid "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." msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:1759 #: C/index-in.docbook:1774 msgid "Frame" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1761 msgid "Frames can enclose one or a group of widgets within a box, optionally with a title. For instance, you might place a group of ToggleButtons or CheckButtons in a Frame." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1768 msgid "Reference" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:1776 msgctxt "_" msgid "external ref='figures/frame.png' md5='e7b49b5f57afa5c0d4c487c187f1be55'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1780 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:1786 #: C/index-in.docbook:1813 msgid "Paned" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1788 msgid "Panes divide a widget into two halves, separated by a moveable divider. The two halves (panes) can be oriented either horizontally (side by side) or vertically (one above the other)." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1794 msgid "Unlike the other widgets in this section, pane widgets contain not one but two child widgets, one in each pane. Therefore, you should use set_start_child() and set_end_child() instead of a set_child() method." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1801 msgid "You can adjust the position of the divider using the set_position() method, and you will probably need to do so." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1807 msgid "Reference" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:1815 msgctxt "_" msgid "external ref='figures/paned.png' md5='874e9d11227d6d10d2ab7cb0b04de32d'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1819 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:1825 #: C/index-in.docbook:1858 msgid "ScrolledWindow" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1827 msgid "ScrolledWindow widgets create a scrollable area. You can insert any type of widget into a ScrolledWindow, 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1836 msgid "Scrolled windows have scrollbar policies which determine whether the Scrollbars will be displayed. The policies can be set with the set_policy() method. The policy may be for instance Gtk::PolicyType::AUTOMATIC or Gtk::PolicyType::ALWAYS. Gtk::PolicyType::AUTOMATIC will cause the scrolled window to display the scrollbar only if the contained widget is larger than the visible area. Gtk::PolicyType::ALWAYS will cause the scrollbar to be displayed always." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1848 msgid "Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1853 msgid "Here is a simple example that packs 100 toggle buttons into a ScrolledWindow. Try resizing the window to see the scrollbars react." msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:1860 msgctxt "_" msgid "external ref='figures/scrolledwindow.png' md5='b99f195d17b39197af733087e0e69def'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1864 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:1870 #: C/index-in.docbook:1893 msgid "AspectFrame" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1872 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1881 msgid "Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1886 msgid "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." msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:1895 msgctxt "_" msgid "external ref='figures/aspectframe.png' md5='9d8aac9521789ed27036a97a22fedece'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1899 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1905 msgid "Other Single-item Containers" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1907 msgid "There are other single-item containers. See the reference documentation for a complete list. Here are links to some example programs that show containers, which are not mentioned elsewhere in this tutorial." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1913 msgid "Source Code, Expander" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1914 msgid "Source Code, Popover" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1921 msgid "Multiple-item Containers" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1923 msgid "Multiple-item container widgets have other methods than set_child() and unset_child(). Different containers can have different methods for adding and removing child widgets. For instance, Gtk::Box has append() and remove() as well as other methods. The remove() method for multiple-item containers takes an argument, specifying which widget to remove." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:1933 msgid "Packing" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1935 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1940 msgid "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:" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:1947 msgid "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." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:1951 msgid "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." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:1955 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1961 msgid "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 grids. 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 margins 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1970 msgid "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 flavors of containers: single-child containers and multiple-child containers. Most container widgets in gtkmm are single-child containers, including Gtk::Window." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:1979 msgid "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::Grid and Gtk::Box." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:1990 msgid "Gtk::Grid arranges its child widgets in rows and columns. Use attach() and attach_next_to() to insert child widgets." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:1998 msgid "Gtk::Box arranges its child widgets vertically or horizontally. Use append() to insert child widgets." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2006 msgid "There are several other containers, which we will also discuss." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2010 msgid "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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2020 msgid "An improved Hello World" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2022 msgid "Let's take a look at a slightly improved helloworld, showing what we've learnt." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:2027 msgid "Hello World 2" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:2029 msgctxt "_" msgid "external ref='figures/helloworld2.png' md5='b16c41a2b1206bb0a5a3e1e488e198f8'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2033 msgid "Source Code" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2035 msgid "After building and running this program, try resizing the window to see the behavior. Also, try playing with set_expand(), set_hexpand(), set_vexpand(), set_halign() and set_valign() while reading the Boxes section." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2046 msgid "Boxes" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2048 msgid "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. In a vertical box, widgets are packed from top to bottom. You may use any combination of boxes inside or beside other boxes to create the desired effect." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2058 msgid "Adding widgets" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2060 msgid "Per-child packing options" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2061 msgid "The append() method places widgets inside these containers. It will start at the top and work its way down in a Box with vertical orientation, or pack left to right in a Box with horizontal orientation. If it's inconvenient to add widgets in this order, use insert_child_after() or insert_child_at_start(). We will use append() in our examples." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2071 msgid "There are several options governing how widgets are to be packed, and this can be confusing at first. You can modify the packing by using set_expand(), set_hexpand(), set_vexpand(), set_halign(), set_valign() and/or set_margin() on the child widgets. If you have difficulties, then it is sometimes a good idea to play with the Cambalache GUI designer to see what is possible. You can then use the Gtk::Builder API to load your GUI at runtime." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2082 msgid "There are basically five different styles, as shown in this picture:" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:2088 msgid "Box Packing 1" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:2090 msgctxt "_" msgid "external ref='figures/box_packing1.png' md5='dedb723a5ca690ed542d09361fc8ad4a'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2094 msgid "Each line contains one horizontal Box with several buttons. Each of the buttons on a line is packed into the Box with the same arguments to the set_hexpand(), set_halign(), set_margin_start() and set_margin_end() methods." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2103 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2108 msgid "Per-container packing options" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2109 msgid "Here's the constructor for the Box widget, and methods that set per-container packing options:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:2112 #, no-wrap msgid "" "Gtk::Box(Gtk::Orientation orientation = Gtk::Orientation::HORIZONTAL, int spacing = 0);\n" "void set_orientation(Gtk::Orientation orientation);\n" "void set_spacing(int spacing);\n" "void set_homogeneous(bool homogeneous = true);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2116 msgid "Passing true to set_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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2122 msgid "What's the difference between spacing (set when the box is created) and margins (set separately for each child widget)? Spacing is added between objects, and margins are added on one or more sides of a widget. The following figure should make it clearer. The shown margins are the left and right margins of each button in the row." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:2131 msgid "Box Packing 2" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:2133 msgctxt "_" msgid "external ref='figures/box_packing2.png' md5='48e64123d27cc8e66137c8a2edf9589f'" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2141 msgid "Gtk::Application and command-line options" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2143 msgid "The following example program requires a command-line option. The source code shows two ways of handling command-line options in combination with Gtk::Application." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:2149 msgid "Handle the options in main() and hide them from Gtk::Application by setting argc = 1 in the call to Gtk::Application::run()." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:2155 msgid "Give all command-line options to Gtk::Application::run() and add the flag Gio::Application::Flags::HANDLES_COMMAND_LINE to Gtk::Application::create(). Connect a signal handler to the command_line signal, and handle the command-line options in the signal handler." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:2162 msgid "You must set the optional parameter after = false in the call to signal_command_line().connect(), because your signal handler must be called before the default signal handler. You must also call Gio::Application::activate() in the signal handler, unless you want your application to exit without showing its main window. (Gio::Application is a base class of Gtk::Application.)" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2176 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2179 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:2185 #: C/index-in.docbook:2215 msgid "Grid" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2187 msgid "A Grid dynamically lays out child widgets in rows and columns. The dimensions of the grid do not need to be specified in the constructor." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2192 msgid "Child widgets can span multiple rows or columns, using attach(), or added next to an existing widget inside the grid with attach_next_to(). Individual rows and columns of the grid can be set to have uniform height or width with set_row_homogeneous() and set_column_homogeneous()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2199 msgid "You can set the margin and expand properties of the child Widgets to control their spacing and their behavior when the Grid is resized." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2203 msgid "Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2207 msgid "This example creates a window with three buttons in a grid. The first two buttons are in the upper row, from left to right. A third button is attached underneath the first button, in a new lower row, spanning two columns." msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:2217 msgctxt "_" msgid "external ref='figures/grid.png' md5='18031e926d6082207f18de1b08cd85ae'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2221 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:2227 #: C/index-in.docbook:2263 msgid "Notebook" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2229 msgid "A Notebook has a set of stacked pages, each of which contains widgets. Labelled tabs allow the user to select the pages. Notebooks allow several sets of widgets to be placed in a small space, by only showing one page at a time. For instance, they are often used in preferences dialogs." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2238 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2245 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2252 msgid "To programmatically change the selected page, use the set_current_page() method." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2257 msgid "Reference" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:2265 msgctxt "_" msgid "external ref='figures/notebook.png' md5='b46c25388d4c250b0ab737f71f82d81b'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2269 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:2276 #: C/index-in.docbook:2310 msgid "Assistant" msgstr "" #. (itstool) path: note/para #: C/index-in.docbook:2278 msgid "Gtk::Assistant is deprecated since gtkmm 4.10. There is no replacement in gtkmm. libadwaita (a C library) has replacement parts (like AdwCarousel). In some cases, a Gtk::Notebook might be an acceptable replacement." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2284 msgid "An Assistant splits a complex operation into steps. Each step is a page, containing a header, a child widget and an action area. The Assistant's action area has navigation buttons which update automatically depending on the type of the page, set with set_page_type()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2288 msgid "Use the append_page(), prepend_page and insert_page() methods to add pages to the Assistant, supplying the child widget for each page." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2292 msgid "To determine the currently-visible page, use the get_current_page() method, and pass the result to get_nth_page(), which returns a pointer to the actual widget. To programmatically change the current page, use the set_current_page() method." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2296 msgid "To set the title of a page, use the set_page_title() method." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2300 msgid "To add widgets to the action area, use the add_action_widget() method. They will be packed alongside the default buttons. Use the remove_action_widget() method to remove widgets." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2304 msgid "Reference" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:2312 msgctxt "_" msgid "external ref='figures/assistant.png' md5='14f588bf7a1dde5e329e5478efe3ae3f'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2316 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2323 msgid "Other Multi-item Containers" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2325 msgid "There are other multi-item containers. See the reference documentation for a complete list. Here are links to some example programs that show containers, which are not mentioned elsewhere in this tutorial." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2331 msgid "Source Code, ActionBar" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2332 msgid "Source Code, FlowBox" msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:2339 msgid "ListView, GridView, ColumnView" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:2341 msgid "Lists are intended to be used whenever developers want to display many objects in roughly the same way. They are perfectly fine to be used for very short lists of only 2 or 3 items, but generally scale fine to thousands of items." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:2347 msgid "Lists are meant to be used with changing data, both with the items themselves changing as well as the list adding and removing items. Of course, they work just as well with static data." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:2353 msgid "The List Widget Overview chapter in the GTK documentation contains more information about list widgets." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:2358 msgid "Some examples are shown in this chapter. There are more examples in the listmodelviews directory in gtkmm-documentation's examples." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2364 msgid "The Data Model" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2366 msgid "The data model is a class that implements the Gio::ListModel interface. Examples of such classes are Gio::ListStore (not to be confused with the deprecated Gtk::ListStore), Gtk:StringList, Gtk:DirectoryList and Pango::FontMap." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2374 msgid "The elements in a model are called items. All items are instances of a subclass of Glib::Object. For instance, you might have a ColumnView with one integer and one text column, like so:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:2380 #: C/index-in.docbook:3378 #, no-wrap msgid "" "class ModelColumns : public Glib::Object\n" "{\n" "public:\n" " int m_col_id;\n" " Glib::ustring m_col_name;\n" "\n" " static Glib::RefPtr<ModelColumns> create(\n" " int col_id, const Glib::ustring& col_name)\n" " {\n" " return Glib::make_refptr_for_instance<ModelColumns>(\n" " new ModelColumns(col_id, col_name));\n" " }\n" "\n" "protected:\n" " ModelColumns(int col_id, const Glib::ustring& col_name)\n" " : m_col_id(col_id), m_col_name(col_name)\n" " {}\n" "};\n" "\n" "Glib::RefPtr<Gio::ListStore<ModelColumns>> m_ListStore;\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2402 msgid "Every item in a model has a position which is the unsigned integer that describes where in the model the item is located. The first item in a model is at position 0. The position of an item can of course change as other items are added to or removed from the model." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2408 msgid "Gio::ListStore Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2409 msgid "StringList Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2410 msgid "DirectoryList Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2414 msgid "The Selection Model" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2416 msgid "The selection model is a class that implements the Gtk::SelectionModel interface. You can choose between NoSelection, SingleSelection and MultiSelection." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2421 msgid "NoSelection Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2422 msgid "SingleSelection Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2423 msgid "MultiSelection Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2427 msgid "The Factory" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2429 msgid "Data from the data model is added to the view by a factory, which is a subclass of ListItemFactory. There is only one such subclass in gtkmm, SignalListItemFactory. Data from the model is added to the view with signal handlers connected to a SignalListItemFactory." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2435 msgid "SignalListItemFactory Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2439 #: C/index-in.docbook:2810 #: C/index-in.docbook:3859 msgid "The View" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2441 msgid "The View is the widget that displays the model 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2447 msgid "An important requirement for views (especially views of long lists) is that they need to know which items are not visible so they can be recycled. Views achieve that by implementing the Scrollable interface and expecting to be placed directly into a ScrolledWindow." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2454 msgid "There are different view widgets to choose from." msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:2459 #: C/index-in.docbook:2471 msgid "ListView" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2461 msgid "The ListView shows a 1-dimensional list with one column." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2465 msgid "Reference" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:2473 msgctxt "_" msgid "external ref='figures/listmodel_listview.png' md5='5e49d159f43fdc5242998713bdedafc8'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2477 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:2483 #: C/index-in.docbook:2495 msgid "GridView" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2485 msgid "The GridView shows a 2-dimensional grid." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2489 msgid "Reference" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:2497 msgctxt "_" msgid "external ref='figures/listmodel_gridview.png' md5='0d87e962deacc452f32513f0d5e07e04'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2501 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:2507 #: C/index-in.docbook:2519 msgid "ColumnView" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2509 msgid "The ColumnView shows a 1-dimensional list with one or more columns." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2513 msgid "Reference" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:2521 msgctxt "_" msgid "external ref='figures/listmodel_columnview.png' md5='fd8445f1904773397a7252bf843e2c38'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2525 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2532 #: C/index-in.docbook:3126 msgid "Sorting" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2534 msgid "The list can be sorted by wrapping it in a SortListModel. There are two ways to do this." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:2539 msgid "In a ColumnView, get the ColumnViewSorter from the ColumnView and set it to the SortListModel. Set a Sorter to each ColumnViewColumn. Then the user of your app can sort the items by clicking on a column heading." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:2544 msgid "In any view, set a Sorter such as a StringSorter or a NumericSorter to the SortListModel." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2549 msgid "SortListModel Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2550 msgid "StringSorter Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2551 msgid "NumericSorter Reference" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:2557 msgid "SortListModel" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:2559 msgctxt "_" msgid "external ref='figures/listmodel_sort.png' md5='9f6ee5fc4c2f03172fefc8027d97063e'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2563 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2569 msgid "Filtering" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2571 msgid "The list can be filtered by wrapping it in a FilterListModel. Set a Filter such as a StringFilter or a BoolFilter to the FilterListModel." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2577 msgid "FilterListModel Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2578 msgid "StringFilter Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2579 msgid "BoolFilter Reference" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:2585 msgid "FilterListModel" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:2587 msgctxt "_" msgid "external ref='figures/listmodel_filter.png' md5='b1407e88c99b90c2ad7698ce30a46a1e'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2591 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2597 msgid "Displaying Trees" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2599 msgid "While the deprecated TreeView provided built-in support for trees, the list widgets, and in particular Gio::ListModel, do not. However, gtkmm provides functionality to make trees look and behave like lists for the people who still want to display lists. This is achieved by using the TreeListModel to flatten a tree into a list. The TreeExpander widget can then be used inside a listitem to allow users to expand and collapse rows." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2609 msgid "TreeListModel Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2610 msgid "TreeExpander Reference" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:2616 msgid "TreeListModel" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:2618 msgctxt "_" msgid "external ref='figures/listmodel_tree.png' md5='656307ee78c8fd9ac379f2a0d01b8a81'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2622 msgid "Source Code" msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:2630 msgid "The TreeView widget" msgstr "" #. (itstool) path: note/para #: C/index-in.docbook:2632 msgid "Gtk::TreeView is deprecated since gtkmm 4.10. In new code, use Gtk::ListView for lists and Gtk::ColumnView for tabular lists." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:2637 msgid "The Gtk::TreeView widget can contain lists or trees of data, in columns." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2643 msgid "The Model" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2645 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2655 msgid "Although you can theoretically implement your own Model, you will normally use either the ListStore or TreeStore model classes." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2661 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2664 msgid "ListStore, for rows" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2666 msgid "The ListStore contains simple rows of data, and each row has no children." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:2672 #: C/index-in.docbook:3249 msgid "TreeView - ListStore" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:2674 #: C/index-in.docbook:3251 msgctxt "_" msgid "external ref='figures/treeview_list.png' md5='60e5e4ecb284d0cdc53373fe0ec858ee'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2678 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2683 msgid "TreeStore, for a hierarchy" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2685 msgid "The TreeStore contains rows of data, and each row may have child rows." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:2691 #: C/index-in.docbook:3269 msgid "TreeView - TreeStore" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:2693 #: C/index-in.docbook:3271 msgctxt "_" msgid "external ref='figures/treeview_tree.png' md5='2270025659b23ebfc0e38d8b629289ef'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2697 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2702 msgid "Model Columns" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2704 msgid "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." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:2715 #, no-wrap msgid "" "class ModelColumns : public Gtk::TreeModelColumnRecord\n" "{\n" "public:\n" "\n" " ModelColumns()\n" " { add(m_col_text); add(m_col_number); }\n" "\n" " Gtk::TreeModelColumn<Glib::ustring> m_col_text;\n" " Gtk::TreeModelColumn<int> m_col_number;\n" "};\n" "\n" "ModelColumns m_Columns;" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2728 msgid "You specify the ColumnRecord when creating the Model, like so:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:2732 #, no-wrap msgid "" "Glib::RefPtr<Gtk::ListStore> refListStore =\n" " Gtk::ListStore::create(m_Columns);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2734 msgid "As a TreeModelColumnRecord describes structure, not data, it can be shared among multiple models, and this is preferable for efficiency. However, the instance (such as m_Columns here) should usually not be static, because it often needs to be instantiated after glibmm has been initialized. The best solution is to make it a lazily instantiated singleton, so that it will be constructed on-demand, whenever the first model accesses it." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2746 msgid "Adding Rows" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2748 msgid "Add rows to the model with the append(), prepend(), or insert() methods." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:2752 #, no-wrap msgid "" "auto iter = m_refListStore->append();" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2753 msgid "You can dereference the iterator to get the Row:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:2755 #, no-wrap msgid "" "auto row = *iter;" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2757 msgid "Adding child rows" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2758 msgid "Gtk::TreeStore models can have child items. Add them with the append(), prepend(), or insert() methods, like so:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:2763 #, no-wrap msgid "" "auto iter_child =\n" " m_refTreeStore->append(row.children());" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2770 msgid "Setting values" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2772 msgid "You can use the operator[] overload to set the data for a particular column in the row, specifying the TreeModelColumn used to create the model." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:2777 #, no-wrap msgid "" "row[m_Columns.m_col_text] = \"sometext\";" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2781 msgid "Getting values" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2783 msgid "You can use the operator[] overload to get the data in a particular column in a row, specifying the TreeModelColumn used to create the model." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:2788 #, no-wrap msgid "" "auto strText = row[m_Columns.m_col_text];\n" "auto number = row[m_Columns.m_col_number];" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2790 msgid "The compiler will complain if you use an inappropriate type. For instance, this would generate a compiler error:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:2794 #, no-wrap msgid "" "//compiler error - no conversion from ustring to int.\n" "int number = row[m_Columns.m_col_text];" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2799 msgid "\"Hidden\" Columns" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2801 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2812 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2819 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2822 msgid "Using a Model" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2824 msgid "You can specify a Gtk::TreeModel when constructing the Gtk::TreeView, or you can use the set_model() method, like so:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:2829 #, no-wrap msgid "" "m_TreeView.set_model(m_refListStore);" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2833 msgid "Adding View Columns" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2835 msgid "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." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:2840 #, no-wrap msgid "" "m_TreeView.append_column(\"Messages\", m_Columns.m_col_text);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2841 msgid "When using this simple append_column() overload, 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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2857 msgid "More than one Model Column per View Column" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2859 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2865 msgid "Then use append_column() to add the view Column to the View. Notice that Gtk::TreeView::append_column() is overloaded to accept either a prebuilt Gtk::TreeView::Column widget, or just the TreeModelColumn from which it generates an appropriate Gtk::TreeView::Column widget." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2872 msgid "Here is some example code, which has a pixbuf icon and a text name in the same column:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:2875 #, no-wrap msgid "" "auto pColumn = Gtk::make_managed<Gtk::TreeView::Column>(\"Icon Name\");\n" "\n" "// m_columns.icon and m_columns.iconname are columns in the model.\n" "// pColumn is the column in the TreeView:\n" "pColumn->pack_start(m_columns.icon, /* expand= */ false);\n" "pColumn->pack_start(m_columns.iconname);\n" "\n" "m_TreeView.append_column(*pColumn);" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2886 msgid "Specifying CellRenderer details" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2888 msgid "The default CellRenderers and their default behavior will normally suffice, but you might occasionally need finer control. For instance, this example code from gtkmm/demos/gtk-demo/example_treeview_treestore.cc, appends a Gtk::CellRenderer widget and instructs it to render the data from various model columns through various aspects of its appearance." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:2896 #, no-wrap msgid "" "auto cols_count = m_TreeView.append_column_editable(\"Alex\", m_columns.alex);\n" "auto pColumn = m_TreeView.get_column(cols_count-1);\n" "if(pColumn)\n" "{\n" " auto pRenderer = static_cast<Gtk::CellRendererToggle*>(pColumn->get_first_cell());\n" " pColumn->add_attribute(pRenderer->property_visible(), m_columns.visible);\n" " pColumn->add_attribute(pRenderer->property_activatable(), m_columns.world);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2904 msgid "You can also connect to CellRenderer signals to detect user actions. For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:2908 #, no-wrap msgid "" "auto pRenderer = Gtk::make_managed<Gtk::CellRendererToggle>();\n" "pRenderer->signal_toggled().connect(\n" " sigc::bind( sigc::mem_fun(*this,\n" " &Example_TreeView_TreeStore::on_cell_toggled), m_columns.dave)\n" ");" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2916 #: C/index-in.docbook:3280 msgid "Editable Cells" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2919 msgid "Automatically-stored editable cells." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2921 msgid "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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2935 msgid "Implementing custom logic for editable cells." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2937 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2942 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2948 msgid "You should then cast that Gtk::CellRenderer* to the specific CellRenderer that you expect, so you can use specific API." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2952 msgid "For instance, for a CellRendererText, you would set the cell's editable property to true, like so:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:2955 #, no-wrap msgid "" "cell->property_editable() = true;" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2956 msgid "For a CellRendererToggle, you would set the activatable property instead." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2960 msgid "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_cells() on that view Column." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2968 msgid "In your signal handler, you should examine the new value and then store it in the Model if that is appropriate for your application." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:2977 msgid "Iterating over Model Rows" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2979 msgid "Gtk::TreeModel provides a C++ Standard Library-style container of its children, via the children() method. You can use the familiar begin() and end() methods iterator incrementing, like so:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:2985 #, no-wrap msgid "" "auto children = refModel->children();\n" "for (auto iter = children.begin(), end = children.end(); iter != end; ++iter)\n" "{\n" " auto row = *iter;\n" " //Do something with the row - see above for set/get.\n" "}" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:2991 msgid "If you always want to iterate across the entire range, much more succinct syntax is possible using C++'s range-based for loop:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:2995 #, no-wrap msgid "" "for (auto row: refModel->children())\n" "{\n" " //Do something with the row - see above for set/get.\n" "}" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3001 msgid "Row children" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3003 msgid "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 container of child Rows:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3008 #, no-wrap msgid "" "Gtk::TreeModel::Children children = row.children();" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3014 msgid "The Selection" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3016 msgid "To find out what rows the user has selected, get the Gtk::TreeView::Selection object from the TreeView, like so:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3021 #, no-wrap msgid "" "auto refTreeSelection = m_TreeView.get_selection();" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3024 msgid "Single or multiple selection" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3026 msgid "By default, only single rows can be selected, but you can allow multiple selection by setting the mode, like so:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3030 #, no-wrap msgid "" "refTreeSelection->set_mode(Gtk::SelectionMode::MULTIPLE);" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3034 msgid "The selected rows" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3036 msgid "For single-selection, you can just call get_selected(), like so:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3040 #, no-wrap msgid "" "auto iter = refTreeSelection->get_selected();\n" "if(iter) //If anything is selected\n" "{\n" " auto row = *iter;\n" " //Do something with the row.\n" "}" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3047 msgid "For multiple-selection, you need to call get_selected_rows() or define a callback, and give it to selected_foreach(), selected_foreach_path(), or selected_foreach_iter(), like so:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3054 #, no-wrap msgid "" "refTreeSelection->selected_foreach_iter(\n" " sigc::mem_fun(*this, &TheClass::selected_row_callback) );\n" "\n" "void TheClass::selected_row_callback(\n" " const Gtk::TreeModel::const_iterator& iter)\n" "{\n" " auto row = *iter;\n" " //Do something with the row.\n" "}" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3067 msgid "The \"changed\" signal" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3069 msgid "To respond to the user clicking on a row or range of rows, connect to the signal like so:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3073 #, no-wrap msgid "" "refTreeSelection->signal_changed().connect(\n" " sigc::mem_fun(*this, &Example_IconTheme::on_selection_changed)\n" ");" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3079 msgid "Preventing row selection" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3081 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3086 msgid "To control which rows can be selected, use the set_select_function() method, providing a sigc::slot callback. For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3091 #, no-wrap msgid "" "m_refTreeSelection->set_select_function( sigc::mem_fun(*this,\n" " &DemoWindow::select_function) );" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3093 msgid "and then" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3096 #, no-wrap msgid "" "bool DemoWindow::select_function(\n" " const Glib::RefPtr<Gtk::TreeModel>& model,\n" " const Gtk::TreeModel::Path& path, bool)\n" "{\n" " const auto iter = model->get_iter(path);\n" " return iter->children().empty(); // only allow leaf nodes to be selected\n" "}" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3106 msgid "Changing the selection" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3108 msgid "To change the selection, specify a Gtk::TreeModel::iterator or Gtk::TreeModel::Row, like so:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3113 #, no-wrap msgid "" "auto row = m_refModel->children()[5]; //The sixth row.\n" "if(row)\n" " refTreeSelection->select(row.get_iter());" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3116 msgid "or" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3119 #, no-wrap msgid "" "auto iter = m_refModel->children().begin()\n" "if(iter)\n" " refTreeSelection->select(iter);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3128 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3132 msgid "TreeSortable Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3135 msgid "Sorting by clicking on columns" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3137 msgid "So that a user can click on a TreeView's column header to sort the TreeView's contents, call Gtk::TreeView::Column::set_sort_column(), supplying the model column on which model should be sorted when the header is clicked. For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3140 #, no-wrap msgid "" "auto pColumn = treeview.get_column(0);\n" "if(pColumn)\n" " pColumn->set_sort_column(m_columns.m_col_id);" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3146 msgid "Independently sorted views of the same model" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3148 msgid "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::TreeViewColumn::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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3156 #, no-wrap msgid "" "auto sorted_model = Gtk::TreeModelSort::create(model);\n" "sorted_model->set_sort_column(columns.m_col_name, Gtk::SortType::ASCENDING);\n" "treeview.set_model(sorted_model);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3160 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3162 #, no-wrap msgid "" "void ExampleWindow::on_button_delete()\n" "{\n" " auto refTreeSelection = m_treeview.get_selection();\n" " if(refTreeSelection)\n" " {\n" " auto sorted_iter = m_refTreeSelection->get_selected();\n" " if(sorted_iter)\n" " {\n" " auto iter = m_refModelSort->convert_iter_to_child_iter(sorted_iter);\n" " m_refModel->erase(iter);\n" " }\n" " }\n" "}" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3176 msgid "TreeModelSort Reference" msgstr "" #. (itstool) path: section/title #. (itstool) path: chapter/title #. (itstool) path: figure/title #: C/index-in.docbook:3182 #: C/index-in.docbook:3300 #: C/index-in.docbook:5268 #: C/index-in.docbook:5426 msgid "Drag and Drop" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3184 msgid "Gtk::TreeView already implements simple drag-and-drop when used with the Gtk::ListStore or Gtk::TreeStore models (since gtk 4.8). If necessary, it also allows you to implement more complex behavior when items are dragged and dropped, using the normal Drag and Drop API." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3193 msgid "Reorderable rows" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3195 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3200 msgid "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_vfunc() and Gtk::TreeDragDest::row_drop_possible_vfunc() virtual methods. You can examine the Gtk::TreeModel::Paths provided and allow or disallow dragging or dropping by returning true or false." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3207 msgid "This is demonstrated in the drag_and_drop example." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3213 #: C/index-in.docbook:3323 msgid "Popup Context Menu" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3215 msgid "Lots of people need to implement right-click context menus for TreeViews so we will explain how to do that here to save you some time. It's much the same as a normal context menu, as described in the menus chapter. You use a Gtk::GestureClick to detect the mouse click." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3222 msgid "This is demonstrated in the Popup Context Menu example. In that example a derived TreeView is used, but that's not necessary." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3229 #: C/index-in.docbook:3930 #: C/index-in.docbook:4221 #: C/index-in.docbook:5542 #: C/index-in.docbook:5934 msgid "Examples" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3231 msgid "Some TreeView examples are shown here. There are more examples in the treeview directory in gtkmm-documentation's examples." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3235 msgid "If neither ListStore nor TreeStore is suitable for your application, look at the custom TreeModel example. It shows how you can make your own implementation of the TreeModel interface." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3242 msgid "ListStore" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3243 msgid "This example has a Gtk::TreeView widget, with a Gtk::ListStore model." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3255 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3260 msgid "TreeStore" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3262 msgid "This example is very similar to the ListStore example, but uses a Gtk::TreeStore model instead, and adds children to the rows." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3275 msgid "Source Code" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3282 msgid "This example is identical to the ListStore example, but it uses TreeView::append_column_editable() instead of TreeView::append_column()." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:3289 msgid "TreeView - Editable Cells" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:3291 msgctxt "_" msgid "external ref='figures/treeview_editablecells.png' md5='b4c81c776d192afdc3685fd4a8ef178c'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3295 msgid "Source Code" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3302 msgid "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." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:3312 msgid "TreeView - Drag And Drop" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:3314 msgctxt "_" msgid "external ref='figures/treeview_draganddrop.png' md5='fb5de06eb865e9bd312f0b020e8f631d'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3318 msgid "Source Code" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3325 msgid "This example is much like the ListStore example, but derives a custom TreeView to encapsulate the tree model code and popup menu code in our derived class. See the TreeView Popup Context Menu section." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:3333 msgid "TreeView - Popup Context Menu" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:3335 msgctxt "_" msgid "external ref='figures/treeview_popup.png' md5='29c7b04f9f865c6ae8214cbb1724b05f'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3339 msgid "Source Code" msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:3346 msgid "The DropDown Widget" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:3348 msgid "The DropDown widget is an alternative to the deprecated ComboBox. It uses list models instead of tree models, and the content is displayed using widgets instead of cell renderers." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:3353 msgid "The DropDown widget offers a list of choices in a dropdown menu. If appropriate, it can show extra information about each item, such as text, a picture, or a check button. The DropDown widget can optionally have an Entry in the dropdown menu, allowing the user to search in a long list." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:3360 msgid "The list is provided via a Gio::ListModel, and data from this model is added to the DropDown's view with signal handlers connected to a SignalListItemFactory. This provides flexibility, but the StringList class provides a simpler text-based specialization in case that flexibility is not required." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:3367 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3370 #: C/index-in.docbook:3545 msgid "The model" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3372 msgid "The model for a DropDown can be defined and filled exactly as for a ListView or a ColumnView. It must be a subclass of Glib::Object. For instance, you might have a DropDown with one integer and one text column, like so:" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3400 msgid "After appending rows to this model, you should provide the model to the DropDown with the set_model() method. Unless you use the StringList model, you also need to set a ListItemFactory with set_factory(). If you want the items in the dropdown menu to look different from the item in the DropDown widget, you also need to set a separate ListItemFactory with set_list_factory()." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3411 msgid "The selected item" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3413 msgid "To discover what item, if any, the user has selected from the DropDown, call DropDown::get_selected(). This returns an unsigned int that you can use to get the selected data from the model. 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 DropDown. For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3420 #, no-wrap msgid "" "unsigned int sel = m_DropDown.get_selected();\n" "if (sel != GTK_INVALID_LIST_POSITION)\n" "{\n" " // Get the data for the selected row, using our knowledge of the list model:\n" " auto id = m_ListStore->get_item(sel).m_col_id;\n" " set_some_id_chosen(id); // Your own function.\n" "}\n" "else\n" " set_nothing_chosen(); // Your own function.\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3433 #: C/index-in.docbook:3584 #: C/index-in.docbook:3645 msgid "Responding to changes" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3435 msgid "You might need to react to every change of selection in the DropDown, for instance to update other widgets. To do so, you should connect to property_selected().signal_changed(). For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3439 #, no-wrap msgid "" "m_DropDown.property_selected().signal_changed().connect(\n" " sigc::mem_fun(*this, &ExampleWindow::on_dropdown_changed));\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3445 msgid "Simple String Example" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:3448 msgid "Simple DropDown" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:3450 msgctxt "_" msgid "external ref='figures/dropdown_string.png' md5='b1689605c645e1ada3040f6df3335c56'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3454 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3458 msgid "Examples with a Search Entry" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3460 msgid "The dropdown menu may contain an Entry that allows to search for items in the list. Call set_enable_search() and set_expression(). For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3464 #, no-wrap msgid "" "m_DropDown.set_enable_search(true);\n" "auto expression = Gtk::ClosureExpression<Glib::ustring>::create(\n" " sigc::mem_fun(*this, &ExampleWindow::get_col_name));\n" "m_DropDown.set_expression(expression);\n" "\n" "//-------\n" "Glib::ustring ExampleWindow::get_col_name(const Glib::RefPtr<Glib::ObjectBase>& item)\n" "{\n" " const auto col = std::dynamic_pointer_cast<ModelColumns>(item);\n" " return col ? col->m_col_name : \"\";\n" "}\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3478 msgid "String Example" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:3481 msgid "Search String" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:3483 msgctxt "_" msgid "external ref='figures/dropdown_search_string.png' md5='e130e644e7cfb13a5b90ab1372b17503'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3487 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3491 msgid "Font Example" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3493 msgid "This example uses a Pango::FontMap as its model. This is possible because Pango::FontMap implements the Gio::ListModel interface. Of course you can use a FontDialogButton instead." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:3500 #: C/index-in.docbook:3519 msgid "Search Font" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:3502 msgctxt "_" msgid "external ref='figures/dropdown_search_font.png' md5='1733e29c88c19dc6c4cbd1114446ac18'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3506 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3511 msgid "Complex Example" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3513 msgid "This is a more complex example with two SignalListItemFactory objects and their signal handlers. This example would be simpler without the checkmark in the dropdown menu." msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:3521 msgctxt "_" msgid "external ref='figures/dropdown_complex.png' md5='2167fb44e42653aa7fd855604c4c1e65'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3525 msgid "Source Code" msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:3530 msgid "Combo Boxes" msgstr "" #. (itstool) path: note/para #: C/index-in.docbook:3532 msgid "Gtk::ComboBox and Gtk::ComboBoxText are deprecated since gtkmm 4.10. Use Gtk::DropDown in new code." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:3536 msgid "The ComboBox widget offers a list (or tree) of choices in a dropdown menu. If appropriate, it can show extra information about each item, such as text, a picture, a check button, or a progress bar. The ComboBox widget usually restricts the user to the available choices, but it can optionally have an Entry, allowing the user to enter arbitrary text if none of the available choices are suitable." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:3539 msgid "The list is provided via a TreeModel, and columns from this model are added to the ComboBox's view with the ComboBox::pack_start() method. This provides flexibility and compile-time type-safety, but the ComboBoxText class provides a simpler text-based specialization in case that flexibility is not required." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:3542 msgid "Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3547 msgid "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 column, like so:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3549 #, no-wrap msgid "" "class ModelColumns : public Gtk::TreeModel::ColumnRecord\n" "{\n" "public:\n" " ModelColumns()\n" " { add(m_col_id); add(m_col_name); }\n" "\n" " Gtk::TreeModelColumn<int> m_col_id;\n" " Gtk::TreeModelColumn<Glib::ustring> m_col_name;\n" "};\n" "\n" "ModelColumns m_columns;" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3561 msgid "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 columns 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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3565 msgid "The chosen item" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3567 msgid "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 ComboBox. For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3569 #, no-wrap msgid "" "Gtk::TreeModel::iterator iter = m_Combo.get_active();\n" "if(iter)\n" "{\n" " auto row = *iter;\n" "\n" " //Get the data for the selected row, using our knowledge\n" " //of the tree model:\n" " auto id = row[m_Columns.m_col_id];\n" " set_something_id_chosen(id); //Your own function.\n" "}\n" "else\n" " set_nothing_chosen(); //Your own function." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3586 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3589 #, no-wrap msgid "" "m_combo.signal_changed().connect( sigc::mem_fun(*this,\n" " &ExampleWindow::on_combo_changed) );" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3594 #: C/index-in.docbook:3680 msgid "Full Example" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:3597 msgid "ComboBox" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:3599 msgctxt "_" msgid "external ref='figures/combobox_complex.png' md5='ec96e29fe85caef072868284443e413e'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3603 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3608 #: C/index-in.docbook:3694 msgid "Simple Text Example" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:3611 msgid "ComboBoxText" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:3613 msgctxt "_" msgid "external ref='figures/combobox_text.png' md5='f8278861eaa5cdc1d165b577fc41ccf4'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3617 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3622 msgid "ComboBox with an Entry" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3624 msgid "A ComboBox may contain an Entry widget for entering of arbitrary text, by specifying true for the constructor's has_entry parameter." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3627 msgid "The text column" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3629 msgid "So that the Entry can interact with the drop-down list of choices, you must specify which of your model columns is the text column, with set_entry_text_column(). For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3631 #, no-wrap msgid "" "m_combo.set_entry_text_column(m_columns.m_col_name);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3632 msgid "When you select a choice from the drop-down menu, the value from this column will be placed in the Entry." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3638 msgid "The entry" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3640 msgid "Because the user may enter arbitrary text, an active model row isn't enough to tell us what text the user has entered. Therefore, you should retrieve the Entry widget with the ComboBox::get_entry() method and call get_text() on that." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3647 msgid "When the user enters arbitrary text, it may not be enough to connect to the changed signal, which is emitted for every typed character. It is not emitted when the user presses the Enter key. Pressing the Enter key or moving the keyboard focus to another widget may signal that the user has finished entering text. To be notified of these events, connect to the Entry's activate signal (available since gtkmm 4.8), and add a Gtk::EventControllerFocus and connect to its leave signal, like so" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3657 #, no-wrap msgid "" "auto entry = m_Combo.get_entry();\n" "if (entry)\n" "{\n" " // Alternatively you can connect to m_Combo.signal_changed().\n" " entry->signal_changed().connect(sigc::mem_fun(*this,\n" " &ExampleWindow::on_entry_changed));\n" " entry->signal_activate().connect(sigc::mem_fun(*this,\n" " &ExampleWindow::on_entry_activate));\n" " // The Entry shall receive focus-leave events.\n" " auto controller = Gtk::EventControllerFocus::create();\n" " m_ConnectionFocusLeave = controller->signal_leave().connect(\n" " sigc::mem_fun(*this, &ExampleWindow::on_entry_focus_leave));\n" " entry->add_controller(controller);\n" "}" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3671 msgid "The changed signals of ComboBox and Entry are both emitted for every change. It doesn't matter which one you connect to. But the EventControllerFocus must be added to the Entry." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:3683 msgid "ComboBox with Entry" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:3685 msgctxt "_" msgid "external ref='figures/comboboxentry_complex.png' md5='09bd46bc2fb93193ed4f9cf910ede733'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3689 msgid "Source Code" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:3697 msgid "ComboBoxText with Entry" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:3699 msgctxt "_" msgid "external ref='figures/comboboxentry_text.png' md5='164e857e073b574d6176927c8247ad96'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3703 msgid "Source Code" msgstr "" #. (itstool) path: chapter/title #. (itstool) path: figure/title #: C/index-in.docbook:3711 #: C/index-in.docbook:3936 msgid "TextView" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:3713 msgid "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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3721 msgid "The Buffer" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3723 msgid "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::TextViews to share the same TextBuffer, and allows those TextBuffers to be displayed slightly differently. Or you could maintain several Gtk::TextBuffers and choose to display each one at different times in the same Gtk::TextView widget." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3733 msgid "The TextView creates its own default TextBuffer, which you can access via the get_buffer() method." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3739 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3742 msgid "Iterators" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3744 msgid "A Gtk::TextBuffer::iterator and a Gtk::TextBuffer::const_iterator represent a position between two characters in the text buffer. Whenever the buffer is modified in a way that affects the number of characters in the buffer, all outstanding iterators become invalid. Because of this, iterators can't be used to preserve positions across buffer modifications. To preserve a position, use Gtk::TextBuffer::Mark." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3751 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3755 msgid "Tags and Formatting" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3758 msgid "Tags" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3760 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3763 #, no-wrap msgid "" "auto refTagMatch = Gtk::TextBuffer::Tag::create();\n" "refTagMatch->property_background() = \"orange\";" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3765 msgid "You can specify a name for the Tag when using the create() method, but it is not necessary." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3770 msgid "The Tag class has many other properties." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3774 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3779 msgid "TagTable" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3781 msgid "Each Gtk::TextBuffer uses a Gtk::TextBuffer::TagTable, which contains the Tags for that buffer. 2 or more TextBuffers may share the same TagTable. When you create Tags you should add them to the TagTable. For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3789 #, no-wrap msgid "" "auto refTagTable = Gtk::TextBuffer::TagTable::create();\n" "refTagTable->add(refTagMatch);\n" "//Hopefully a future version of gtkmm will have a set_tag_table() method,\n" "//for use after creation of the buffer.\n" "auto refBuffer = Gtk::TextBuffer::create(refTagTable);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3795 msgid "You can also use get_tag_table() to get, and maybe modify, the TextBuffer's default TagTable instead of creating one explicitly." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3801 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3806 msgid "Applying Tags" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3808 msgid "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::iterators. For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3815 #, no-wrap msgid "" "refBuffer->apply_tag(refTagMatch, iterRangeStart, iterRangeStop);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3816 msgid "Or you could specify the tag when first inserting the text:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3819 #, no-wrap msgid "" "refBuffer->insert_with_tag(iter, \"Some text\", refTagMatch);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3821 msgid "You can apply more than one Tag to the same text, by using apply_tag() more than once, or by using insert_with_tags(). The Tags might specify different values for the same properties, but you can resolve these conflicts by using Tag::set_priority()." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3833 msgid "Marks" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3835 msgid "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," msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3840 #, no-wrap msgid "" "auto refMark = refBuffer->create_mark(iter);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3842 msgid "You can then use the get_iter() method later to create an iterator for the Mark's new position." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3847 msgid "There are two built-in Marks - insert and selection_bound, which you can access with TextBuffer's get_insert() and get_selection_bound() methods." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3854 msgid "Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3861 msgid "As mentioned above, each TextView has a TextBuffer, and one or more TextViews can share the same TextBuffer." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3868 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3875 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3878 msgid "Default formatting" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3880 msgid "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::TextTags in the buffer, if they specify the same things. For instance, set_left_margin(), set_right_margin(), set_indent(), etc." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3891 msgid "Scrolling" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3893 msgid "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() to show the found text." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3908 msgid "Widgets and ChildAnchors" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3910 msgid "You can embed widgets, such as Gtk::Buttons, 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():" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3917 #, no-wrap msgid "" "auto refAnchor = refBuffer->create_child_anchor(iter);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3919 msgid "Then, to add a widget at that position, use Gtk::TextView::add_child_at_anchor():" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3923 #, no-wrap msgid "" "m_TextView.add_child_at_anchor(m_Button, refAnchor);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3925 msgid "Reference" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:3938 msgctxt "_" msgid "external ref='figures/textview.png' md5='451e30f66cc32c4231bb6bc442cf0d2f'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3942 msgid "Source Code" msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:3949 msgid "Menus and Toolbars" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:3951 msgid "There are specific APIs for menus and toolbars, but you should usually deal with them together, creating Gio::SimpleActions that you can refer to in both menus 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. Gtk::Builder can create menus and toolbars." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:3959 msgid "This involves the use of the Gio::SimpleActionGroup, Gio::SimpleAction and Gtk::Builder classes, all of which should be instantiated via their create() methods, which return RefPtrs." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:3967 msgid "Actions" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3969 msgid "First create the Gio::SimpleActions and add them to a Gio::SimpleActionGroup, with Gio::ActionMap::add_action(). (Gio::ActionMap is a base class of Gio::SimpleActionGroup.) Then add the action group to your window with Gtk::Widget::insert_action_group()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3977 msgid "The arguments to add_action() specify the action's name, which is used in the menu items and toolbar buttons. You can also specify a signal handler when calling add_action(). This signal handler will be called when the action is activated via either a menu item or a toolbar button." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3985 #: C/index-in.docbook:4108 msgid "For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:3987 #, no-wrap msgid "" "m_refActionGroup = Gio::SimpleActionGroup::create();\n" "\n" "m_refActionGroup->add_action(\"new\", sigc::mem_fun(*this, &ExampleWindow::on_action_file_new));\n" "m_refActionGroup->add_action(\"open\", sigc::mem_fun(*this, &ExampleWindow::on_action_file_open));\n" "m_refActionGroup->add_action(\"quit\", sigc::mem_fun(*this, &ExampleWindow::on_action_file_quit));\n" "\n" "insert_action_group(\"example\", m_refActionGroup);\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:3996 msgid "If you use an Gtk::ApplicationWindow, you don't have to create your own action group. Gio::ActionGroup and Gio::ActionMap are base classes of Gtk::ApplicationWindow." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4007 msgid "Menubar and Toolbar" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4009 msgid "Next you should create a Gtk::Builder. At this point is also a good idea to tell the application to respond to keyboard shortcuts, by using Gtk::Application::set_accel_for_action()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4015 #: C/index-in.docbook:5720 #: C/index-in.docbook:5784 #: C/index-in.docbook:11413 msgid "For instance," msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:4017 #, no-wrap msgid "" "m_refBuilder = Gtk::Builder::create();\n" "\n" "app->set_accel_for_action(\"example.new\", \"<Primary>n\");\n" "app->set_accel_for_action(\"example.quit\", \"<Primary>q\");\n" "app->set_accel_for_action(\"example.copy\", \"<Primary>c\");\n" "app->set_accel_for_action(\"example.paste\", \"<Primary>v\");\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4035 msgid "Then, you can define the actual visible layout of the menus and toolbars, and add the UI layout to the Builder. This \"ui string\" uses an XML format, in which you should mention the names of the actions that you have already created. For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:4041 #, no-wrap msgid "" "Glib::ustring ui_info =\n" " \"<interface>\"\n" " \" <menu id='menubar'>\"\n" " \" <submenu>\"\n" " \" <attribute name='label' translatable='yes'>_File</attribute>\"\n" " \" <section>\"\n" " \" <item>\"\n" " \" <attribute name='label' translatable='yes'>_New</attribute>\"\n" " \" <attribute name='action'>example.new</attribute>\"\n" " \" </item>\"\n" " \" </section>\"\n" " \" <section>\"\n" " \" <item>\"\n" " \" <attribute name='label' translatable='yes'>_Quit</attribute>\"\n" " \" <attribute name='action'>example.quit</attribute>\"\n" " \" </item>\"\n" " \" </section>\"\n" " \" </submenu>\"\n" " \" <submenu>\"\n" " \" <attribute name='label' translatable='yes'>_Edit</attribute>\"\n" " \" <item>\"\n" " \" <attribute name='label' translatable='yes'>_Copy</attribute>\"\n" " \" <attribute name='action'>example.copy</attribute>\"\n" " \" </item>\"\n" " \" <item>\"\n" " \" <attribute name='label' translatable='yes'>_Paste</attribute>\"\n" " \" <attribute name='action'>example.paste</attribute>\"\n" " \" </item>\"\n" " \" </submenu>\"\n" " \" </menu>\"\n" " \"</interface>\";\n" "\n" "m_refBuilder->add_from_string(ui_info);\n" "m_refBuilder->add_from_resource(\"/toolbar/toolbar.ui\");\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4077 msgid "This is where we specify the names of the menu items as they will be seen by users in the menu. Therefore, this is where you should make strings translatable, by adding translatable='yes'." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4081 msgid "To instantiate a Gtk::PopoverMenuBar and toolbar (a horizontal Gtk::Box) which you can actually show, you should use the Builder::get_object() and Builder::get_widget() methods, and then add the widgets to a container. For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:4088 #, no-wrap msgid "" "auto gmenu = m_refBuilder->get_object<Gio::Menu>(\"menubar\");\n" "auto pMenuBar = Gtk::make_managed<Gtk::PopoverMenuBar>(gmenu);\n" "m_Box.append(*pMenuBar);\n" "\n" "auto toolbar = m_refBuilder->get_widget<Gtk::Box>(\"toolbar\");\n" "m_Box.append(*toolbar);\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4100 msgid "Popup Menus" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4101 msgid "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." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:4110 #, no-wrap msgid "" "Glib::ustring ui_info =\n" " \"<interface>\"\n" " \" <menu id='menu-examplepopup'>\"\n" " \" <section>\"\n" " \" <item>\"\n" " \" <attribute name='label' translatable='yes'>Edit</attribute>\"\n" " \" <attribute name='action'>examplepopup.edit</attribute>\"\n" " \" </item>\"\n" " \" <item>\"\n" " \" <attribute name='label' translatable='yes'>Process</attribute>\"\n" " \" <attribute name='action'>examplepopup.process</attribute>\"\n" " \" </item>\"\n" " \" <item>\"\n" " \" <attribute name='label' translatable='yes'>Remove</attribute>\"\n" " \" <attribute name='action'>examplepopup.remove</attribute>\"\n" " \" </item>\"\n" " \" </section>\"\n" " \" </menu>\"\n" " \"</interface>\";\n" "\n" "m_refBuilder->add_from_string(ui_info);\n" "\n" "auto gmenu = m_refBuilder->get_object<Gio::Menu>(\"menu-examplepopup\");\n" "m_MenuPopup.set_menu_model(gmenu);\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4136 msgid "To show the popup menu, use a Gtk::GestureClick and connect to its pressed signal. In the signal handler, use Gtk::PopoverMenu's popup() method. For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:4142 #, no-wrap msgid "" "void ExampleWindow::on_label_pressed(int /* n_press */, double x, double y)\n" "{\n" " const Gdk::Rectangle rect(x, y, 1, 1);\n" " m_MenuPopup.set_pointing_to(rect);\n" " m_MenuPopup.popup();\n" "}" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4152 msgid "Gio::Resource and glib-compile-resources" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4154 msgid "Applications and libraries often contain binary or textual data that is really part of the application, rather than user data. For instance Gtk::Builder .ui files, splashscreen images, Gio::Menu markup xml, CSS files, icons, etc. These are often shipped as files in $datadir/appname, or manually included as literal strings in the code." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4162 msgid "The Gio::Resource API and the glib-compile-resources program provide a convenient and efficient alternative to this, which has some nice properties. You maintain the files as normal files, so it's easy to edit them, but during the build the files are combined into a binary bundle that is linked into the executable. This means that loading the resource files is efficient (as they are already in memory, shared with other instances) and simple (no need to check for things like I/O errors or locate the files in the filesystem). It also makes it easier to create relocatable applications." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4174 msgid "Resource bundles are created by the glib-compile-resources program which takes an xml file that describes the bundle, and a set of files that the xml references. These are combined into a binary resource bundle." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4179 msgid "Gio::Resource Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4180 msgid "An example:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:4181 #, no-wrap msgid "" "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" "<gresources>\n" " <gresource prefix=\"/toolbar\">\n" " <file preprocess=\"xml-stripblanks\">toolbar.ui</file>\n" " <file>rain.png</file>\n" " </gresource>\n" "</gresources>\n" "" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:4191 msgid "/toolbar/toolbar.ui" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:4192 msgid "/toolbar/rain.png" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4189 msgid "This will create a resource bundle with the files <_:itemizedlist-1/>" msgstr "" #. (itstool) path: para/screen #: C/index-in.docbook:4200 #, no-wrap msgid "" "$ glib-compile-resources --target=resources.c --generate-source toolbar.gresource.xml" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4195 msgid "You can then use glib-compile-resources to compile the xml to a binary bundle that you can load with Gio::Resource::create_from_file(). However, it's more common to use the --generate-source argument to create a C source file to link directly into your application. E.g. <_:screen-1/>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4202 msgid "Once a Gio::Resource has been created and registered all the data in it can be accessed globally in the process by using API calls like Gio::Resource::open_stream_from_global_resources() to stream the data or Gio::Resource::lookup_data_in_global_resources() to get a direct pointer to the data. You can also use URIs like resource:///toolbar/rain.png with Gio::File to access the resource data." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4210 msgid "Often you don't need a Gio::Resource instance, because resource data can be loaded with methods such as Gdk::Pixbuf::create_from_resource(), Gtk::Builder::add_from_resource() and Gtk::Image::set_from_resource()." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4224 msgid "Application Menu and Main Menu example" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4225 msgid "This program contains an application menu, a menubar and a toolbar. Classes are derived from Gtk::Application and Gtk::ApplicationWindow." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:4232 msgid "App and Main Menu" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:4234 msgctxt "_" msgid "external ref='figures/main_menu.png' md5='fc670c5887873c4c8ec1e5aa1e032680'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4238 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4243 msgid "Main Menu example" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4244 msgid "This program contains a menubar and a toolbar. A class is derived from Gtk::Window." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:4250 msgid "Main Menu" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:4252 msgctxt "_" msgid "external ref='figures/menus_and_toolbars.png' md5='cbe894e7603b7c3de488d4c9ff503442'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4256 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4261 msgid "Popup Menu example" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:4264 msgid "Popup Menu" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:4266 msgctxt "_" msgid "external ref='figures/menu_popup.png' md5='bd168ad48b89f488d29e13db9b765168'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4270 msgid "Source Code" msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:4277 msgid "Adjustments" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:4279 msgid "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." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:4289 msgid "So that applications can react to changes, for instance when a user moves a scrollbar, Gtk::Adjustment has a value_changed signal. You can then use the get_value() method to discover the new value." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4297 msgid "Creating an Adjustment" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4299 msgid "The Gtk::Adjustment is created by its create() method which is as follows:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:4304 #, no-wrap msgid "" "Glib::RefPtr<Gtk::Adjustment> Gtk::Adjustment::create(\n" " double value,\n" " double lower,\n" " double upper,\n" " double step_increment = 1,\n" " double page_increment = 10,\n" " double page_size = 0);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4312 msgid "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 specify 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 bottommost or rightmost coordinate in a panning widget's child." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4331 msgid "Using Adjustments the Easy Way" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4333 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4338 msgid "The group which treats the values as arbitrary numbers includes the Range widgets (Scrollbar and Scale), the ScaleButton 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4350 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4359 msgid "If you share an adjustment object between a Scrollbar and a TextView widget, manipulating the scrollbar will automagically adjust the TextView widget. You can set it up like this:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:4364 #, no-wrap msgid "" "// creates its own adjustments\n" "Gtk::TextView textview;\n" "// uses the newly-created adjustment for the scrollbar as well\n" "Gtk::Scrollbar vscrollbar(textview.get_vadjustment(), Gtk::Orientation::VERTICAL);" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4372 msgid "Adjustment Internals" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4374 msgid "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:" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4382 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4391 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:4396 #, no-wrap msgid "" "void cb_rotate_picture(MyPicture* picture)\n" "{\n" " picture->set_rotation(adj->get_value());\n" "..." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4400 msgid "and connect it to the scale widget's adjustment like this:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:4403 #, no-wrap msgid "" "adj->signal_value_changed().connect(sigc::bind<MyPicture*>(sigc::mem_fun(*this,\n" " &cb_rotate_picture), picture));" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4406 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4413 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4422 msgid "You probably won't ever need to attach a handler to this signal, unless you're writing a new type of range widget." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:4426 #, no-wrap msgid "" "adjustment->signal_changed();" msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:4433 msgid "Dialogs" msgstr "" #. (itstool) path: note/para #: C/index-in.docbook:4435 msgid "Gtk::Dialog and the classes derived from it, are deprecated since gtkmm 4.10. They can still be used in gtkmm4 applications, provided GTKMM_DISABLE_DEPRECATED and GDKMM_DISABLE_DEPRECATED are not defined. Some of the dialog classes are replaced by classes that are available since gtkmm 4.10." msgstr "" #. (itstool) path: note/para #: C/index-in.docbook:4440 msgid "The examples in this chapter use classes that are available since gtkmm 4.10. Similar examples with the deprecated classes are available in the gtkmm-4-0 branch in the git repository." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:4446 msgid "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 response signal which is emitted when the user dismisses the dialog." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:4453 msgid "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." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:4460 msgid "To pack widgets into a custom dialog, you should pack them into the Gtk::Box, available via get_content_area(). To just add a Button to the bottom of the Dialog, you could use the add_button() method." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:4468 msgid "The response signal handler receives an int. This may be a value from the Gtk::ResponseType if the user closed the dialog by clicking a standard button, or it could be the custom response value that you specified when using add_button()." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:4475 msgid "To show the dialog, call set_visible(true). If the same dialog instance will be shown several times, you must also call set_hide_on_close(), or else the dialog will be destroyed when it's closed. Connect to the response signal, if you want to know which button was pressed. The response signal handler is also where you should hide the dialog." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:4484 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4487 msgid "AlertDialog and MessageDialog" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4488 msgid "MessageDialog (deprecated since gtkmm 4.10) and AlertDialog (available since gtkmm 4.10) are convenience classes, used to create simple, standard message dialogs, with a message and buttons for user response." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4495 msgid "AlertDialog Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4496 msgid "MessageDialog Reference" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:4502 msgid "AlertDialog" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:4504 msgctxt "_" msgid "external ref='figures/dialogs_alertdialog.png' md5='88fa2103ad6d842eeebc68cc8cfd94ef'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4508 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4513 msgid "FileDialog and FileChooserDialog" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4514 msgid "The FileChooserDialog (deprecated since gtkmm 4.10) and FileDialog (available since gtkmm 4.10) are suitable for use with \"Open\" or \"Save\" menu items." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4519 msgid "Most of the useful member methods for FileChooserDialog are actually in the Gtk::FileChooser base class." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4524 msgid "FileDialog Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4525 msgid "FileChooserDialog Reference" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:4531 msgid "FileDialog" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:4533 msgctxt "_" msgid "external ref='figures/dialogs_filedialog.png' md5='15ecc452482112428259d0dcd8d0394a'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4537 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4542 msgid "ColorDialog and ColorChooserDialog" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4543 msgid "The ColorChooserDialog (deprecated since gtkmm 4.10) and ColorDialog (available since gtkmm 4.10) allow the user to choose a color. The ColorButton (deprecated since gtkmm 4.10) and ColorDialogButton (available since gtkmm 4.10) open a color selection dialog when it is clicked." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4551 msgid "ColorDialog Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4552 msgid "ColorChooserDialog Reference" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:4558 msgid "ColorDialog" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:4560 msgctxt "_" msgid "external ref='figures/dialogs_colordialog.png' md5='029761e82cf06d3cbeaac2b7ccd70e57'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4564 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4569 msgid "FontDialog and FontChooserDialog" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4570 msgid "The FontChooserDialog (deprecated since gtkmm 4.10) and FontDialog (available since gtkmm 4.10) allow the user to choose a font. The FontButton (deprecated since gtkmm 4.10) and FontDialogButton (available since gtkmm 4.10) open a font chooser dialog when it is clicked." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4578 msgid "FontDialog Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4579 msgid "FontChooserDialog Reference" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:4585 msgid "FontDialog" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:4587 msgctxt "_" msgid "external ref='figures/dialogs_fontdialog.png' md5='e35e05429468fa8823416b8a0deff342'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4591 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4596 msgid "Non-modal AboutDialog" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4597 msgid "The AboutDialog offers a simple way to display information about a program, like its logo, name, copyright, website and license." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4601 msgid "Most dialogs in this chapter are modal, that is, they freeze the rest of the application while they are shown. It's also possible to create a non-modal dialog, which does not freeze other windows in the application. The following example shows a non-modal AboutDialog. This is perhaps not the kind of dialog you would normally make non-modal, but non-modal dialogs can be useful in other cases. E.g. gedit's search-and-replace dialog is non-modal." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4611 msgid "Reference" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:4617 msgid "AboutDialog" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:4619 msgctxt "_" msgid "external ref='figures/dialogs_about.png' md5='1b70a95ad73fce53bb5a2fbd3df69c5c'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4623 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4628 msgid "Custom Dialog" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4629 msgid "When none of the predefined dialog classes suit your needs, you can make your own dialog by deriving a class from Window and fill it with the widgets you need." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4635 msgid "Window Reference" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:4641 msgid "Window Dialog" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:4643 msgctxt "_" msgid "external ref='figures/dialogs_windowdialog.png' md5='53deb18153f6903fe45d015fc06ccef3'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4647 msgid "Source Code" msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:4654 msgid "The DrawingArea Widget" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:4655 msgid "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 draw 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 draw function to determine how the contents of the widget will be drawn. This is done by setting a draw function with a call to the set_draw_func() member function." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:4667 msgid "GTK uses the Cairo drawing API. With gtkmm, you may use the cairomm C++ API for cairo." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:4672 msgid "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." msgstr "" #. (itstool) path: note/title #: C/index-in.docbook:4682 msgid "Cairo and Pango" msgstr "" #. (itstool) path: note/para #: C/index-in.docbook:4683 msgid "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." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:4688 msgid "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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4696 msgid "The Cairo Drawing Model" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4697 msgid "The basic concept of drawing in Cairo involves defining 'invisible' paths and then stroking or filling them to make them visible." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4701 msgid "To do any drawing in gtkmm with Cairo, you must first get 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. Usually, you use the Cairo::Context that you get as input data to the draw function that you set with the call to set_draw_func(). It's also possible to create a Cairo::Context by calling the Gdk::Surface::create_cairo_context() and Gdk::CairoContext::cairo_create() functions. Since Cairo contexts are reference-counted objects, cairo_create() returns a Cairo::RefPtr<Cairo::Context> object. (Note the difference between Gdk::CairoContext and Cairo::Context.)" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4718 msgid "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." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:4723 #, no-wrap msgid "" "Gtk::DrawingArea myArea;\n" "auto gdkCairoContext = myArea.get_surface()->create_cairo_context();\n" "auto myContext = gdkCairoContext->cairo_create();\n" "myContext->set_source_rgb(1.0, 0.0, 0.0);\n" "myContext->set_line_width(2.0);\n" " " msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4729 msgid "Each Cairo::Context is associated with a particular Gdk::Surface, so the first line of the above example creates a Gtk::DrawingArea widget and the next two lines use its associated Gdk::Surface to create a Cairo::Context object. The final two lines change the graphics state of the context." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4737 msgid "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." msgstr "" #. (itstool) path: tip/para #: C/index-in.docbook:4769 msgid "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:" msgstr "" #. (itstool) path: tip/programlisting #: C/index-in.docbook:4775 #, no-wrap msgid "" "void doSomething(const Cairo::RefPtr<Cairo::Context>& context, int x)\n" "{\n" " context->save();\n" " // change graphics state\n" " // perform drawing operations\n" " context->restore();\n" "}" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4752 msgid "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(). <_:tip-1/>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4784 msgid "The draw function that you set with a call to set_draw_func() is called with a Cairo context that you shall use for drawing in the Gtk::DrawingArea widget. It is not necessary to save and restore this Cairo context in the draw function." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4792 msgid "Drawing Straight Lines" msgstr "" #. (itstool) path: tip/para #: C/index-in.docbook:4801 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4793 msgid "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. <_:tip-1/>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4817 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4829 msgid "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." msgstr "" #. (itstool) path: tip/para #: C/index-in.docbook:4838 msgid "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." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:4848 #: C/index-in.docbook:4971 msgid "Drawing Area - Lines" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:4850 msgctxt "_" msgid "external ref='figures/drawingarea_lines.png' md5='3e205f8303890e4eb2ea88487e8633e7'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4854 msgid "Source Code" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4856 msgid "This program contains a single class, MyArea, which is a subclass of Gtk::DrawingArea and contains an on_draw() member function. This function becomes the draw function by a call to set_draw_func() in MyArea's constructor. on_draw() is then called whenever the image in the drawing area needs to be redrawn. It is passed a Cairo::RefPtr pointer to a Cairo::Context that we use for the drawing. 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()." msgstr "" #. (itstool) path: tip/title #: C/index-in.docbook:4875 msgid "Drawing with relative coordinates" msgstr "" #. (itstool) path: tip/para #: C/index-in.docbook:4876 msgid "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()." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4883 msgid "Line styles" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4884 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4890 msgid "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:" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:4897 msgid "Different join types in Cairo" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:4899 msgctxt "_" msgid "external ref='figures/cairo_joins.png' md5='1b1e2a28e976039f1e4a0aa523ac40fb'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4902 msgid "The line join style is set using the function Cairo::Context::set_line_join()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4906 msgid "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()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4916 msgid "There are other things you can customize as well, including creating dashed lines and other things. For more information, see the Cairo API documentation." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4924 msgid "Drawing thin lines" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4925 msgid "If you try to draw one pixel wide lines, you may notice that the line sometimes comes up blurred and wider than it ought to be. This happens because Cairo will try to draw from the selected position, to both sides (half to each), so if you're positioned right on the intersection of the pixels, and want a one pixel wide line, Cairo will try to use half of each adjacent pixel, which isn't possible (a pixel is the smallest unit possible). This happens when the width of the line is an odd number of pixels (not just one pixel)." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4935 msgid "The trick is to position in the middle of the pixel where you want the line to be drawn, and thus guaranteeing you get the desired results. See Cairo FAQ." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:4942 msgid "Drawing Area - Thin Lines" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:4944 msgctxt "_" msgid "external ref='figures/drawingarea_thin_lines.png' md5='589cbad88ee60c46503e89c4318822a1'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4948 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:4953 msgid "Drawing Curved Lines" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4954 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4966 msgid "This simple application draws a curve with Cairo and displays the control points for each end of the curve." msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:4973 msgctxt "_" msgid "external ref='figures/drawingarea_curve.png' md5='1a9cdaaad2b17b89d8450f949c1ddef5'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4977 msgid "Source Code" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4978 msgid "The only difference between this example and the straight line example is in the on_draw() function, but there are a few new concepts and functions introduced here, so let's examine them briefly." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4984 msgid "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 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:4993 msgid "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 drawn 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)." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5012 msgid "Drawing Arcs and Circles" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5013 msgid "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. (Remember that the positive Y axis points downwards.)" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5028 msgid "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 with center at x, y and size width, height:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:5034 #, no-wrap msgid "" "context->save();\n" "context->translate(x, y);\n" "context->scale(width / 2.0, height / 2.0);\n" "context->arc(0.0, 0.0, 1.0, 0.0, 2 * M_PI);\n" "context->restore();" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5042 msgid "Here's an example of a simple program that draws an arc, a circle and an ellipse into a drawing area." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:5047 msgid "Drawing Area - Arcs" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:5049 msgctxt "_" msgid "external ref='figures/drawingarea_arcs.png' md5='d94b40e33b9fab7ea9e2c870b97fcf0c'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5053 msgid "Source Code" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5055 msgid "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_draw() 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5063 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5072 msgid "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." msgstr "" #. (itstool) path: note/title #: C/index-in.docbook:5085 msgid "Drawing counter-clockwise" msgstr "" #. (itstool) path: note/para #: C/index-in.docbook:5086 msgid "The function Cairo::Context::arc_negative() is exactly the same as Cairo::Context::arc() but the angles go the opposite direction." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5098 msgid "Drawing Text" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5101 msgid "Drawing Text with Pango" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5102 msgid "Text is drawn via Pango Layouts. The easiest way to create a Pango::Layout is to use Gtk::Widget::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 Pango::Layout::show_in_cairo_context() method." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5115 msgid "Here is an example of a program that draws some text, some of it upside-down. The Printing chapter contains another example of drawing text." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:5121 msgid "Drawing Area - Text" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:5123 msgctxt "_" msgid "external ref='figures/drawingarea_pango_text.png' md5='07c39668c9dda2ac1f9455caf6e4d16a'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5127 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5139 msgid "Drawing Images" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5140 msgid "There is a method for drawing from a Gdk::Pixbuf to a Cairo::Context. A Gdk::Pixbuf buffer is a useful wrapper around a collection of pixels, which can be read from files, and manipulated in various ways." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5147 msgid "Probably the most common way of creating Gdk::Pixbufs is to use Gdk::Pixbuf::create_from_file() or Gdk::Pixbuf::create_from_resource(), which can read an image file, such as a png file into a pixbuf ready for rendering." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5155 msgid "The Gdk::Pixbuf can be rendered by setting it as the source pattern of the Cairo context with Gdk::Cairo::set_source_pixbuf(). Then draw the image with either Cairo::Context::paint() (to draw the whole image), or Cairo::Context::rectangle() and Cairo::Context::fill() (to fill the specified rectangle). set_source_pixbuf() is not a member of Cairo::Context. It takes a Cairo::Context as its first parameter." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5166 msgid "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 draw signal handler! It's just shown here to keep it all together.)" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:5171 #, no-wrap msgid "" "void MyArea::on_draw(const Cairo::RefPtr<Cairo::Context>& cr, int width, int height)\n" "{\n" " auto image = Gdk::Pixbuf::create_from_file(\"myimage.png\");\n" " // Draw the image at 110, 90, except for the outermost 10 pixels.\n" " Gdk::Cairo::set_source_pixbuf(cr, image, 100, 80);\n" " cr->rectangle(110, 90, image->get_width()-20, image->get_height()-20);\n" " cr->fill();\n" "}" msgstr "" #. (itstool) path: para/screen #: C/index-in.docbook:5188 #, no-wrap msgid "" "$ glib-compile-resources --target=resources.c --generate-source image.gresource.xml" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5182 msgid "Here is an example of a simple program that draws an image. The program loads the image from a resource file. See the Gio::Resource and glib-compile-resources section. Use glib-compile-resources to compile the resources into a C source file that can be compiled and linked with the C++ code. E.g. <_:screen-1/>" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:5191 msgid "Drawing Area - Image" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:5193 msgctxt "_" msgid "external ref='figures/drawingarea_image.png' md5='4fbb9f465b7b8b209f295c44dd664d5a'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5197 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5211 msgid "Example Application: Creating a Clock with Cairo" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5213 msgid "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." msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:5221 msgctxt "_" msgid "external ref='figures/cairo_clock.png' md5='fceab985fd70bec94b273f78dd481d31'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5223 msgid "Source Code" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5224 msgid "As before, almost all of the interesting stuff is done in the draw function on_draw(). Before we dig into the draw function, notice that the constructor for the Clock widget connects a handler function on_timeout() to a timer with a timeout period of 1000 milliseconds (1 second). This means that on_timeout() 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5235 msgid "Now let's take a look at the code that performs the actual drawing. The first section of on_draw() should be pretty familiar by now. 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5245 msgid "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 that our next lines don't go outside the outline of the clock." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5257 msgid "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." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:5269 msgid "The Gtk::DragSource and Gtk::DropTarget event controllers have methods and signals which are used for Drag and Drop." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5275 msgid "Sources and Targets" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5276 msgid "Things are dragged from sources to be dropped on targets. Each source and target has information about the data formats that it can send or receive, provided by Gdk::ContentFormats. A drop target will only accept a dragged item if they both share a compatible format. Appropriate signals will then be emitted, telling the signal handlers which format was used." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5284 msgid "Gdk::ContentFormats objects contain information about available GTypes and mime types (media types)." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5294 msgid "Widgets can be identified as sources or targets using Gtk::DragSource and Gtk::DropTarget event controllers." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:5299 #, no-wrap msgid "" "auto source = Gtk::DragSource::create();\n" "m_source_widget.add_controller(source);" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5306 msgid "void set_content(const Glib::RefPtr<Gdk::ContentProvider>& content): Sets a content provider on the drag source." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5312 msgid "void set_actions(Gdk::DragAction actions): Sets the actions on the drag source. For instance Gdk::DragAction::COPY | Gdk::DragAction::MOVE." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5319 msgid "void set_icon(const Glib::RefPtr<const Gdk::Paintable>& paintable, int hot_x, int hot_y): Sets a paintable to use as icon during DND operations." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5302 msgid "Some DragSource methods: <_:itemizedlist-1/>" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:5327 #, no-wrap msgid "" "auto target = Gtk::DropTarget::create(gtype, actions);\n" "m_target_widget.add_controller(target);" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5334 msgid "void set_gtypes(const std::vector<GType>& types): Sets the supported types for this drop target." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5340 msgid "void set_actions(Gdk::DragAction actions): Sets the actions that this drop target supports." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5346 msgid "Glib::ValueBase get_value() const: Gets the current drop data, as a Glib::Value." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5352 msgid "void reject(): Rejects the ongoing drop operation. This function should be used when delaying the decision on whether to accept a drag or not until after reading the data." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5330 msgid "Some DropTarget methods: <_:itemizedlist-1/>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5366 msgid "When a drop target 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 Gtk::DragSource::set_actions() and Gtk::DropTarget::set_actions()." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5379 msgid "drag_begin: Provides a Gdk::Drag." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5380 msgid "prepare: Shall return a Gdk::ContentProvider, with the data to use for the drag that is about to start." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5382 msgid "drag_end: Provides a Gdk::Drag, and a bool that tells if the drag was performing a move and the data should be deleted." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5385 msgid "drag_cancel: Emitted on the drag source when a drag has failed." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5376 msgid "The source widget will emit these DragSource signals: <_:itemizedlist-1/>" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5391 msgid "enter: Provides coordinates. Shall return the preferred Gdk::DragAction." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5393 msgid "motion: Provides coordinates. Shall return the preferred Gdk::DragAction." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5395 msgid "leave: Emitted on the drop site when the pointer leaves the widget." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5397 msgid "accept: Provides a Gdk::Drop. You can call the status() method of the Gdk::Drop to indicate which actions will be accepted." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5400 msgid "drop: Provides the data being dropped and coordinates. Shall return a bool indicating whether the drop was accepted." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5388 msgid "The target widget will emit these DropTarget signals: <_:itemizedlist-1/>" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5410 msgid "Gtk::DragSource::signal_prepare()" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5411 msgid "Gtk::DropTarget::signal_enter()" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5412 msgid "Gtk::DropTarget::signal_motion()" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5413 msgid "Gtk::DropTarget::signal_accept()" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5414 msgid "Gtk::DropTarget::signal_drop()" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5404 msgid "The following signals call only one signal handler when emitted. When you connect a handler to such a signal, your signal handler must be called before (instead of) the default handler, otherwise it won't be called. Set the after parameter in connect() to false. <_:itemizedlist-1/>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5423 msgid "Here is a very simple example, demonstrating a drag and drop Copy operation:" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:5428 msgctxt "_" msgid "external ref='figures/drag_and_drop.png' md5='c13dd8b7faa3d523444c101e42572a10'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5432 msgid "Source Code" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5434 msgid "There is a more complex example in examples/others/dnd." msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:5443 msgid "The Clipboard" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:5445 msgid "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." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:5451 msgid "You can get a clipboard instance with Gtk::Widget::get_clipboard() or Gdk::Display::get_clipboard()." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:5456 msgid "Your application doesn't need to wait for clipboard operations, particularly between the time when the user chooses Copy and then later chooses Paste. Many Gdk::Clipboard methods take sigc::slots which specify callback methods. When Gdk::Clipboard is ready, it will call these methods, providing the requested data." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:5464 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5467 msgid "Formats" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5469 msgid "Different applications contain different types of data, and they might make that data available in a variety of formats. gtkmm calls these data types formats." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5473 msgid "For instance, gedit can supply and receive the text/plain mime type, so you can paste data into gedit from any application that supplies that format. Or two different image editing applications might supply and receive a variety of image formats. As long as one application can receive one of the formats that the other supplies then you will be able to copy data from one to the other." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5481 msgid "Clipboard data 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5488 msgid "The Drag and Drop API uses the same mechanism. You should probably use the same data formats for both Clipboard and Drag and Drop operations." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5493 msgid "Copy" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5495 msgid "When the user asks to copy some data, you should copy the data to the Clipboard. For instance," msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:5499 #, no-wrap msgid "" "void ExampleWindow::on_button_copy()\n" "{\n" " get_clipboard()->set_text(\"example_custom_target\");\n" "}" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5507 msgid "Paste" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5509 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:5514 #, no-wrap msgid "" "void ExampleWindow::on_button_paste()\n" "{\n" " get_clipboard()->read_text_async(sigc::mem_fun(*this,\n" " &ExampleWindow::on_clipboard_received));\n" "}" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5520 msgid "Here is an example callback method:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:5522 #, no-wrap msgid "" "void ExampleWindow::on_clipboard_received(Glib::RefPtr<Gio::AsyncResult>& result)\n" "{\n" " auto text = get_clipboard()->read_text_finish(result);\n" " //Do something with the pasted data.\n" "}" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5529 msgid "Discovering the available formats" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5531 msgid "To find out what formats are currently available on the Clipboard for pasting, call the get_formats() method. Then call a Gdk::ContentFormats method to find out if a format that your application supports is available." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5545 #: C/index-in.docbook:5937 msgid "Simple" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5546 msgid "This example allows copy and pasting of application-specific data, using the standard text format. Although this is simple, it's not ideal because it does not identify the Clipboard data as being of a particular type." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:5554 msgid "Clipboard - Simple" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:5556 msgctxt "_" msgid "external ref='figures/clipboard_simple.png' md5='9eab8350b743743e1571f1d245aea35c'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5560 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5565 msgid "Ideal" msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:5568 msgid "Defines a custom clipboard target, though the format is still text." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:5569 msgid "It uses the Gdk::ContentFormats::signal_changed() signal and disables the Paste button if it can't use anything on the clipboard." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5566 msgid "This is like the simple example, but it <_:orderedlist-1/>" msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:5575 msgid "Clipboard - Ideal" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:5577 msgctxt "_" msgid "external ref='figures/clipboard_ideal.png' md5='8f284904600e27efa06d39f0741acc2d'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5581 msgid "Source Code" msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:5588 msgid "Printing" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:5590 msgid "At the application development level, gtkmm's printing API provides dialogs that are consistent across applications and allows use 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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5596 msgid "PrintOperation" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5598 msgid "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." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5615 msgid "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." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5625 msgid "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." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5639 msgid "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." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5648 msgid "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." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5634 msgid "For each page that needs to be rendered, the following signals are emitted: <_:itemizedlist-1/>" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5663 msgid "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." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5673 msgid "done: This signal is emitted when printing is finished, meaning when the print data is spooled. Note that the provided Gtk::PrintOperation::Result may indicate that an error occurred. In any case you probably want to notify the user about the final status." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5683 msgid "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()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5609 msgid "The PrintOperation::run() method starts the print loop, during which various signals are emitted: <_:itemizedlist-1/>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5696 msgid "Reference" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5705 msgid "Page setup" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5707 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5717 msgid "You should save the chosen Gtk::PageSetup so you can use it again if the page setup dialog is shown again." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:5721 #, no-wrap msgid "" "// Within a class that inherits from Gtk::Window and keeps m_refPageSetup\n" "// and m_refSettings as members...\n" "auto new_page_setup = Gtk::run_page_setup_dialog(*this, m_refPageSetup, m_refSettings);\n" "m_refPageSetup = new_page_setup;\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5727 msgid "Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5731 msgid "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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5743 msgid "Rendering text" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5745 msgid "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::LayoutLines that appear within the requested page number." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5760 msgid "See an example of exactly how this can be done." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5768 msgid "Asynchronous operations" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5770 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5777 msgid "run() may return PrintOperation::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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:5785 #, no-wrap msgid "" "// in class ExampleWindow's method...\n" "auto op = PrintOperation::create();\n" "// ...set up op...\n" "op->signal_done().connect(sigc::bind(sigc::mem_fun(\n" " *this, &ExampleWindow::on_printoperation_done), op));\n" "// run the op\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5793 msgid "Second, check for an error and connect to the status_changed signal. For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:5795 #, no-wrap msgid "" "void ExampleWindow::on_printoperation_done(Gtk::PrintOperation::Result result,\n" " const Glib::RefPtr<PrintOperation>& op)\n" "{\n" " if (result == Gtk::PrintOperation::Result::ERROR)\n" " //notify user\n" " else if (result == Gtk::PrintOperation::Result::APPLY)\n" " //Update PrintSettings with the ones used in this PrintOperation\n" "\n" " if (! op->is_finished())\n" " op->signal_status_changed().connect(sigc::bind(sigc::mem_fun(\n" " *this, &ExampleWindow::on_printoperation_status_changed), op));\n" "}\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5809 msgid "Finally, check the status. For instance," msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:5810 #, no-wrap msgid "" "void ExampleWindow::on_printoperation_status_changed(const Glib::RefPtr<PrintOperation>& op)\n" "{\n" " if (op->is_finished())\n" " //the print job is finished\n" " else\n" " //get the status with get_status() or get_status_string()\n" "\n" " //update UI\n" "}\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5824 msgid "Export to PDF" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5826 msgid "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," msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:5829 #, no-wrap msgid "" "auto op = Gtk::PrintOperation::create();\n" "// ...set up op...\n" "op->set_export_filename(\"test.pdf\");\n" "auto res = op->run(Gtk::PrintOperation::Action::EXPORT);\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5838 msgid "Extending the print dialog" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5845 msgid "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." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:5855 msgid "Get the data from the widgets in the custom_widget_apply signal handler." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5840 msgid "You may add a custom tab to the print dialog: <_:itemizedlist-1/>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5863 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:5870 #, no-wrap msgid "" "Gtk::Widget* CustomPrintOperation::on_create_custom_widget()\n" "{\n" " set_custom_tab_label(\"My custom tab\");\n" "\n" " auto hbox = new Gtk::Box(Gtk::Orientation::HORIZONTAL, 8);\n" " hbox->set_margin(6);\n" "\n" " auto label = Gtk::make_managed<Gtk::Label>(\"Enter some text: \");\n" " hbox->append(*label);\n" "\n" " hbox->append(m_Entry);\n" "\n" " return hbox;\n" "}\n" "\n" "void CustomPrintOperation::on_custom_widget_apply(Gtk::Widget* /* widget */)\n" "{\n" " auto user_input = m_Entry.get_text();\n" " //...\n" "}\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5892 msgid "The example in examples/book/printing/advanced demonstrates this." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5899 msgid "Preview" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5901 msgid "The native GTK print dialog has a preview button, but you may also start a preview directly from an application:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:5905 #, no-wrap msgid "" "// in a class that inherits from Gtk::Window...\n" "auto op = PrintOperation::create();\n" "// ...set up op...\n" "op->run(Gtk::PrintOperation::Action::PREVIEW, *this);\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5911 msgid "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 behavior and provide a custom preview dialog. See the example located in /examples/book/printing/advanced." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5921 #: C/index-in.docbook:5958 msgid "PrintDialog" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5923 msgid "Since gtkmm 4.14 Gtk::PrintDialog is an alternative to Gtk::PrintOperation. PrintDialog uses the same PageSetup and PrintSettings classes as PrintOperation. The rendering with Cairo and Pango is also similar." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5939 msgid "The following example demonstrates how to print some input from a user interface using PrintOperation. 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." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:5947 msgid "Printing - Simple" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:5949 msgctxt "_" msgid "external ref='figures/printing_simple.png' md5='8e7f72103094230cafcd912cb6b34277'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5953 msgid "Source Code" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5960 msgid "The following example demonstrates how to print some input from a user interface using PrintDialog. The user interface is similar to the previous example." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:5967 msgid "Printing - PrintDialog" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:5969 msgctxt "_" msgid "external ref='figures/printing_printdialog.png' md5='131a217e90587b80335c230cace02a57'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5973 msgid "Source Code" msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:5980 msgid "Recently Used Documents" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:5982 msgid "gtkmm provides an easy way to manage recently used documents. This functionality is implemented in the Gtk::RecentManager class." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:5986 msgid "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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:5995 msgid "RecentManager" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:5996 msgid "RecentManager acts as a database of recently used files. You use this class to register new files, remove files from the list, or look up recently used files. There is one list of recently used files per user." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6002 msgid "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()." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6010 msgid "Adding Items to the List of Recent Files" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6011 msgid "To add a new file to the list of recent documents, in the simplest case, you only need to provide the URI. For example:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6015 #, no-wrap msgid "" "auto recent_manager = Gtk::RecentManager::get_default();\n" "recent_manager->add_item(uri);" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6017 msgid "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:" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:6025 msgid "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" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:6031 msgid "app_name: The name of the application that registered the resource" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:6035 msgid "description: A short description of the resource as a UTF-8 encoded string" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:6039 msgid "display_name: The name of the resource to be used for display as a UTF-8 encoded string" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:6043 msgid "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." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:6049 msgid "is_private: Whether this resource should be visible only to applications that have registered it or not" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:6053 msgid "mime_type: The MIME type of the resource" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6056 msgid "In addition to adding items to the list, you can also look up items from the list and modify or remove items." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6063 msgid "Looking up Items in the List of Recent Files" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6064 msgid "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, lookup_item() throws a RecentManagerError exception. For example:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6073 #, no-wrap msgid "" "Glib::RefPtr<Gtk::RecentInfo> info;\n" "try\n" "{\n" " info = recent_manager->lookup_item(uri);\n" "}\n" "catch(const Gtk::RecentManagerError& ex)\n" "{\n" " std::cerr << \"RecentManagerError: \" << ex.what() << std::endl;\n" "}\n" "if (info)\n" "{\n" " // item was found\n" "}" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6086 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6092 msgid "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 is a std::vector of all recently used files. The following code demonstrates how you might get a list of recently used files:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6100 #, no-wrap msgid "" "auto info_list = recent_manager->get_items();" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6101 msgid "The maximum age of items in the recently used files list can be set with Gtk::Settings::property_gtk_recent_files_max_age(). Default value: 30 days." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6109 msgid "Modifying the List of Recent Files" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6110 msgid "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()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6117 msgid "In addition to changing a file's URI, you can also remove items from the list, either one at a time or by clearing them all at once. The former is accomplished with remove_item(), the latter with purge_items()." msgstr "" #. (itstool) path: note/para #: C/index-in.docbook:6124 msgid "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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6136 msgid "FileChooser and FileDialog" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6138 msgid "FileChooser is an interface that can be implemented by widgets displaying a list of files. gtkmm provides three built-in implementations for choosing recent files or other files: FileChooserWidget, FileChooserDialog, and FileChooserNative." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6147 msgid "FileChooserWidget is a simple widget for displaying a list of recently used files or other files. FileChooserWidget is the basic building block for FileChooserDialog, but you can embed it into your user interface if you want to." msgstr "" #. (itstool) path: note/para #: C/index-in.docbook:6154 msgid "FileChooser and the classes that implement it are deprecated since gtkmm 4.10. They have been replaced by FileDialog, which is available since gtkmm 4.10." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6160 msgid "Simple FileDialog example" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6162 msgid "Shown below is a simple example of how to use the FileDialog class in a program. This simple program has a menubar with a File Dialog menu item. When you select this menu item, a dialog pops up showing a list of files. If you select Recent in the sidebar, the list of recently used files is shown." msgstr "" #. (itstool) path: note/para #: C/index-in.docbook:6172 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6179 msgid "After selecting the File Dialog menu item and the Recent sidebar item, you should see something similar to the following window." msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:6185 msgctxt "_" msgid "external ref='figures/recentfiles.png' md5='2ca280c98b5c8822ad48ca40f7ce0bb4'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6187 msgid "Source Code" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6188 msgid "The constructor for ExampleWindow creates the menu and the toolbar using Builder (see for more information). It then adds the menu and the toolbar to the window." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6196 msgid "Filtering Files" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6197 msgid "For any of the FileChooser classes, if you don't wish to display all of the items in the list of files, you can filter the list to show only those that you want. You can filter the list with the help of the FileFilter class. This class allows you to filter files by their name (add_pattern()), or their mime type (add_mime_type())." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6206 msgid "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 FileChooser::add_filter() function." msgstr "" #. (itstool) path: chapter/title #. (itstool) path: figure/title #: C/index-in.docbook:6216 #: C/index-in.docbook:6389 msgid "Keyboard and Mouse Events" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:6217 msgid "Event signals differ in some ways from other signals. These differences are described in the Event signals section in the appendix. Here we will use keyboard events and mouse events to show how events can be used in a program." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6224 msgid "Overview" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6226 msgid "Whenever you press or release a key, an event is emitted. You can add an event controller and connect a signal handler to handle such events." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6230 msgid "The event signal handler will receive arguments that depend on the type of event. For key press events the arguments are (guint keyval, guint keycode, Gdk::ModifierType state). As described in the appendix, the key press event signal handler returns a bool value, to indicate that the signal is fully handled (true) or allow event propagation (false)." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6239 msgid "To determine which key was pressed or released, you read the value of the keyval argument and compare it with a constant in the <gdk/gdkkeysyms.h> header file. The states of modifier keys (shift, ctrl, etc.) are available as bit-flags in state." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6247 #: C/index-in.docbook:9225 msgid "Here's a simple example:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6250 #, no-wrap msgid "" "\n" "bool MyClass::on_key_pressed(guint keyval, guint, Gdk::ModifierType state)\n" "{\n" " if (keyval == GDK_KEY_1 &&\n" " (state & (Gdk::ModifierType::SHIFT_MASK | Gdk::ModifierType::CONTROL_MASK |\n" " Gdk::ModifierType::ALT_MASK)) == Gdk::ModifierType::ALT_MASK)\n" " {\n" " handle_alt_press();\n" " return true;\n" " }\n" " return false;\n" "}\n" "\n" "// in MyClass constructor\n" "auto controller = Gtk::EventControllerKey::create();\n" "controller->signal_key_pressed().connect(\n" " sigc::mem_fun(*this, &MyClass::on_key_pressed), false);\n" "add_controller(controller);\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6273 msgid "In this example there are three keyboard shortcuts: Alt+1 selects the first radio button, Alt+2 selects the second one, and the Esc key hides (closes) the window." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:6281 msgid "Keyboard Events - Simple" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:6283 msgctxt "_" msgid "external ref='figures/events_simple.png' md5='59e69135f7b646af1a9f528eba13a5df'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6287 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6292 msgid "Event Propagation" msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:6298 #: C/index-in.docbook:9263 msgid "Capture phase - runs from the toplevel down to the event widget." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:6299 #: C/index-in.docbook:9264 msgid "Target phase - runs only on the event widget." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:6300 #: C/index-in.docbook:9265 msgid "Bubble phase - runs from the event widget up to the toplevel." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6294 msgid "As described in the appendix event signals are propagated in 3 phases: <_:orderedlist-1/>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6303 msgid "A keyboard event is first sent to the toplevel window (Gtk::Window), where it will be checked for any keyboard shortcuts that may be set (accelerator keys and mnemonics, used for selecting menu items from the keyboard). After this (and assuming the event wasn't handled), it is propagated down until it reaches the widget which has keyboard focus. The event will then propagate up until it reaches the top-level widget, or until you stop the propagation by returning true from an event handler." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6313 msgid "Notice, that after canceling an event, no other function will be called (even if it is from the same widget)." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6321 msgid "In this example there are 9 EventControllerKeys, 3 in each of a Gtk::Window, a Gtk::Box and a Gtk::Label. In each of the widgets there is one event controller for each propagation phase." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6327 msgid "The purpose of this example is to show the steps the event takes when it is emitted." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6330 msgid "When you write in the label, a key press event will be emitted, which will go first, in the capture phase, to the toplevel window (Gtk::Window), then down to its child, the box, then to the box's child, the label with the keyboard focus. In the target phase the event goes only to the widget with the keyboard focus (the label). In the bubble phase the event goes first to the widget with the keyboard focus (the label), then to its parent (the box), then to the box's parent (the window). If the event propagates all the way down to the label and then up to the window without being stopped, the text you're writing will appear in the Label above the Label you're writing in." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:6345 msgid "Keyboard Events - Event Propagation" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:6347 msgctxt "_" msgid "external ref='figures/events_propagation.png' md5='4250a1b17c413f3243cf11485e7a7bb9'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6351 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6356 msgid "Mouse Events" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:6361 msgid "You use Gtk::GestureClick instead of Gtk::EventControllerKey." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:6363 msgid "There are other event classes that can be used for handling mouse events, for instance Gtk::EventControllerMotion and Gtk::EventControllerScroll." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:6366 msgid "Many signal handlers don't return a bool. You can't stop those events from propagating." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6358 msgid "Mouse events are similar to keyboard events. There are some differences, though. <_:itemizedlist-1/>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6371 msgid "The event classes that handle mouse events are also useful for handling events from touchscreens. There are also many subclasses of Gtk::EventController which are only (or mainly) useful for touchscreens. Examples: Gtk::GestureRotate, Gtk::GestureZoom, Gtk::GestureSwipe, Gtk::GestureLongPress." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6380 msgid "Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6384 msgid "This is an expanded version of the simple keyboard events example." msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:6391 msgctxt "_" msgid "external ref='figures/events_mouse.png' md5='e92832c065b3b626a14b5da77d209b2f'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6395 msgid "Source Code" msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:6401 msgid "Timeouts, I/O and Idle Functions" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6404 msgid "Timeouts" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6406 msgid "You may be wondering how to make gtkmm do useful work while it's idling along. Happily, you have several options. Using the following methods you can create a timeout method that will be called every few milliseconds." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6412 #, no-wrap msgid "" "sigc::connection Glib::SignalTimeout::connect(const sigc::slot<bool()>& slot,\n" " unsigned int interval, int priority = Glib::PRIORITY_DEFAULT);\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6416 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6424 #, no-wrap msgid "" "my_connection.disconnect();\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6427 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6435 #, no-wrap msgid "" "bool MyCallback() { std::cout << \"Hello World!\\n\" << std::endl; return true; }\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6438 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6444 msgid "Here's an example of this technique:" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6448 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6453 msgid "Monitoring I/O" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6455 msgid "A nifty feature of Glib (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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6462 #, no-wrap msgid "" "sigc::connection Glib::SignalIO::connect(const sigc::slot<bool(Glib::IOCondition)>& slot,\n" " Glib::PollFD::fd_t fd, Glib::IOCondition condition,\n" " int priority = Glib::PRIORITY_DEFAULT);\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6467 msgid "The first argument is a slot you wish to have called when the specified event (see argument 3) occurs on the file descriptor you specify using argument two. Argument three may be one or more (using |) of:" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:6476 msgid "Glib::IOCondition::IO_IN - Call your method when there is data ready for reading on your file descriptor." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:6482 msgid "Glib::IOCondition::IO_OUT - Call your method when the file descriptor is ready for writing." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:6488 msgid "Glib::IOCondition::IO_PRI - Call your method when the file descriptor has urgent data to be read." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:6493 msgid "Glib::IOCondition::IO_ERR - Call your method when an error has occurred on the file descriptor." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:6498 msgid "Glib::IOCondition::IO_HUP - Call your method when hung up (the connection has been broken usually for pipes and sockets)." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6504 msgid "The return value is a sigc::connection that may be used to stop monitoring this file descriptor using its disconnect() method. The slot signal handler should be declared as follows:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6510 #, no-wrap msgid "" "bool input_callback(Glib::IOCondition condition);\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6513 msgid "where condition is 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 lambda expression can be used, if you don't need the automatic disconnection that sigc::mem_fun() provides when the object goes out of scope." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6522 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6531 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6536 msgid "Idle Functions" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6538 msgid "If you want to specify a method that gets called when nothing else is happening, use the following:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6542 #, no-wrap msgid "" "sigc::connection Glib::SignalIdle::connect(const sigc::slot<bool()>& slot,\n" " int priority = Glib::PRIORITY_DEFAULT_IDLE);\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6546 msgid "This causes gtkmm to call the specified method whenever nothing else is happening. You can add a priority (lower numbers are higher priorities). There are two ways to remove the signal handler: calling disconnect() on the sigc::connection object, or returning false in the signal handler, which should be declared as follows:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6555 #, no-wrap msgid "" "bool idleFunc();\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6558 msgid "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:" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6563 msgid "Source Code" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6565 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6573 msgid "Try executing the example and increasing the system load. The upper progress bar will increase steadily; the lower one will slow down." msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:6583 msgid "Memory management" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6589 msgid "Normal C++ memory management" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6591 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6602 msgid "An important difference in gtkmm-4.0 vs. older versions is that a C++ widgetʼs destruction no longer causes the widget to be destroyed if itʼs within a parent; in that case the C GtkWidget stays alive. If you had relied on that behavior in an older version, in gtkmm-4.0 you must now remove the widget from its parent first. See Changes in gtkmm-4.0." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6609 msgid "Here are some examples of normal C++ memory management:" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6612 msgid "Class Scope widgets" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6613 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6619 msgid "The primary disadvantage of using class scope widgets is revealing the class implementation rather than the class interface in the class header." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6623 #, no-wrap msgid "" "#include <gtkmm/button.h>\n" "#include <gtkmm/window.h>\n" "class Foo : public Gtk::Window\n" "{\n" "private:\n" " Gtk::Button theButton;\n" " // will be destroyed when the Foo object is destroyed\n" "};\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6635 msgid "Function scope widgets" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6636 msgid "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." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6641 #, no-wrap msgid "" "{\n" " Gtk::Button aButton;\n" " aButton.set_visible(true);\n" " ...\n" " app->run();\n" "}\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6648 msgid "However, this technique is rarely useful. Most widgets can't safely be created before the application has been registered or activated. They can't safely be deleted after Gtk::Application::run() or Gtk::Application::make_window_and_run() returns." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6658 msgid "Dynamic allocation with new and delete" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6659 msgid "Usually, the programmer will prefer to allow containers to automatically destroy their children by creating them using Gtk::make_managed() (see below). This is not strictly required, as the new and delete operators may also be used, but modern C++ style discourages those in favor of safer models of memory management, so it is better to create widgets using Gtk::make_managed() and let their parent destroy them, than to manually perform dynamic allocation." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6668 #, no-wrap msgid "" "auto pButton = new Gtk::Button(\"Test\");\n" "// do something useful with pButton\n" "delete pButton;\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6672 msgid "Here, the programmer deletes pButton to prevent a memory leak." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6679 msgid "Managed Widgets" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6681 msgid "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, create it with Gtk::make_managed() and then pack it into its container with Gtk::Box::append() or a similar method. Now the widget will be destroyed whenever its container is destroyed." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6691 msgid "Dynamic allocation with make_managed() and append()" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6693 msgid "gtkmm provides ways including the make_managed() function and Gtk::Box::append() method to simplify creation and destruction of widgets whose lifetime can be managed by a parent." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6699 msgid "Every widget except a top-level window must be added to a parent container in order to be displayed. The manage() function marks a widget so that when that widget is added to a parent container, said container becomes responsible for deleting the widget, meaning the user no longer needs to do so. The original way to create widgets whose lifetime is managed by their parent in this way was to call manage(), passing in the result of a new expression that created a dynamically allocated widget." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6709 msgid "However, usually, when you create such a widget, you will already know that its parent container should be responsible for destroying it. In addition, modern C++ style discourages use of the new operator, which was required when passing a newly created widget to manage(). Therefore, gtkmm has added make_managed(), which combines creation and marking with manage() into a single step. This avoids you having to write new, which is discouraged in modern C++ style, and more clearly expresses intent to create a managed widget." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6720 #, no-wrap msgid "" "MyContainer::MyContainer()\n" "{\n" " auto pButton = Gtk::make_managed<Gtk::Button>(\"Test\");\n" " append(*pButton); //add *pButton to MyContainer\n" "}\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6726 msgid "Now, when objects of type MyContainer 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 MyContainer object." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6733 msgid "If you never added the widget to any parent container, it's your responsibility to delete it. If you add it to a container widget, and later remove it (for instance with Gtk::Box::remove()), it's deleted by the container." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6740 msgid "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. Or you can let Gtk::Application::make_window_and_run() create a top-level window and delete it when it's hidden." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6752 msgid "Shared resources" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6754 msgid "Some objects, such as Gdk::Pixbufs and Pango::Fonts, are obtained from a shared store. Therefore you cannot instantiate your own instances. These classes typically inherit from Glib::Object. Rather than requiring you to reference and unreference these objects, gtkmm uses the Glib::RefPtr<> smartpointer. Cairomm has its own smartpointer, Cairo::RefPtr<>." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6764 msgid "Objects such as Gdk::Pixbuf can only be instantiated with a create() function. For instance," msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6768 #, no-wrap msgid "" "auto pixbuf = Gdk::Pixbuf::create_from_file(filename);\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6771 msgid "You have no way of getting a bare Gdk::Pixbuf. In the example, pixbuf is a smart pointer, so you can do this, much like a normal pointer:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6776 #, no-wrap msgid "" "auto width = 0;\n" "if(pixbuf)\n" "{\n" " width = pixbuf->get_width();\n" "}\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6783 msgid "When pixbuf 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6789 msgid "If you copy a RefPtr, for instance" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6791 #, no-wrap msgid "" "auto pixbuf2 = pixbuf;\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6793 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6798 msgid "See the appendix for detailed information about RefPtr." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:6803 msgid "Bjarne Stroustrup, \"The C++ Programming Language\" Fourth Edition - section 34.3" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:6806 msgid "Nicolai M. Josuttis, \"The C++ Standard Library\" - section 4.2" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6799 msgid "If you wish to learn more about smartpointers, you might look in these books: <_:itemizedlist-1/>" msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:6817 msgid "Gtk::Builder" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:6819 msgid "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 Cambalache application allows you to layout widgets on screen and then save an XML description of the arrangement. Your application can then use the Gtk::Builder API to load that XML file at runtime and obtain a pointer to specifically named widget instances." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:6832 msgid "Less C++ code is required." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:6833 msgid "UI changes can be seen more quickly, so UIs are able to improve." msgstr "" #. (itstool) path: listitem/simpara #: C/index-in.docbook:6834 msgid "Designers without programming skills can create and edit UIs." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:6829 msgid "This has the following advantages: <_:orderedlist-1/>" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:6838 msgid "You still need C++ code to deal with User Interface changes triggered by user actions, but using Gtk::Builder for the widget layout allows you to focus on implementing that functionality." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:6844 msgid "Cambalache replaces the Glade application. Glade can generate XML files to be used with gtk3/gtkmm3, but it does not support gtk4/gtkmm4." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6851 msgid "Loading the .ui file" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6853 msgid "Gtk::Builder must be used via a Glib::RefPtr. Like all such classes, you need to use a create() method to instantiate it. For instance," msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6857 #, no-wrap msgid "" "auto builder = Gtk::Builder::create_from_file(\"basic.ui\");\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6859 msgid "This will instantiate the windows defined in the .ui file." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6862 msgid "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," msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6864 #, no-wrap msgid "" "auto builder = Gtk::Builder::create_from_file(\"basic.ui\", \"treeview_products\");\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6870 msgid "Accessing widgets" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6872 msgid "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 Cambalache window. If the widget could not be found, or is of the wrong type, then the pointer will be set to nullptr." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6879 msgid "The dialogs in this chapter are derived from Gtk::Window because Gtk::Dialog is deprecated since gtkmm 4.10." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6883 #, no-wrap msgid "" "auto pDialog = builder->get_widget<Gtk::Window>(\"DialogBasic\");\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6886 msgid "Gtk::Builder 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6892 msgid "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 Gtk::Builder, with the same widget name. The widgets are instantiated during Gtk::Builder::create_from_file()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6901 msgid "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. Windows (such as Dialogs) cannot be managed because they have no parent container, so you must delete them at some point. The documentation of Gtk::Builder has more to say about the memory management of different kinds of objects." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6911 msgid "Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6916 msgid "This simple example shows how to load a .ui file at runtime and access the widgets with Gtk::Builder." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6921 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6928 msgid "Using derived widgets" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6930 msgid "You can use Cambalache and Gtk::Builder to layout your own custom widgets derived from gtkmm widget classes. This keeps your code organized and encapsulated, separating declarative presentation from business logic, avoiding having most of your source just be setting properties and packing in containers." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6938 msgid "Use Gtk::Builder::get_widget_derived() like so:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6940 #, no-wrap msgid "" "auto pDialog = Gtk::Builder::get_widget_derived<DerivedDialog>(builder, \"DialogDerived\");\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6943 msgid "Your derived class must have a constructor that takes a pointer to the underlying C type, and the Gtk::Builder instance. All relevant classes of gtkmm typedef their underlying C type as BaseObjectType (Gtk::Window typedefs BaseObjectType as GtkWindow, for instance)." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6950 msgid "You must call the base class's constructor in the initialization list, providing the C pointer. For instance," msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6954 #, no-wrap msgid "" "DerivedDialog::DerivedDialog(BaseObjectType* cobject, const Glib::RefPtr<Gtk::Builder>& builder)\n" ": Gtk::Window(cobject)\n" "{\n" "}\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6960 msgid "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," msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6965 #, no-wrap msgid "" "DerivedDialog::DerivedDialog(BaseObjectType* cobject, const Glib::RefPtr<Gtk::Builder>& builder)\n" ": Gtk::Window(cobject),\n" " m_builder(builder),\n" " // Get the GtkBuilder-instantiated Button, and connect a signal handler:\n" " m_pButton(m_builder->get_widget<Gtk::Button>(\"quit_button\"))\n" "{\n" " if (m_pButton)\n" " {\n" " m_pButton->signal_clicked().connect( sigc::mem_fun(*this, &DerivedDialog::on_button_quit) );\n" " }\n" "}\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6978 msgid "It's possible to pass additional arguments from get_widget_derived() to the constructor of the derived widget. For instance, this call to get_widget_derived()" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6983 #, no-wrap msgid "" "auto pDialog = Gtk::Builder::get_widget_derived<DerivedDialog>(builder, \"DialogDerived\", true);\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:6985 msgid "can invoke this constructor" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:6987 #, no-wrap msgid "" "DerivedDialog::DerivedDialog(BaseObjectType* cobject,\n" " const Glib::RefPtr<Gtk::Builder>& builder, bool warning)\n" ": Gtk::Window(cobject),\n" " m_builder(builder),\n" " m_pButton(m_builder->get_widget<Gtk::Button>(\"quit_button\"))\n" "{\n" " // ....\n" "}\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:6998 msgid "Gtk::Builder and Glib::Property" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7000 msgid "If your derived widget uses Glib::Property, it becomes slightly more complicated. A derived widget that contains Glib::Property members must be registered with its own name in the GType system. It must be registered before any of the create_from_*() or add_from_*() methods are called, meaning that you may have to create an instance of your derived widget just to have its class registered. Your derived widget must have a constructor that has the parameters required by get_widget_derived() and calls the Glib::ObjectBase constructor to register the GType." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:7011 #, no-wrap msgid "" "DerivedButton::DerivedButton(BaseObjectType* cobject, const Glib::RefPtr<Gtk::Builder>& builder)\n" ": Glib::ObjectBase(\"MyButton\"), // The GType name will be gtkmm__CustomObject_MyButton.\n" " Gtk::Button(cobject),\n" " prop_ustring(*this, \"button-ustring\"),\n" " prop_int(*this, \"button-int\", 10)\n" "{\n" " // ....\n" "}\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7020 msgid "It is possible also to specify properties of derived widgets, declared in C++ using gtkmm, within .ui files and load/set these using Gtk::Builder. See the documentation of Gtk::Builder for more details on how to achieve this. Cambalache won’t recognize such properties as-is, but you should be able to add a few lines of hand-coded XML to the XML code generated by Cambalache." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7034 msgid "This example shows how to load a .ui file at runtime and access the widgets via derived classes." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7039 msgid "Source Code" msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:7048 msgid "Internationalization and Localization" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:7050 msgid "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." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:7056 msgid "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." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:7062 msgid "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." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:7070 msgid "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." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:7078 msgid "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 translation, and substitute the translated text at runtime." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7086 msgid "Preparing your project" msgstr "" #. (itstool) path: note/para #: C/index-in.docbook:7089 msgid "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 .ui files, into standard gettext .pot/.po files." msgstr "" #. (itstool) path: note/para #: C/index-in.docbook:7100 msgid "We also assume that you are using autotools (automake and autoconf) to build your project (although autotools is not recommended for new applications), and that you are using ./autogen.sh from gnome-common or a similar autogen.sh file, which, among other things, takes care of some intltool initialization." msgstr "" #. (itstool) path: note/para #: C/index-in.docbook:7112 msgid "If you are using meson (recommended), see the Localisation chapter in Meson's manual. You can then skip this section." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7119 msgid "An alternative to gnome-common's autogen.sh may look like this:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:7123 #, no-wrap msgid "" "#! /bin/sh -e\n" "test -n \"$srcdir\" || srcdir=`dirname \"$0\"`\n" "test -n \"$srcdir\" || srcdir=.\n" "\n" "autoreconf --force --install --verbose --warnings=all \"$srcdir\"\n" "echo \"Running intltoolize --copy --force --automake\"\n" "intltoolize --copy --force --automake\n" "test -n \"$NOCONFIGURE\" || \"$srcdir/configure\" \"$@\"" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7132 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7142 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:7151 #, no-wrap msgid "" "# keep this file sorted alphabetically, one language code per line\n" "de\n" "ja" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7154 msgid "(In addition, you'd have the files de.po and ja.po in your po directory which contain the German and Japanese translations, respectively.)" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7161 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:7170 #, no-wrap msgid "" "src/main.cc\n" "src/other.cc" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7173 msgid "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 .ui files, xml, .desktop files and several more. So, if you have designed some of the application UI in xml files then also add your .ui files to the list in POTFILES.in." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7186 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:7193 #, no-wrap msgid "" "IT_PROG_INTLTOOL([0.35.0])\n" "\n" "GETTEXT_PACKAGE=programname\n" "AC_SUBST(GETTEXT_PACKAGE)\n" "AC_DEFINE_UNQUOTED([GETTEXT_PACKAGE], [\"$GETTEXT_PACKAGE\"],\n" " [The domain to use with gettext])\n" "AM_GNU_GETTEXT([external])\n" "AM_GNU_GETTEXT_VERSION([0.17])\n" "\n" "PROGRAMNAME_LOCALEDIR=[${datadir}/locale]\n" "AC_SUBST(PROGRAMNAME_LOCALEDIR)" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7205 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7212 msgid "AM_GLIB_GNU_GETTEXT has been an alternative to AM_GNU_GETTEXT and AM_GNU_GETTEXT_VERSION, but AM_GLIB_GNU_GETTEXT is now deprecated, and shall not be used in new code." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7223 msgid "Add po to the SUBDIRS variable. Without this, your translations won't get built and installed when you build the program" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7228 msgid "Define INTLTOOL_FILES as:" msgstr "" #. (itstool) path: listitem/programlisting #: C/index-in.docbook:7230 #, no-wrap msgid "" "INTLTOOL_FILES = intltool-extract.in \\\n" " intltool-merge.in \\\n" " intltool-update.in" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7235 msgid "Add INTLTOOL_FILES to the EXTRA_DIST list of files. This ensures that when you do a make dist, these files will be included in the source tarball." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7243 msgid "Update your DISTCLEANFILES:" msgstr "" #. (itstool) path: listitem/programlisting #: C/index-in.docbook:7245 #, no-wrap msgid "" "DISTCLEANFILES = ... intltool-extract \\\n" " intltool-merge \\\n" " intltool-update \\\n" " po/.intltool-merge-cache" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7251 msgid "Depending on the types of files that contain translatable strings, add code such as" msgstr "" #. (itstool) path: listitem/programlisting #: C/index-in.docbook:7254 #, no-wrap msgid "" "desktopdir = $(datadir)/applications\n" "desktop_in_files = programname.desktop.in\n" "desktop_DATA = $(desktop_in_files:.desktop.in=.desktop)\n" "@INTLTOOL_DESKTOP_RULE@" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7219 msgid "In the top-level Makefile.am: <_:itemizedlist-1/>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7262 msgid "In your src/Makefile.am, update your AM_CPPFLAGS to add the following preprocessor macro definition:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:7267 #, no-wrap msgid "" "AM_CPPFLAGS = ... -DPROGRAMNAME_LOCALEDIR=\\\"${PROGRAMNAME_LOCALEDIR}\\\"" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7268 msgid "This macro will be used when you initialize gettext in your source code." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7275 msgid "Marking strings for translation" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7277 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7285 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7291 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:7297 #, no-wrap msgid "" "display_message(\"Getting ready for i18n.\");" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7298 msgid "with:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:7299 #, no-wrap msgid "" "display_message(_(\"Getting ready for i18n.\"));" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7301 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:7310 #, no-wrap msgid "" "xgettext -a -o my-strings --omit-header *.cc *.h" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7312 msgid "Finally, to let your program use the translation for the current locale, add this code to the beginning of your main.cc file, to initialize gettext." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:7317 #, no-wrap msgid "" "bindtextdomain(GETTEXT_PACKAGE, PROGRAMNAME_LOCALEDIR);\n" "bind_textdomain_codeset(GETTEXT_PACKAGE, \"UTF-8\");\n" "textdomain(GETTEXT_PACKAGE);" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7322 msgid "How gettext works" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7324 msgid "The intltool-update or 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 msgmerge or intltool-update script is used to update the localename.po files from the regenerated .pot file." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7338 msgid "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/." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7345 msgid "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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7357 msgid "Testing and adding translations" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7359 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:7365 #, no-wrap msgid "" "intltool-update --pot" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7367 msgid "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." msgstr "" #. (itstool) path: note/para #: C/index-in.docbook:7380 msgid "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. A fuzzy tag appears if a string content changed, but the location is still the same." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7392 msgid "Resources" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7400 msgid " L10N Guidelines for Developers" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7407 msgid "Intltool README" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7413 msgid "How to use Git for GNOME translators" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7419 msgid "gettext manual" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7425 msgid "gtkmm_hello example package" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7431 msgid "gnomemm_hello example package" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7394 msgid "More information about what lies behind the internationalization and localization process is presented and demonstrated in: <_:itemizedlist-1/>" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7442 msgid "Expecting UTF8" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7444 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7451 msgid "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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7459 msgid "Glib::ustring and std::iostreams" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7462 msgid "Unfortunately, the integration with the standard iostreams is not completely foolproof. gtkmm converts Glib::ustrings to a locale-specific encoding (which usually is not UTF-8) if you output them to an ostream with operator<<. Likewise, retrieving Glib::ustrings from istream with operator>> causes a conversion in the opposite direction. But this scheme breaks down if you go through a std::string, e.g. by inputting text from a stream to a std::string and then implicitly converting it to a Glib::ustring. If the string contained non-ASCII characters and the current locale is not UTF-8 encoded, the result is a corrupted Glib::ustring. You can work around this with a manual conversion. For instance, to retrieve the std::string from a ostringstream:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:7478 #, no-wrap msgid "" "std::locale::global(std::locale(\"\")); // Set the global locale to the user's preferred locale.\n" " // Usually unnecessary here, because Glib::init()\n" " // or Gtk::Application::create() does it for you.\n" "std::ostringstream output;\n" "output << percentage << \" % done\";\n" "label->set_text(Glib::locale_to_utf8(output.str()));" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7489 msgid "Pitfalls" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7491 msgid "There are a few common mistakes that you would discover eventually yourself. But this section might help you to avoid them." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7494 msgid "Same strings, different semantics" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7496 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7500 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:7509 #, no-wrap msgid "" "// note to translators: don't translate the \"[noun]\" part - it is\n" "// just here to distinguish the string from another \"jumps\" string\n" "text = strip(gettext(\"jumps[noun]\"), \"[noun]\");" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7513 msgid "If you use Glib's support macros, it's easier. Use C_() instead of _(). For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:7517 #, no-wrap msgid "" "GLib::ustring text(C_(\"noun\", \"jumps\"));" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7522 msgid "Composition of strings" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7524 msgid "C programmers use sprintf() to compose and concatenate strings. C++ favors 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7531 msgid "For instance, this code would be problematic:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:7533 #, no-wrap msgid "" "std::cout << _(\"Current amount: \") << amount\n" " << _(\" Future: \") << future << std::endl;\n" "\n" "label.set_text(_(\"Really delete \") + filename + _(\" now?\"));" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7538 msgid "So you should either avoid this situation or use Glib::ustring::compose() which supports syntax such as:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:7543 #, no-wrap msgid "" "std::cout << Glib::ustring::compose(\n" " _(\"Current amount: %1 Future: %2\"), amount, future) << std::endl;\n" "\n" "label.set_text(Glib::ustring::compose(_(\"Really delete %1 now?\"), filename));" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7550 msgid "Assuming the displayed size of strings" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7552 msgid "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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7556 msgid "Unusual words" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7558 msgid "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\"" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7564 msgid "Using non-ASCII characters in strings" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7566 msgid "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 (©)." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7572 msgid "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 character." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7580 msgid "Getting help with translations" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7582 msgid "If your program is free software, there is a whole GNOME subproject devoted to helping you make translations, the GNOME Translation Project." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7587 msgid "The way it works is that you upload your source code to a git repository where translators can access it, then contact the gnome-i18n mailing list and ask to have your program added to the list of modules to translate." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7592 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7604 msgid "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." msgstr "" #. (itstool) path: chapter/title #. (itstool) path: section/title #: C/index-in.docbook:7616 #: C/index-in.docbook:7698 msgid "Custom Widgets" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:7618 msgid "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 behavior. But you might occasionally find that no suitable starting point already exists. In this case, you can implement a widget from scratch." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7625 msgid "Custom Containers" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7630 msgid "get_request_mode_vfunc(): Return what Gtk::SizeRequestMode is preferred by the container." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7631 msgid "measure_vfunc(): Calculate the minimum and natural width or height of the container." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7632 msgid "size_allocate_vfunc(): Position the child widgets, given the height and width that the container has actually been given." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7627 msgid "When deriving a custom container widget directly from Gtk::Widget, you should override the following virtual methods: <_:itemizedlist-1/>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7636 msgid "The get_request_mode_vfunc(), measure_vfunc(), and size_allocate_vfunc() virtual methods control the layout of the child widgets. For instance, if your container has 2 child widgets, with one below the other, your get_request_mode_vfunc() might request height-for-width layout. Then your measure_vfunc() might report the maximum of the widths of the child widgets when asked to report width, and it might report the sum of their heights when asked to report height. 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7653 msgid "You are not guaranteed to get the Gtk::SizeRequestMode that you request. Therefore measure_vfunc() must return sensible values for all reasonable values of its input parameters. For a description of measure_vfunc()'s parameters see also the description of Gtk::Widget::measure(), which may be better documented than measure_vfunc()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7660 msgid "size_allocate_vfunc() receives the actual height and width that the parent container has decided to give to your widget. This might be more than the minimum, or even more than the natural size, 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. It's your container, so you decide." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7669 msgid "Your container must unparent its children before the underlying C object (a gtkmm__GtkWidget) is finalized. If your container is used as a managed widget, it shall unparent its children in a Gtk::Widget::signal_destroy() handler (available since gtkmm 4.8). If your container is not managed, that signal handler is not called. Instead the children shall be unparented in the C++ destructor. If you want your container to be useful both ways, unparent the children both in the destructor and in a signal handler. See the example code." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7681 msgid "This example implements a container with child widgets, one above the other. Of course, in this case it would be far simpler just to use a vertical Gtk::Box or Gtk::Grid." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:7686 msgid "Custom Container" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:7688 msgctxt "_" msgid "external ref='figures/custom_container.png' md5='865833944746eeb806eae028f0b2a25b'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7692 msgid "Source Code" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7700 msgid "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." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7711 msgid "get_request_mode_vfunc(): (optional) Return what Gtk::SizeRequestMode is preferred by the widget." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7712 msgid "measure_vfunc(): Calculate the minimum and natural width or height of the widget." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7713 msgid "size_allocate_vfunc(): (optional) Position the widget, given the height and width that it has actually been given." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7714 msgid "on_realize(): (optional)" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7715 msgid "on_unrealize(): (optional)" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7716 msgid "on_map(): (optional)" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7717 msgid "on_unmap(): (optional)" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7718 msgid "snapshot_vfunc(): Create a render node, e.g. a Cairo::Context node, and draw on it." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7706 msgid "When deriving from Gtk::Widget, you should override the following virtual methods. The methods marked (optional) need not be overridden in all custom widgets. The base class's methods may be appropriate. <_:itemizedlist-1/>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7722 msgid "The first 3 methods in the previous table are also overridden in custom containers. They are briefly described in the Custom Containers section." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7728 msgid "Class Init and Instance Init Functions" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7730 msgid "Some GTK functions, if called at all, must be called from the class init function. Some other GTK functions, if called, must be called from the instance init function. If your custom widget must call any of those functions, you can derive a class from Glib::ExtraClassInit and derive your custom class from that class. The custom CSS name example shows how that's done." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7742 msgid "This example implements a widget which draws Penrose triangles." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:7745 msgid "Custom Widget" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:7747 msgctxt "_" msgid "external ref='figures/custom_widget.png' md5='30f9b406a95d5b0d17b6fc081c359b98'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7751 msgid "Source Code" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7756 msgid "Custom CSS Names" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7758 msgid "Many aspects of the look of widgets are controlled by CSS (Cascading Style Sheet) files. With CSS files you can choose color, font, line thickness, etc. If you give some widgets their own names or their own CSS classes, you can define CSS rules that apply only to those widgets, for instance certain buttons, without affecting other similar widgets." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7765 msgid "CSS Node Name, Widget Name, CSS Class Name" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7769 msgid "gtk_widget_class_set_css_name() can only be called from the class init function. It sets the CSS node name of all instances of a class (a GType). See the Class Init and Instance Init Functions section." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7773 msgid "Gtk::Widget::set_name() can be called from a C++ constructor. It sets the name of a widget instance." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7776 msgid "Gtk::Widget::add_class_name() can be called from a C++ constructor. It adds the name of a CSS class, used by a widget instance." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7767 msgid "There are three ways of referring from a widget to data in a CSS file: <_:itemizedlist-1/> The following example shows a button with its own CSS node name, a label with a widget name and a label that uses its own CSS class." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7785 msgid "Custom Style Information" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7787 msgid "To add a style sheet to an application, use one of the Gtk::CssProvider::load_from_*() methods. Then add it with Gtk::StyleProvider::add_provider_for_display() (available since gtkmm 4.10) or Gtk::StyleContext::add_provider_for_display(). Gtk::StyleContext also contains methods to read some style information, but this class is deprecated since gtkmm 4.10." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7794 msgid "CSS files are described in the documentation of GTK." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7800 msgid "This example implements a button and two labels with custom style information." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:7803 msgid "Custom CSS Name" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:7805 msgctxt "_" msgid "external ref='figures/custom_css_name.png' md5='fb3d968b1fd40eb219e5a78946adff0f'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7809 msgid "Source Code" msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:7816 msgid "Multi-threaded programs" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7819 msgid "The constraints" msgstr "" #. (itstool) path: footnote/para #: C/index-in.docbook:7830 msgid "These interactions arise from the fact that, amongst other things, a class inheriting from sigc::trackable will, via that inheritance, have a std::list object keeping track of slots created by calls to sigc::mem_fun() representing any of its non-static methods (more particularly it keeps a list of callbacks which will null the connected slots on its destruction). Each sigc::slot object also keeps, via sigc::slot_rep, its own sigc::trackable object to track any sigc::connection objects which it needs to inform about its demise, and also has a function to deregister itself from any sigc::trackable on disconnection or destruction. sigc::signal objects also keep lists of slots, which will be updated by a call to their connect() method or calls to any sigc::connection object relating to such a connection." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7821 msgid "Care is required when writing programs based on gtkmm using multiple threads of execution, arising from the fact that libsigc++, and in particular sigc::trackable, are not thread-safe. That's because none of the complex interactions that occur behind the scenes when using libsigc++ are protected by a mutex or other means of synchronization. <_:footnote-1/>" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7854 msgid "The rules" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7856 msgid "This requires a number of rules to be observed when writing multi-threaded programs using gtkmm. These are set out below, but one point to note is that extra care is required when deriving classes from sigc::trackable, because the effects are unintuitive (see particularly points 4 and 5 below)." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7867 msgid "Use Glib::Dispatcher to invoke gtkmm functions from worker threads (this is dealt with in more detail in the next section)." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7875 msgid "A sigc::signal object should be regarded as owned by the thread which created it. Only that thread should connect a sigc::slot object to the signal object, and only that thread should emit() or call operator()() on the signal, or null any connected sigc::slot object. It follows (amongst other things) that any signal object provided by a gtkmm widget should only be operated on in the main GUI thread and any object deriving from sigc::trackable having its non-static methods referenced by slots connected to the signal object should only be destroyed in that thread." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7891 msgid "Any sigc::connection object should be regarded as owned by the thread in which the method returning the sigc::connection object was called. Only that thread should call sigc::connection methods on the object." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7901 msgid "A sigc::slot object created by a call to sigc::mem_fun() which references a method of a class deriving from sigc::trackable should never be copied to another thread, nor destroyed by a different thread than the one which created it." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7911 msgid "If a particular class object derives from sigc::trackable, only one thread should create sigc::slot objects representing any of the class's non-static methods by calling sigc::mem_fun(). The first thread to create such a slot should be regarded as owning the relevant object for the purpose of creating further slots referencing any of its non-static methods using that function, or nulling those slots by disconnecting them or destroying the trackable object." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7925 msgid "Although glib is itself thread-safe, any glibmm wrappers which use libsigc++ will not be. So for example, only the thread in which a main loop runs should call Glib::SignalIdle::connect(), Glib::SignalIO::connect(), Glib::SignalTimeout::connect(), Glib::SignalTimeout::connect_seconds for that main loop, or manipulate any sigc::connection object returned by them." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:7937 msgid "The connect*_once() variants, Glib::SignalIdle::connect_once(), Glib::SignalTimeout::connect_once(), Glib::SignalTimeout::connect_seconds_once(), are thread-safe for any case where the slot is not created by a call to sigc::mem_fun() which represents a method of a class deriving from sigc::trackable." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:7955 msgid "Using Glib::Dispatcher" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7957 msgid "The slots connected to sigc::signal objects execute in the thread which calls emit() or operator()() on the signal. Glib::Dispatcher does not behave this way: instead its connected slots execute in the thread in which the Glib::Dispatcher object was constructed (which must have a glib main loop). If a Glib::Dispatcher object is constructed in the main GUI thread (which will therefore be the receiver thread), any worker thread can emit on it and have the connected slots safely execute gtkmm functions." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7971 msgid "Some thread safety rules on the use of Glib::Dispatcher still apply. As mentioned, a Glib::Dispatcher object must be constructed in the receiver thread (the thread in whose main loop it will execute its connected slots). By default this is the main program thread, although there is a Glib::Dispatcher constructor which can take the Glib::MainContext object of any thread which has a main loop. Only the receiver thread should call connect() on the Glib::Dispatcher object, or manipulate any related sigc::connection object, unless additional synchronization is employed. However, any worker thread can safely emit on the Glib::Dispatcher object without any locking once the receiver thread has connected the slots, provided that it is constructed before the worker thread is started (if it is constructed after the thread has started, additional synchronization will normally be required to ensure visibility)." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:7991 msgid "Aside from the fact that connected slots always execute in the receiver thread, Glib::Dispatcher objects are similar to sigc::signal<void()> objects. They therefore cannot pass unbound arguments nor return a value. The best way to pass unbound arguments is with a thread-safe (asynchronous) queue. At the time of writing glibmm does not have one, although most people writing multi-threaded code will have one available to them (they are relatively easy to write although there are subtleties in combining thread safety with strong exception safety)." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8004 msgid "A Glib::Dispatcher object can be emitted on by the receiver thread as well as by a worker thread, although this should be done within reasonable bounds. On unix-like systems Glib::Dispatcher objects share a single common pipe, which could in theory at least fill up on a very heavily loaded system running a program with a very large number of Dispatcher objects in use. Were the pipe to fill up before the receiver thread's main loop has had an opportunity to read from it to empty it, and the receiver thread attempt to emit and so write to it when it is in that condition, the receiver thread would block on the write, so deadlocking. Where the receiver thread is to emit, a normal sigc::signal<void()> object could of course be used instead." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8025 msgid "This is an example program with two threads, one GUI thread, like in all gtkmm programs, and one worker thread. The worker thread is created when you press the Start work button. It is deleted when the work is finished, when you press the Stop work button, or when you press the Quit button." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8033 msgid "A Glib::Dispatcher is used for sending notifications from the worker thread to the GUI thread. The ExampleWorker class contains data which is accessed by both threads. This data is protected by a std::mutex. Only the GUI thread updates the GUI." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8041 msgid "Compiling and linking a multi-threaded program can require special compiler and linker options. If you use the g++ compiler, add the -pthread option. Other compilers may require other options. If you build with meson, it handles the multi-threading complications for you, if you add dependency('threads')." msgstr "" #. (itstool) path: figure/title #: C/index-in.docbook:8050 msgid "Multi-Threaded Program" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:8052 msgctxt "_" msgid "external ref='figures/multithread.png' md5='acc87c2afb17321ab098b7f0b8a46b27'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8056 msgid "Source Code" msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:8063 msgid "Recommended Techniques" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:8065 msgid "This section is simply a gathering of wisdom, general style guidelines and hints for creating gtkmm applications." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:8069 msgid "Use Meson! It is your friend :) It examines C and C++ files, determines how they depend on each other, and generates build.ninja or an equivalent file so the files can be compiled in the correct order. Meson permits automatic configuration of software installation, handling a large number of system quirks to increase portability." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:8077 msgid "Subclass Widgets to better organize 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." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:8082 msgid "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 use special versions of sigc::signal, but you should use normal sigc::signals, as described in the libsigc++ documentation." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:8091 msgid "Application Lifetime" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8092 msgid "Most applications will have only one Window, or only one main window. These applications can use Gtk::Application::make_window_and_run(int argc, char** argv, T_Args&&... args). It creates and shows a window. When the window is hidden, make_window_and_run() deletes the window and returns to the caller. This might happen when the user closes the window, or when your code decides to hide the window with set_visible(false). You can prevent the user from closing the window (for instance, if there are unsaved changes) by overriding Gtk::Window::on_close_request()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8101 msgid "Most of our examples use this technique." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:8105 msgid "Using a gtkmm widget" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8107 msgid "Our examples all tend to have the same structure. They follow these steps for using a Widget:" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:8116 msgid "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 or Gtk::make_managed() in your code." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:8125 msgid "Set the attributes of the widget. If the widget has no default constructor, then you will need to initialize the widget in the initializer list of your container class's constructor." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:8133 msgid "Connect any signals you wish to use to the appropriate handlers." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:8139 msgid "Pack the widget into a container using the appropriate call, e.g. Gtk::Box::append()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8149 msgid "If you don't want all widgets to be shown, call Gtk::Widget::set_visible(false) on the widgets that you don't want to show. If a container widget is hidden, all of its child widgets are also hidden, even if set_visible(false) is not called on the child widgets." msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:8160 msgid "Building applications" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:8162 msgid "This chapter is similar to Building applications and following sections in the Getting Started chapter in the GTK documentation. The same application is built, but gtkmm is used instead of GTK." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:8172 msgid "The binary file" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:8173 msgid "This gets installed in /usr/bin." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:8176 msgid "A desktop file" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:8177 msgid "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." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:8182 msgid "An icon" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:8183 msgid "The icon gets installed in /usr/share/icons/hicolor/48x48/apps, where it will be found regardless of the current theme." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:8187 msgid "A settings schema" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:8188 msgid "If the application uses Gio::Settings, it will install its schema in /usr/share/glib-2.0/schemas, so that tools like dconf-editor can find it." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:8193 msgid "Other resources" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:8194 msgid "Other files, such as Gtk::Builder 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." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:8168 msgid "An application consists of a number of files: <_:variablelist-1/>" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:8202 msgid "gtkmm includes application support that is built on top of Gio::Application. In this chapter we'll build a simple application by starting from scratch, adding more and more pieces over time. Along the way, we'll learn about Gtk::Application, Gtk::Builder, resources, menus, settings, Gtk::HeaderBar, Gtk::Stack, Gtk::SearchBar, Gtk::ListBox, and more." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:8211 msgid "The full, buildable sources for these examples can be found in the examples/book/buildapp directory of the gtkmm-documentation source distribution, or online in the gtkmm-documentation git repository. You can build each example separately by using meson and ninja with the meson.build file or by using make with the Makefile.example file. For more information, see the README included in the buildapp directory." msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:8224 #: C/index-in.docbook:8268 msgid "A trivial application" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8226 msgid "When using Gtk::Application, the main() function can be very simple. We just call Gtk::Application::run() on an instance of our application class." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8232 msgid "All the application logic is in the application class, which is a subclass of Gtk::Application. 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. (Or rather, our application class tries to open the files, but our subclassed application window does not yet do what it's told to do.)" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8241 msgid "To handle these two cases, we override signal_activate()'s default handler, which gets called when the application is launched without commandline arguments, and signal_open()'s default handler, which gets called when the application is launched with commandline arguments." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8248 msgid "Gio::Application Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8249 msgid "Gtk::Application Reference" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8251 msgid "Another important class that is part of the application support in gtkmm is Gtk::ApplicationWindow. It is typically subclassed as well. Our subclass does not do anything yet, so we will just get an empty window." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8257 msgid "As part of the initial setup of our application, we also create an icon and a desktop file. Note that @bindir@ in the desktop file needs to be replaced with the actual path to the binary before this desktop file can be used." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8263 msgid "Here is what we've achieved so far:" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:8270 msgctxt "_" msgid "external ref='figures/buildapp_trivial_app.png' md5='fe94e3d80cb888d1827912f49af7a6f3'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8274 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8279 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:8284 #: C/index-in.docbook:8327 msgid "Populating the window" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8286 msgid "In this step, we use a Gtk::Builder instance to associate a Gtk::Builder ui file with our application window class." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8291 msgid "Our simple ui file gives the window a title, and puts a Gtk::Stack widget as the main content." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8296 msgid "To make use of this file in our application, we revisit our Gtk::ApplicationWindow subclass, and call Gtk::Builder::create_from_resource() and Gtk::Builder::get_widget_derived() from the ExampleAppWindow::create() method to get an instance of our subclassed Gtk::ApplicationWindow. See the Using derived widgets section for more information about get_widget_derived()." msgstr "" #. (itstool) path: para/screen #: C/index-in.docbook:8315 #, no-wrap msgid "" "$ glib-compile-resources --target=resources.c --generate-source exampleapp.gresource.xml" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8307 msgid "You may have noticed that we use the _from_resource() variant of the method that reads the ui file. 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. 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: <_:screen-1/> The Gio::Resource and glib-compile-resources section contains more information about resource files. If you build with Meson, use the compile_resources() function in Meson's GNOME module." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8322 msgid "Our application now looks like this:" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:8329 msgctxt "_" msgid "external ref='figures/buildapp_populating_window.png' md5='4af45b6a60b3973334ac91eb3f1dcf91'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8333 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:8338 #: C/index-in.docbook:8374 msgid "Opening files" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8340 msgid "In this step, we make our application show the contents of all the files that it is given on the commandline." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8345 msgid "To this end, we add a data member to our application window and keep a pointer to the Gtk::Stack there. We get the pointer with a call to Gtk::Builder::get_widget() in the application window's constructor." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8351 msgid "Now we revisit the ExampleAppWindow::open_file_view() method that is called for each commandline argument, and construct a Gtk::TextView that we then add as a page to the stack." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8357 msgid "Lastly, we add a Gtk::StackSwitcher to the titlebar area in the ui file, and we tell it to display information about our stack." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8362 msgid "The stack switcher gets all its information it needs to display tabs 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() method." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8369 msgid "Our application is beginning to take shape:" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:8376 msgctxt "_" msgid "external ref='figures/buildapp_opening_files.png' md5='ad2373e10879d9724c91408aa6dbd4c3'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8380 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:8385 #: C/index-in.docbook:8420 msgid "A menu" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8387 msgid "The menu is shown at the right side of the headerbar. It is meant to collect infrequently used actions that affect the whole application." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8392 msgid "Just like the application window, we specify our menu in a ui file, and add it as a resource to our binary." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8397 msgid "To make the menu appear, we have to load the ui file and associate the resulting menu model with the menu button that we've added to the headerbar. Since menus work by activating Gio::Actions, we also have to add a suitable set of actions to our application." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8404 msgid "Adding the actions is best done in the on_startup() default signal handler, which is guaranteed to be called once for each primary application instance." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8409 msgid "Our preferences menu item does not do anything yet, but the Quit menu item is fully functional. It can also be activated by the usual Ctrl-Q shortcut. The shortcut is added with Gtk::Application::set_accel_for_action()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8415 msgid "The menu looks like this:" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:8422 msgctxt "_" msgid "external ref='figures/buildapp_menu.png' md5='a9d0d291ab0f472a7cd9c38c01130d8d'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8426 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:8431 #: C/index-in.docbook:8501 msgid "A preference dialog" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8433 msgid "A typical application will have 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8439 msgid "We are going to use Gio::Settings to store our preferences. Gio::Settings requires a schema that describes our settings, in our case the org.gtkmm.exampleapp.gschema.xml file." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8445 msgid "Before we can make use of this schema in our application, we need to compile it into the binary form that Gio::Settings expects. GIO provides macros to do this in autotools-based projects. See the description of GSettings. Meson provides the compile_schemas() function in the GNOME module." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8454 msgid "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 Gio::Settings::bind() to bind settings keys to object properties, as we do for the transition setting in ExampleAppWindow's constructor." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:8460 #, no-wrap msgid "" "m_settings = Gio::Settings::create(\"org.gtkmm.exampleapp\");\n" "m_settings->bind(\"transition\", m_stack->property_transition_type());\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8464 msgid "The code to connect the font setting is a little more involved, since it corresponds to an object property in a Gtk::TextTag that we must first create. The code is in ExampleAppWindow::open_file_view()." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:8469 #, no-wrap msgid "" "auto tag = buffer->create_tag();\n" "m_settings->bind(\"font\", tag->property_font());\n" "buffer->apply_tag(tag, buffer->begin(), buffer->end());\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8474 msgid "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 Gtk::Window, and we'll use the same techniques that we've already seen in ExampleAppWindow: a Gtk::Builder ui file and settings bindings. In this case the bindings are more involved, though. We use Gtk::FontDialogButton and Gtk::DropDown in the preference dialog. The types of the properties in these classes can't be automatically converted to the string type that Gio::Settings requires." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8487 msgid "When we've created the prefs.ui file and the ExampleAppPrefs class, we revisit the ExampleApplication::on_action_preferences() method in our application class, and make it open a new preference dialog." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:8492 #, no-wrap msgid "" "auto prefs_dialog = ExampleAppPrefs::create(*get_active_window());\n" "prefs_dialog->present();\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8496 msgid "After all this work, our application can now show a preference dialog like this:" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:8503 msgctxt "_" msgid "external ref='figures/buildapp_pref_dialog.png' md5='ecc7fa5d31086c536a5ad279eddfbf23'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8507 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:8512 #: C/index-in.docbook:8554 msgid "Adding a search bar" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8514 msgid "We continue to flesh out the functionality of our application. For now, we add search. gtkmm supports this with Gtk::SearchEntry and Gtk::SearchBar. The search bar is a widget that can slide in from the top to present a search entry." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8520 msgid "We add a toggle button to the header bar, which can be used to slide out the search bar below the header bar. The new widgets are added in the window.ui file." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8525 msgid "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, shown here without error handling." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:8530 #, no-wrap msgid "" "void ExampleAppWindow::on_search_text_changed()\n" "{\n" " const auto text = m_searchentry->get_text();\n" " auto tab = dynamic_cast<Gtk::ScrolledWindow*>(m_stack->get_visible_child());\n" " auto view = dynamic_cast<Gtk::TextView*>(tab->get_child());\n" "\n" " // Very simple-minded search implementation.\n" " auto buffer = view->get_buffer();\n" " Gtk::TextIter match_start;\n" " Gtk::TextIter match_end;\n" " if (buffer->begin().forward_search(text, Gtk::TextSearchFlags::CASE_INSENSITIVE,\n" " match_start, match_end))\n" " {\n" " buffer->select_range(match_start, match_end);\n" " view->scroll_to(match_start);\n" " }\n" "}\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8549 msgid "With the search bar, our application now looks like this:" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:8556 msgctxt "_" msgid "external ref='figures/buildapp_search_bar.png' md5='ca0d7fdb0f37cbd592f2c55904bb6f3f'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8560 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:8565 #: C/index-in.docbook:8599 msgid "Adding a side bar" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8567 msgid "As another piece of functionality, we are adding a sidebar, which demonstrates Gtk::Revealer and Gtk::ListBox. The new widgets are added in the window.ui file." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8573 msgid "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 a checkbutton for the new feature to the menu. A menu item is added to the ui file gears_menu.ui." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8580 msgid "To connect the menu item to the new show-words setting, we use a Gio::Action corresponding to the given Gio::Settings key. In ExampleAppWindow's constructor:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:8585 #, no-wrap msgid "" "// Connect the menu to the MenuButton m_gears, and bind the show-words setting\n" "// to the win.show-words action and the \"Words\" menu item.\n" "// (The connection between action and menu item is specified in gears_menu.ui.)\n" "auto menu_builder = Gtk::Builder::create_from_resource(\"/org/gtkmm/exampleapp/gears_menu.ui\");\n" "auto menu = menu_builder->get_object<Gio::MenuModel>(\"menu\");\n" "m_gears->set_menu_model(menu);\n" "add_action(m_settings->create_action(\"show-words\"));\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8594 msgid "What our application looks like now:" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:8601 msgctxt "_" msgid "external ref='figures/buildapp_side_bar.png' md5='e13a4b6ebbcf73692dc59a0ba08e59e7'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8605 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:8610 #: C/index-in.docbook:8652 msgid "Properties" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8612 msgid "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 Gio::PropertyAction or by binding them with Glib::Binding." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8618 msgid "To set this up, we add two labels to the header bar in our window.ui file, named lines_label and lines, and get pointers to them in the application window's constructor, 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8626 msgid "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. In ExampleAppWindow's constructor:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:8636 #, no-wrap msgid "" "add_action(Gio::PropertyAction::create(\"show-lines\", m_lines->property_visible()));\n" "m_binding_lines_visible = Glib::Binding::bind_property(m_lines->property_visible(),\n" " m_lines_label->property_visible());\n" "\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8642 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8647 msgid "This brings our example application to this appearance:" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:8654 msgctxt "_" msgid "external ref='figures/buildapp_properties.png' md5='46c52e09cc1b4ddbc095e12f763a4427'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8658 msgid "Source Code" msgstr "" #. (itstool) path: section/title #. (itstool) path: figure/title #: C/index-in.docbook:8663 #: C/index-in.docbook:8689 msgid "Header bar" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8665 msgid "Our application already uses a Gtk::HeaderBar instead of a 'normal' window titlebar. The header bar is a direct child of the window, and its type is titlebar. This is set in the window.ui file." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8672 msgid "Here we'll just make two small changes to the header bar. The decoration-layout property is set in the window.ui file, to show only the close button, and hide the minimize and maximize buttons. We also include an icon in the resource file, and set up this icon as the window icon. In ExampleAppWindow's constructor:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:8679 #, no-wrap msgid "" "Gtk::IconTheme::get_for_display(get_display())->add_resource_path(\"/org/gtkmm/exampleapp\");\n" "set_icon_name(\"exampleapp\");\n" "\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8684 msgid "Here is how the application now looks:" msgstr "" #. (itstool) path: imageobject/imagedata #. This is a reference to an external file such as an image or video. When #. the file changes, the md5 hash will change to let you know you need to #. update your localized copy. The msgstr is not used at all. Set it to #. whatever you like once you have updated your copy of the file. #: C/index-in.docbook:8691 msgctxt "_" msgid "external ref='figures/buildapp_header_bar.png' md5='b2ab5d871b0deff13f04aac71700b1a0'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8695 msgid "The window.ui file sets a header bar title, but this title is not shown. That's because the stack switcher is a child of type title. The stack switcher becomes a custom title that hides the title label." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8701 msgid "Source Code" msgstr "" #. (itstool) path: chapter/title #: C/index-in.docbook:8708 msgid "Contributing" msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:8710 msgid "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." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:8716 msgid "Ideally, we would like you to provide a merge request to the docs/tutorial/C/index-in.docbook file. This file is in the gtkmm-documentation module in GNOME git." msgstr "" #. (itstool) path: chapter/para #: C/index-in.docbook:8722 msgid "If you do decide to contribute, please post your contribution as an issue or merge request to GitLab. You can also discuss your ideas on GNOME's Discourse instance, under the Platform/Language bindings category with a cplusplus tag. 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." msgstr "" #. (itstool) path: appendix/title #: C/index-in.docbook:8737 msgid "The RefPtr smartpointer" msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:8739 msgid "Glib::RefPtr is a smartpointer. Specifically, it is a reference-counting smartpointer. You might be familiar with std::unique_ptr<> and std::shared_ptr<>, which are also smartpointers. In gtkmm-4.0 Glib::RefPtr<> is an alias for std::shared_ptr<>, which is reference-counting. Glib::RefPtr<> was introduced long before there was a reference-counting smartpointer in the C++ Standard Library." msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:8750 msgid "If you make your own Glib::ObjectBase-derived classes with create() methods that return a Glib::RefPtr, you must use Glib::make_refptr_for_instance() in your create() methods. This function creates a std::shared_ptr with a special deleter, which handles the reference-count for the wrapped C object." msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:8758 msgid "Glib::RefPtr is not used for storing widgets derived from Gtk::Widget. Widgets have public constructors instead of protected constructors and create() methods." msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:8764 msgid "Reference" msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:8766 msgid "A smartpointer acts much like a normal pointer. Here are a few examples." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:8769 msgid "Copying" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8770 msgid "You can copy RefPtrs, just like normal pointers. But unlike normal pointers, you don't need to worry about deleting the underlying instance." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:8775 #, no-wrap msgid "" "auto refPixbuf = Gdk::Pixbuf::create_from_file(filename);\n" "auto refPixbuf2 = refPixbuf;\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8778 msgid "Of course this means that you can store RefPtrs in standard containers, such as std::vector or std::list." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:8782 #, no-wrap msgid "" "std::list<Glib::RefPtr<Gdk::Pixbuf>> listPixbufs;\n" "auto refPixbuf = Gdk::Pixbuf::create_from_file(filename);\n" "listPixbufs.push_back(refPixbuf);\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:8789 msgid "Dereferencing" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8790 msgid "You can dereference a smartpointer with the -> operator, to call the methods of the underlying instance, just like a normal pointer." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:8793 #, no-wrap msgid "" "auto refPixbuf = Gdk::Pixbuf::create_from_file(filename);\n" "auto width = refPixbuf->get_width();\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8796 msgid "You can also use the * operator and the get() method to access the underlying instance, but it's usually a bad idea to do so. Unless you are careful, you can end up with a pointer or a reference which is not included in the reference count." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:8801 #, no-wrap msgid "" "auto refPixbuf = Gdk::Pixbuf::create_from_file(filename);\n" "auto& underlying = *refPixbuf; // Possible, but not recommended\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:8807 msgid "Casting" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8808 msgid "You can cast RefPtrs to base types, just like normal pointers." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:8812 #, no-wrap msgid "" "auto refStore = Gtk::TreeStore::create(columns);\n" "Glib::RefPtr<Gtk::TreeModel> refModel = refStore;\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8815 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8819 msgid "You can also cast to a derived type, but the syntax is a little different than with a normal pointer." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:8822 #, no-wrap msgid "" "auto refStore = std::dynamic_pointer_cast<Gtk::TreeStore>(refModel);\n" "auto refStore2 = std::static_pointer_cast<Gtk::TreeStore>(refModel);\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:8828 msgid "Checking for nullptr" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8829 msgid "Just like normal pointers, you can check whether a RefPtr points to anything." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:8833 #, no-wrap msgid "" "auto refModel = m_TreeView.get_model();\n" "if (refModel)\n" "{\n" " auto cols_count = refModel->get_n_columns();\n" " ...\n" "}\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8840 msgid "But unlike normal pointers, RefPtrs are automatically initialized to nullptr so you don't need to remember to do that yourself." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:8847 msgid "Constness" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8848 msgid "The use of the const keyword in C++ is not always clear. You might not realize that const Something* declares a pointer to a const Something. The pointer can be changed, but not the Something that it points to." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8854 msgid "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>&." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8861 msgid "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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:8875 msgid "Connecting signal handlers" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8877 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8887 msgid "Here's an example of a signal handler being connected to a signal:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:8891 #, no-wrap msgid "" "\n" "#include <gtkmm/button.h>\n" "\n" "void on_button_clicked()\n" "{\n" " std::cout << \"Hello World\" << std::endl;\n" "}\n" "\n" "class some_class\n" "{\n" "public:\n" " some_class\n" " {\n" " button.signal_clicked().connect(sigc::ptr_fun(&on_button_clicked));\n" " }\n" "private:\n" " Gtk::Button button {\"Hello World\"};\n" "};\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8911 msgid "There's rather a lot to think about in this (non-functional) code. First let's identify the parties involved:" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:8919 msgid "The signal handler is on_button_clicked()." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:8925 msgid "We're hooking it up to the Gtk::Button object called button." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:8932 msgid "When the Button emits its clicked signal, on_button_clicked() will be called." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8940 msgid "Now let's look at the connection again:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:8944 #, no-wrap msgid "" " ...\n" " button.signal_clicked().connect(sigc::ptr_fun(&on_button_clicked));\n" " ...\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8949 msgid "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()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8956 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8965 msgid "A C++ lambda expression is a functor which can be implicitly converted to a sigc::slot in the call to connect(). A lambda expression can be used instead of sigc::ptr_fun(). It's also possible to use a lambda expression instead of sigc::mem_fun(), but then you won't get automatic disconnection of the signal handler when a sigc::trackable-derived object goes out of scope." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:8974 msgid "Here's a slightly larger example of slots in action:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:8978 #, no-wrap msgid "" "\n" "#include <gtkmm/button.h>\n" "\n" "void on_button_clicked()\n" "{\n" " std::cout << \"Hello World\" << std::endl;\n" "}\n" "\n" "class some_class\n" "{\n" "public:\n" " some_class\n" " {\n" " button.signal_clicked().connect(sigc::ptr_fun(&on_button_clicked));\n" " button.signal_clicked().connect(sigc::mem_fun(*this, &some_class::on_button_clicked));\n" " }\n" " void on_button_clicked();\n" "private:\n" " Gtk::Button button {\"Hello World\"};\n" "};\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9000 msgid "The first call to connect() is just like the one we saw last time; nothing new here." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9003 msgid "The next is more interesting. sigc::mem_fun() is called with two arguments. The first argument is *this, 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9012 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9019 msgid "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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9031 msgid "Writing signal handlers" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9033 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9039 #, no-wrap msgid "" "Glib::SignalProxy<bool(Gtk::DirectionType)> signal_focus()\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9042 msgid "Other than the signal's name (focus), the template arguments are important to note here. The first argument, bool, is the type that the signal handler should return; and the type within parentheses, 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9051 msgid "The same principles apply for signals which have more arguments. Here's one with three (taken from <gtkmm/textbuffer.h>):" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9056 #, no-wrap msgid "" "Glib::SignalProxy<void(TextBuffer::iterator&, const Glib::ustrin&, int)> signal_insert();\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9059 msgid "It follows the same form. The first type 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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9066 #, no-wrap msgid "" "void on_insert(TextBuffer::iterator& pos, const Glib::ustring& text, int bytes)\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9071 msgid "Disconnecting signal handlers" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9073 msgid "Let's take another look at a Signal's connect method:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9077 #, no-wrap msgid "" "sigc::connection signal<void(int)>::connect(const sigc::slot<void(int)>&);\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9080 msgid "The returned sigc::connection can be used to control the connection. By keeping a connection object you can disconnect its associated signal handler using the sigc::connection::disconnect() method." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9088 msgid "Overriding default signal handlers" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9090 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9097 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9104 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9109 msgid "gtkmm classes are designed with overriding in mind; they contain virtual member methods specifically intended to be overridden." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9114 msgid "Let's look at an example of overriding:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9118 #, no-wrap msgid "" "#include <gtkmm/button.h>\n" "\n" "class OverriddenButton : public Gtk::Button\n" "{\n" "protected:\n" " void on_clicked() override;\n" "}\n" "\n" "void OverriddenButton::on_clicked()\n" "{\n" " std::cout << \"Hello World\" << std::endl;\n" "\n" " // call the base class's version of the method:\n" " Gtk::Button::on_clicked();\n" "}\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9135 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9146 msgid "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 connected signal handlers, 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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9160 msgid "Binding extra arguments" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9162 msgid "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." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9168 #, no-wrap msgid "" "m_button1.signal_clicked().connect(sigc::bind(sigc::mem_fun(*this, &HelloWorld::on_button_clicked), \"button 1\"));\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9170 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9175 #, no-wrap msgid "" "void on_button_clicked(const Glib::ustring& data);\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9177 msgid "Of course, a normal \"clicked\" signal handler would have no arguments." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9179 msgid "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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9191 msgid "Event signals" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9193 msgid "Event signals are emitted as a result of some user input, for instance a key press or a mouse motion. Usually you don't handle these events directly. Instead, you use a subclass of Gtk::EventController, such as Gtk::EventControllerKey or Gtk::GestureClick. Event controllers can be added to a widget with Gtk::Widget::add_controller()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9200 msgid "You might occasionally find it useful to handle 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 Gtk::GestureClick::signal_pressed() if you needed this information. Gtk::EventControllerKey::signal_key_pressed() is often used to handle key-presses." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9210 msgid "Some event controller 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9218 msgid "Handling an event doesn't affect the Widget's other signals. If you handle Gtk::GestureClick::signal_pressed() for Gtk::Button, you'll still be able to get the clicked signal. They are emitted at (nearly) the same time." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9227 #, no-wrap msgid "" "void on_button_press(int n_press, double x, double y);\n" "Gtk::Button button(\"label\");\n" "auto controller = Gtk::GestureClick::create();\n" "controller->set_propagation_phase(Gtk::PropagationPhase::CAPTURE);\n" "controller->signal_pressed().connect(sigc::ptr_fun(&on_button_press));\n" "button.add_controller(controller);\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9234 msgid "When the mouse is over the button and a mouse button is pressed, on_button_press() will be called." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9238 msgid "The call to set_propagation_phase() is necessary in this case because the GtkButton C class adds an event controller, handling button clicks in the capture phase. GtkButton claims the event, meaning that the event is not propagated in the bubble phase, where event controllers handle events by default." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9247 msgid "Signal Handler sequence" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9249 msgid "By default, signal handlers that return void are called after any previously-connected signal handlers. However, this can be a problem with event signals that can stop event propagation by returning true. 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, you can specify false for the after parameter. This connect() parameter is optional, if the signal handler returns void. For instance," msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9259 #, no-wrap msgid "" "key_controller->signal_key_pressed().connect(sigc::ptr_fun(&on_mywindow_key_pressed), false);\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9261 msgid "The event is propagated between widgets in 3 phases. <_:orderedlist-1/>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9268 msgid "The Input Handling chapter in the GTK documentation describes user input handling in more detail." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9277 msgid "Exceptions in signal handlers" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9279 msgid "When a program is aborted because of an unhandled C++ exception, it's sometimes possible to use a debugger to find the location where the exception was thrown. This is more difficult than usual if the exception was thrown from a signal handler." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9284 msgid "This section describes primarily what you can expect on a Linux system, when you use the gdb debugger." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9288 msgid "First, let's look at a simple example where an exception is thrown from a normal function (no signal handler)." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9292 #, no-wrap msgid "" "// without_signal.cc\n" "#include <gtkmm.h>\n" "\n" "bool throwSomething()\n" "{\n" " throw \"Something\";\n" " return true;\n" "}\n" "\n" "int main(int argc, char** argv)\n" "{\n" " throwSomething();\n" " auto app = Gtk::Application::create(\"org.gtkmm.without_signal\");\n" " return app->run();\n" "}\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9308 msgid "Here is an excerpt from a gdb session. Only the most interesting parts of the output are shown." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9312 #, no-wrap msgid "" "> gdb without_signal\n" "(gdb) run\n" "terminate called after throwing an instance of 'char const*'\n" "\n" "Program received signal SIGABRT, Aborted.\n" "(gdb) backtrace\n" "#7 0x08048864 in throwSomething () at without_signal.cc:6\n" "#8 0x0804887d in main (argc=1, argv=0xbfffecd4) at without_signal.cc:12\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9321 msgid "You can see that the exception was thrown from without_signal.cc, line 6 (throw \"Something\";)." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9324 msgid "Now let's see what happens when an exception is thrown from a signal handler. Here's the source code." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9328 #, no-wrap msgid "" "// with_signal.cc\n" "#include <gtkmm.h>\n" "\n" "bool throwSomething()\n" "{\n" " throw \"Something\";\n" " return true;\n" "}\n" "\n" "int main(int argc, char** argv)\n" "{\n" " Glib::signal_timeout().connect(sigc::ptr_fun(throwSomething), 500);\n" " auto app = Gtk::Application::create(\"org.gtkmm.with_signal\");\n" " app->hold();\n" " return app->run();\n" "}\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9345 msgid "And here's an excerpt from a gdb session." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9348 #, no-wrap msgid "" "> gdb with_signal\n" "(gdb) run\n" "(with_signal:2703): glibmm-ERROR **:\n" "unhandled exception (type unknown) in signal handler\n" "\n" "Program received signal SIGTRAP, Trace/breakpoint trap.\n" "(gdb) backtrace\n" "#2 0x0063c6ab in glibmm_unexpected_exception () at exceptionhandler.cc:77\n" "#3 Glib::exception_handlers_invoke () at exceptionhandler.cc:150\n" "#4 0x0063d370 in glibmm_source_callback (data=0x804d620) at main.cc:212\n" "#13 0x002e1b31 in Gtk::Application::run (this=0x804f300) at application.cc:178\n" "#14 0x08048ccc in main (argc=1, argv=0xbfffecd4) at with_signal.cc:16\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9361 msgid "The exception is caught in glibmm, and the program ends with a call to g_error(). Other exceptions may result in different behavior, but in any case the exception from a signal handler is caught in glibmm or gtkmm, and gdb can't see where it was thrown." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9367 msgid "To see where the exception is thrown, you can use the gdb command catch throw." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9371 #, no-wrap msgid "" "> gdb with_signal\n" "(gdb) catch throw\n" "Catchpoint 1 (throw)\n" "(gdb) run\n" "Catchpoint 1 (exception thrown), 0x00714ff0 in __cxa_throw ()\n" "(gdb) backtrace\n" "#0 0x00714ff0 in __cxa_throw () from /usr/lib/i386-linux-gnu/libstdc++.so.6\n" "#1 0x08048bd4 in throwSomething () at with_signal.cc:6\n" "(gdb) continue\n" "Continuing.\n" "(with_signal:2375): glibmm-ERROR **\n" "unhandled exception (type unknown) in signal handler\n" "\n" "Program received signal SIGTRAP, Trace/breakpoint trap.\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9386 msgid "If there are many caught exceptions before the interesting uncaught one, this method can be tedious. It can be automated with the following gdb commands." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9391 #, no-wrap msgid "" "(gdb) catch throw\n" "(gdb) commands\n" "(gdb) backtrace\n" "(gdb) continue\n" "(gdb) end\n" "(gdb) set pagination off\n" "(gdb) run\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9399 msgid "These commands will print a backtrace from each throw and continue. The backtrace from the last (or possibly the last but one) throw before the program stops, is the interesting one." msgstr "" #. (itstool) path: appendix/title #: C/index-in.docbook:9408 msgid "Creating your own signals" msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:9410 msgid "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." msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:9416 msgid "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." msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:9423 msgid "For instance, to create a signal that sends 2 parameters, a bool and an int, just declare a sigc::signal, like so:" msgstr "" #. (itstool) path: appendix/programlisting #: C/index-in.docbook:9428 #, no-wrap msgid "" "sigc::signal<void(bool, int)> signal_something;\n" "" msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:9430 msgid "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:" msgstr "" #. (itstool) path: appendix/programlisting #: C/index-in.docbook:9435 #, no-wrap msgid "" "class Server\n" "{\n" "public:\n" " //signal accessor:\n" " using type_signal_something = sigc::signal<void(bool, int)>;\n" " type_signal_something signal_something();\n" "\n" "protected:\n" " type_signal_something m_signal_something;\n" "};\n" "\n" "Server::type_signal_something Server::signal_something()\n" "{\n" " return m_signal_something;\n" "}\n" "" msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:9452 msgid "You can then connect to the signal using the same syntax used when connecting to gtkmm signals. For instance," msgstr "" #. (itstool) path: appendix/programlisting #: C/index-in.docbook:9456 #, no-wrap msgid "" "server.signal_something().connect(\n" " sigc::mem_fun(client, &Client::on_server_something) );\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9463 msgid "This is a full working example that defines and uses custom signals." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9467 msgid "Source Code" msgstr "" #. (itstool) path: appendix/title #: C/index-in.docbook:9475 msgid "Comparison with other signalling systems" msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:9477 msgid "(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.)" msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:9491 msgid "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." msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:9497 msgid "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." msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:9505 msgid "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." msgstr "" #. (itstool) path: appendix/title #: C/index-in.docbook:9516 msgid "gtkmm and Win32" msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:9517 msgid "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." msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:9522 msgid "gtkmm currently works with the MinGW/GCC compiler with a compiler version that supports C++17, such as gcc 7 or 8. It also works with Microsoft Visual C++ 2017 15.7.x or later (including the freely available express/community editions) on the Windows platform. There is an installer available for gtkmm on Microsoft Windows, but as of this writing (October 2020) it has not been updated for a long time. Please be aware that although normally it is fine to mix builds done with Visual Studio 2017 and 2019, please do not do so when building gtkmm with its -mm dependencies." msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:9535 msgid "Refer to the README.win32, as well as the README files in the gtkmm, pangomm and glibmm for instructions on how to build gtkmm on Windows." msgstr "" #. (itstool) path: appendix/title #: C/index-in.docbook:9542 msgid "Working with gtkmm's Source Code" msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:9543 msgid "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. However, you should not install a development version over your stable version. Instead, you should install it alongside your existing gtkmm installation, in a separate path." msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:9550 msgid "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 the source repository (git). For up-to-date information on jhbuild, please refer to the jhbuild manual." msgstr "" #. (itstool) path: note/para #: C/index-in.docbook:9560 msgid "Note that to build gtkmm from git, you'll often need to build many of its dependencies from git as well. jhbuild makes this easier than it would normally be, but it will take quite a while to build and install them all. You will probably encounter build problems, though these will usually be corrected quickly if you report them." msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:9568 msgid "gnome-build-meta is an alternative to jhbuild. It is described at the Building system components wiki page, but here we concentrate on jhbuild." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9575 msgid "Setting up jhbuild" msgstr "" #. (itstool) path: para/screen #: C/index-in.docbook:9584 #, no-wrap msgid "" "$ cp examples/sample.jhbuildrc ~/.config/jhbuildrc" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9577 msgid "To set up jhbuild, follow the basic installation instructions from the jhbuild manual. After you have installed jhbuild, you should copy the sample jhbuild configuration file into your home directory by executing the following command from the jhbuild directory: <_:screen-1/>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9586 msgid "The gtkmm module is defined in the gnome-suites-core-deps-latest.modules moduleset. So edit your jhbuildrc file and set your moduleset setting like so:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9591 #, no-wrap msgid "" "moduleset = 'gnome-suites-core-deps-latest'" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9592 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9598 #, no-wrap msgid "" "modules = [ 'gtkmm' ]" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9599 msgid "You can build several modules by setting the modules variable to a meta-package, e.g. meta-gnome-core, or listing more than one module name. The modules variable specifies which modules 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)." msgstr "" #. (itstool) path: important/title #: C/index-in.docbook:9609 msgid "Setting a prefix" msgstr "" #. (itstool) path: important/para #: C/index-in.docbook:9610 msgid "By default, jhbuild's configuration is configured to install all software built with jhbuild under the ~/jhbuild/install 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!) If you've followed the jhbuild instructions then this prefix belongs to your user, so you don't need to run jhbuild as root." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9622 msgid "You should also set buildroot in jhbuildrc. jhbuild builds gtkmm and many of its dependencies with Meson. Meson does not allow building in the source tree. jhbuild's default action is to build in a build directory directly below the source root directory. Some modules have a build directory with files used when building with Autotools. Those files can be destroyed if you let jhbuild build in that directory." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9632 msgid "When you downloaded jhbuild from the git repository, you got a number of .modules files, specifying dependencies between modules. By default jhbuild does not use the downloaded versions of these files, but reads the latest versions in the git repository. This is usually what you want. If you don't want it, use the use_local_modulesets variable in jhbuildrc." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9643 msgid "Installing and Using the git version of gtkmm" msgstr "" #. (itstool) path: para/screen #: C/index-in.docbook:9652 #, no-wrap msgid "" "$ jhbuild bootstrap\n" "$ jhbuild sanitycheck" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9645 msgid "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: <_:screen-1/>" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9656 msgid "Installing gtkmm with jhbuild" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9658 msgid "If everything worked correctly, you should be able to build gtkmm and all of its dependencies from git by executing jhbuild build (or, if you didn't specify gtkmm in the modules variable, with the command jhbuild build gtkmm)." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9665 msgid "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 that 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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9676 msgid "Using the git version of gtkmm" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9678 msgid "After you've installed the git 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 or meson.build 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9692 msgid "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." msgstr "" #. (itstool) path: appendix/title #: C/index-in.docbook:9709 msgid "Wrapping C Libraries with gmmproc" msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:9711 msgid "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." msgstr "" #. (itstool) path: appendix/para #: C/index-in.docbook:9716 msgid "This involves a variety of tools, some of them crufty, but at least they work, and has been used successfully by several projects." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9721 msgid "The build structure" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9723 msgid "Generation of the source code for a gtkmm-style wrapper API requires use of tools such as gmmproc and generate_wrap_init.pl, which are included in glibmm. In theory you could write your own build files to use these appropriately, but a much better option is to make use of the build infrastructure provided by the mm-common module. To get started, it helps a lot to pick an existing binding module as an example to look at." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9731 msgid "For instance, let's pretend that we are wrapping a C library called libsomething. It provides a GObject-based API with types named, for instance, SomeWidget and SomeStuff." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9737 msgid "Copying the skeleton project" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9739 msgid "Typically our wrapper library would be called libsomethingmm. We can start by copying the skeleton source tree from the mm-common module. Starting with mm-common 1.0.0 this skeleton application is built with the Meson build system." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9745 #, no-wrap msgid "" " $ git clone https://gitlab.gnome.org/GNOME/mm-common.git\n" " $ cp -a mm-common/skeletonmm libsomethingmm\n" "" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9753 msgid "libsomethingmm: The top-level directory." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9755 msgid "libsomething: Contains the main include file and the pkg-config .pc file." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9757 msgid "src: Contains .hg and .ccg source files." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9758 msgid "libsomethingmm: Contains hand-written .h and .cc files." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9748 msgid "This provides a directory structure for the source .hg and .ccg files and the hand-written .h and .cc files, with meson.build files that can specify the various files in use, in terms of Meson variables. The directory structure usually looks like this, after we have renamed the directories appropriately: <_:itemizedlist-1/>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9767 msgid "As well as renaming the directories, we should rename some of the source files. For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9769 #, no-wrap msgid "" "$ for f in $(find libsomethingmm -depth -name '*skeleton*'); do \\\n" " d=\"${f%/*}\"; b=\"${f##*/}\"; mv \"$f\" \"$d/${b//skeleton/libsomething}\"; \\\n" " done\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9773 msgid "A number of the skeleton files must still be filled in with project-specific content later." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9775 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9778 msgid "Generated files are saved in the build tree, which is separated from the source tree when meson and ninja are used." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9783 msgid "Modifying build files" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9785 msgid "Now we edit the files to adapt them to our needs. You might prefer to use a multiple-file search-replace utility for this, such as regexxer. Note that nearly all of the files provided with the skeleton source tree contain placeholder text. Thus, the substitutions should be performed globally, and not be limited to the Meson files." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9789 msgid "All mentions of skeleton should be replaced by the correct name of the C library you are wrapping, such as \"something\" or \"libsomething\". In the same manner, all instances of SKELETON should be replaced by \"SOMETHING\" or \"LIBSOMETHING\", and all occurrences of Skeleton changed to \"Something\"." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9793 msgid "Likewise, replace all instances of Joe Hacker by the name of the intended copyright holder, which is probably you. Do the same for the joe@example.com email address." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9798 msgid "meson.build in the top-level directory" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9802 msgid "It is common for binding modules to track the version number of the library they are wrapping. So, for instance, if the C library is at version 1.23.4, then the initial version of the binding module would be 1.23.0. However, avoid starting with an even minor version number as that usually indicates a stable release." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9807 msgid "In the project() function, change the license and the C++ version, if necessary." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9809 msgid "You probably need to add more required modules than glibmm and skeleton (libsomething)." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9817 msgid "Other meson.build files" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9821 msgid "skeleton/meson.build: Perhaps not much to change here more than the global name substitutions." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9824 msgid "skeleton/skeletonmm/meson.build" msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:9827 msgid "defs_basefiles" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9828 msgid "If we have more .defs and docs.xml files, we add them here." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:9832 msgid "hg_ccg_basenames" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9833 msgid "We must mention all of our .hg and .ccg files here." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:9837 msgid "extra_cc_files, extra_h_files" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9838 msgid "Any additional hand-written .h and .cc source files go here." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9819 msgid "Next we must adapt the other meson.build files: <_:itemizedlist-1/>" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9848 msgid "Creating .hg and .ccg files" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9850 msgid "We should now create our first .hg and .ccg files, to wrap one of the objects in the C library. One pair of example source files already exists: skeleton.ccg and skeleton.hg. Create copies of these files as necessary." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9854 msgid "In the .hg and .ccg files section you can learn about the syntax used in these files." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9861 msgid "Generating the .defs files." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9866 msgid "objects (GObjects, widgets, interfaces, boxed-types and plain structs)" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9867 msgid "functions" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9868 msgid "enums" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9869 msgid "signals" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9870 msgid "properties" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9871 msgid "vfuncs" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9863 msgid "The .defs files are text files, in a lisp format, that describe the API of a C library, including its <_:itemizedlist-1/>" msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:9880 msgid "gtk.defs" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9881 msgid "Includes the other files." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:9884 msgid "gtk_methods.defs" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9885 msgid "Objects and functions." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:9888 msgid "gtk_enums.defs" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9889 msgid "Enumerations." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:9892 msgid "gtk_signals.defs" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9893 msgid "Signals and properties." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:9896 msgid "gtk_vfuncs.defs" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:9897 msgid "vfuncs (function pointer member fields in structs), written by hand." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9874 msgid "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 the gtk/src directory of the gtkmm sources, you will find these files: <_:variablelist-1/>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9901 msgid "The skeletonmm/tools/generate_defs_and_docs.sh script generates all .defs files and the *_docs.xml file, described in the Documentation section." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9907 msgid "Generating the methods .defs" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9909 msgid "This .defs file describes objects and their functions. It is generated by the h2def.py script which you can find in glibmm's tools/defs_gen directory. For instance," msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9913 #, no-wrap msgid "" "$ ./h2def.py /usr/include/gtk-4.0/gtk/*.h > gtk_methods.defs\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9918 msgid "Generating the enums .defs" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9920 msgid "This .defs file describes enum types and their possible values. It is generated by the enumextract.py script which you can also find in glibmm's tools/defs_gen directory. For instance," msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9924 #, no-wrap msgid "" "$ ./enumextract.py /usr/include/gtk-4.0/gtk/*.h > gtk_enums.defs\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9929 msgid "Generating the signals and properties .defs" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9931 msgid "This .defs file describes signals and properties. It is generated by the special generate_extra_defs utility that is in every wrapping project, such as gtkmm/tools/extra_defs_gen/. For instance" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9936 #, no-wrap msgid "" "$ cd tools/extra_defs_gen\n" "$ ./generate_extra_defs > gtk_signals.defs\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9939 msgid "You must edit the source code of your own generate_extra_defs tool in order to generate the .defs for the GObject C types that you wish to wrap. In the skeleton source tree, the source file is named tools/extra_defs_gen/generate_defs_skeleton.cc. If not done so already, the file should be renamed, with the basename of your new binding substituted for the skeleton placeholder. The tools/extra_defs_gen/meson.build file should also mention the new source filename." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9946 msgid "Then edit the .cc file to specify the correct types. For instance, your main() function might look like this:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9949 #, no-wrap msgid "" "#include <glibmm_generate_extra_defs/generate_extra_defs.h>\n" "#include <libsomething.h>\n" "#include <iostream>\n" "\n" "int main(int, char**)\n" "{\n" " something_init();\n" "\n" " std::cout << get_defs(SOME_TYPE_WIDGET)\n" " << get_defs(SOME_TYPE_STUFF);\n" " return 0;\n" "}\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9965 msgid "Writing the vfuncs .defs" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9967 msgid "This .defs file describes virtual functions (vfuncs). It must be written by hand. There is the skeleton file skeleton/src/skeleton_vfunc.defs to start from. You can also look at gtkmm's gtk/src/gtk_vfuncs.defs file." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:9978 msgid "The .hg and .ccg files" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9979 msgid "The .hg and .ccg source files are very much like .h and .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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:9987 msgid "A .hg file will typically include some headers and then declare a class, using some macros to add API or behavior to this class. For instance, gtkmm's button.hg looks roughly like this:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:9992 #, no-wrap msgid "" "#include <gtkmm/widget.h>\n" "#include <gtkmm/actionable.h>\n" "_DEFS(gtkmm,gtk)\n" "_PINCLUDE(gtkmm/private/widget_p.h)\n" "\n" "namespace Gtk\n" "{\n" "\n" "class Button\n" " : public Widget,\n" " public Actionable\n" "{\n" " _CLASS_GTKOBJECT(Button, GtkButton, GTK_BUTTON, Gtk::Widget, GtkWidget)\n" " _IMPLEMENTS_INTERFACE(Actionable)\n" "public:\n" "\n" " _CTOR_DEFAULT\n" " explicit Button(const Glib::ustring& label, bool mnemonic = false);\n" "\n" " _WRAP_METHOD(void set_label(const Glib::ustring& label), gtk_button_set_label)\n" "\n" " ...\n" "\n" " _WRAP_SIGNAL(void clicked(), \"clicked\")\n" "\n" " ...\n" "\n" " _WRAP_PROPERTY(\"label\", Glib::ustring)\n" "};\n" "\n" "} // namespace Gtk\n" "" msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10027 msgid "_DEFS()" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10028 msgid "Specifies the destination directory for generated sources, and the name of the main .defs file that gmmproc should parse." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10031 msgid "_PINCLUDE()" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10032 msgid "Tells gmmproc to include a header in the generated private/button_p.h file." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10035 msgid "_CLASS_GTKOBJECT()" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10036 msgid "Tells gmmproc to add some typedefs, constructors, and standard methods to this class, as appropriate when wrapping a widget." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10039 msgid "_IMPLEMENTS_INTERFACE()" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10040 msgid "Tells gmmproc to add initialization code for the interface." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10043 msgid "_CTOR_DEFAULT" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10044 msgid "Adds a default constructor." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10047 msgid "_WRAP_METHOD(), _WRAP_SIGNAL(), and _WRAP_PROPERTY()" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10050 msgid "Add methods to wrap parts of the C API." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10024 msgid "The macros in this example do the following: <_:variablelist-1/>" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10054 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10058 #, no-wrap msgid "" "$ cd gtk/src\n" "$ /usr/lib/glibmm-2.68/proc/gmmproc -I ../../tools/m4 --defs . button . ./../gtkmm\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10061 msgid "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 source directory, and the destination directory." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10064 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10069 msgid "The macros are explained in more detail in the following sections." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10072 msgid "m4 Conversions" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10074 msgid "The macros that you use in the .hg and .ccg files often need to know how to convert a C++ type to a C type, or vice-versa. gmmproc takes this information from an .m4 file in your tools/m4/ or codegen/m4/ directory. This allows it to call a C function in the implementation of your C++ method, passing the appropriate parameters to that C function. For instance, this tells gmmproc how to convert a GtkTreeView pointer to a Gtk::TreeView pointer:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10082 #, no-wrap msgid "" "_CONVERSION(`GtkTreeView*',`TreeView*',`Glib::wrap($3)')\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10085 msgid "$3 will be replaced by the parameter name when this conversion is used by gmmproc." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10089 msgid "Some extra macros make this easier and consistent. Look in gtkmm's .m4 files for examples. For instance:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10093 #, no-wrap msgid "" "_CONVERSION(`PrintSettings&',`GtkPrintSettings*',__FR2P)\n" "_CONVERSION(`const PrintSettings&',`GtkPrintSettings*',__FCR2P)\n" "_CONVERSION(`const Glib::RefPtr<Printer>&',`GtkPrinter*',__CONVERT_REFPTR_TO_P($3))\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10100 msgid "m4 Initializations" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10102 msgid "Often when wrapping methods, it is desirable to store the return of the C function in what is called an output parameter. In this case, the C++ method returns void but an output parameter in which to store the value of the C function is included in the argument list of the C++ method. gmmproc allows such functionality, but appropriate initialization macros must be included to tell gmmproc how to initialize the C++ parameter from the return of the C function." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10111 msgid "For example, if there was a C function that returned a GtkWidget* and for some reason, instead of having the C++ method also return the widget, it was desirable to have the C++ method place the widget in a specified output parameter, an initialization macro such as the following would be necessary:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10118 #, no-wrap msgid "" "_INITIALIZATION(`Gtk::Widget&',`GtkWidget*',`$3 = Glib::wrap($4)')\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10121 msgid "$3 will be replaced by the output parameter name of the C++ method and $4 will be replaced by the return of the C function when this initialization is used by gmmproc. For convenience, $1 will also be replaced by the C++ type without the ampersand (&) and $2 will be replaced by the C type." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10131 msgid "Class macros" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10133 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10138 msgid "Other macros, such as _WRAP_METHOD() and _WRAP_SIGNAL() may only be used after a call to a _CLASS_* macro." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10143 msgid "_CLASS_GOBJECT" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10145 msgid "This macro declares a wrapper for a type that is derived from GObject, but whose wrapper is not derived from Gtk::Object." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10148 msgid "_CLASS_GOBJECT( C++ class, C class, C casting macro, C++ base class, C base class )" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10149 msgid "For instance, from adjustment.hg:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10150 #, no-wrap msgid "" "_CLASS_GOBJECT(Adjustment, GtkAdjustment, GTK_ADJUSTMENT, Glib::Object, GObject)\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10155 msgid "_CLASS_GTKOBJECT" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10157 msgid "This macro declares a wrapper for a type whose wrapper is derived from Gtk::Object, such as a widget or dialog." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10159 msgid "_CLASS_GTKOBJECT( C++ class, C class, C casting macro, C++ base class, C base class )" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10160 #: C/index-in.docbook:10650 #: C/index-in.docbook:10754 msgid "For instance, from button.hg:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10161 #, no-wrap msgid "" "_CLASS_GTKOBJECT(Button, GtkButton, GTK_BUTTON, Gtk::Widget, GtkWidget)\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10163 msgid "You will typically use this macro when the class already derives from Gtk::Object. For instance, you will use it when wrapping a GTK Widget, because Gtk::Widget derives from Gtk::Object." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10167 msgid "You might also derive non-widget classes from Gtk::Object so they can be used without Glib::RefPtr. For instance, they could then be instantiated with Gtk::make_managed() or on the stack as a member variable. This is convenient, but you should use this only when you are sure that true reference-counting is not needed. We consider it useful for widgets." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10177 msgid "_CLASS_BOXEDTYPE" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10179 msgid "This macro declares a wrapper for a non-GObject struct, registered with g_boxed_type_register_static()." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10182 msgid "_CLASS_BOXEDTYPE( C++ class, C class, new function, copy function, free function )" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10183 msgid "For instance, from Gdk::RGBA:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10184 #, no-wrap msgid "" "_CLASS_BOXEDTYPE(RGBA, GdkRGBA, NONE, gdk_rgba_copy, gdk_rgba_free)\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10189 msgid "_CLASS_BOXEDTYPE_STATIC" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10191 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10195 msgid "_CLASS_BOXEDTYPE_STATIC( C++ class, C class )" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10196 msgid "For instance, for Gdk::Rectangle:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10197 #, no-wrap msgid "" "_CLASS_BOXEDTYPE_STATIC(Rectangle, GdkRectangle)\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10202 msgid "_CLASS_OPAQUE_COPYABLE" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10204 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10207 msgid "_CLASS_OPAQUE_COPYABLE( C++ class, C class, new function, copy function, free function )" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10208 msgid "For instance, from Glib::VariantType:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10209 #, no-wrap msgid "" "_CLASS_OPAQUE_COPYABLE(VariantType, GVariantType, NONE, g_variant_type_copy, g_variant_type_free)\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10214 msgid "_CLASS_OPAQUE_REFCOUNTED" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10216 msgid "This macro declares a wrapper for a reference-counted opaque struct. The C++ wrapper cannot be directly instantiated and can only be used with Glib::RefPtr." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10219 msgid "_CLASS_OPAQUE_REFCOUNTED( C++ class, C class, new function, ref function, unref function )" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10220 msgid "For instance, for Gtk::CssSection:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10221 #, no-wrap msgid "" "_CLASS_OPAQUE_REFCOUNTED(CssSection, GtkCssSection, NONE, gtk_css_section_ref, gtk_css_section_unref)\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10226 msgid "_CLASS_GENERIC" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10228 msgid "This macro can be used to wrap structs which don't fit into any specialized category." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10230 msgid "_CLASS_GENERIC( C++ class, C class )" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10231 msgid "For instance, for Gdk::TimeCoord:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10232 #, no-wrap msgid "" "_CLASS_GENERIC(TimeCoord, GdkTimeCoord)\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10237 msgid "_CLASS_INTERFACE" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10239 msgid "This macro declares a wrapper for a type that is derived from GTypeInterface." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10242 msgid "_CLASS_INTERFACE( C++ class, C class, C casting macro, C interface struct, Base C++ class (optional), Base C class (optional) )" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10243 msgid "For instance, from celleditable.hg:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10245 #, no-wrap msgid "" "_CLASS_INTERFACE(CellEditable, GtkCellEditable, GTK_CELL_EDITABLE, GtkCellEditableIface)\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10247 msgid "Two extra optional parameters were once added, for the case that the interface derives from another interface, which was believed to be the case when the GInterface has another GInterface as a prerequisite. This is a misunderstanding, though. When GInterface A has GInterface B as a prerequisite, it means that every class that implements A shall also implement B. For instance, from loadableicon.hg in glibmm-2.4:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10253 #, no-wrap msgid "" "_CLASS_INTERFACE(LoadableIcon, GLoadableIcon, G_LOADABLE_ICON, GLoadableIconIface, Icon, GIcon)\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10260 msgid "Constructor macros" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10262 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10272 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10277 #, no-wrap msgid "" "class TextMark : public Glib::Object\n" "{\n" " _CLASS_GOBJECT(TextMark, GtkTextMark, GTK_TEXT_MARK, Glib::Object, GObject)\n" "\n" "protected:\n" " _WRAP_CTOR(TextMark(const Glib::ustring& name, bool left_gravity = true), gtk_text_mark_new)\n" "\n" "public:\n" " _WRAP_CREATE(const Glib::ustring& name, bool left_gravity = true)\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10289 msgid "_CTOR_DEFAULT" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10291 msgid "This macro creates a default constructor with no arguments." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10296 msgid "_WRAP_CTOR" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10298 msgid "This macro creates a constructor with arguments, equivalent to a *_new() C function. It won't actually call the *_new() function, but will simply create an equivalent constructor with the same argument types. It takes a C++ constructor signature, and a C function name." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10308 #: C/index-in.docbook:10819 msgid "errthrow" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10310 msgid "This tells gmmproc that the C *_new() has a final GError** parameter which should be ignored." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10305 msgid "It also takes an optional extra argument: <_:variablelist-1/>" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10319 msgid "Hand-coding constructors" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10321 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10329 #, no-wrap msgid "" "Button::Button(const Glib::ustring& label, bool mnemonic)\n" ":\n" " _CONSTRUCT(\"label\", label.c_str(), \"use_underline\", gboolean(mnemonic))\n" "{}\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10339 msgid "Macros that suppress generation of some code" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10341 msgid "Some macros suppress the generation of some code when they are used after a _CLASS_* macro. Some suppress the definition in the generated .cc file, others suppress both the declaration in the .h file and the definition in the .cc file." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10348 msgid "_CUSTOM_DEFAULT_CTOR" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10350 msgid "Suppresses declaration and definition of default constructor in _CLASS_BOXEDTYPE, _CLASS_BOXEDTYPE_STATIC and _CLASS_OPAQUE_COPYABLE." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10357 msgid "_CUSTOM_CTOR_CAST" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10359 msgid "Suppresses declaration and definition of the constructor that takes a pointer to the wrapped C object in _CLASS_BOXEDTYPE and _CLASS_BOXEDTYPE_STATIC." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10363 msgid "Suppresses definition of the constructor that takes a pointer to the wrapped C object in _CLASS_INTERFACE and _CLASS_OPAQUE_COPYABLE." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10367 msgid "Suppresses definition of the constructor that takes a pointer to the wrapped C object and the constructor that takes construct_params in _CLASS_GOBJECT and _CLASS_GTKOBJECT." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10374 msgid "_CUSTOM_DTOR" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10376 msgid "Suppresses definition of destructor in _CLASS_GOBJECT and _CLASS_GTKOBJECT." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10382 msgid "_CUSTOM_MOVE_OPERATIONS" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10384 msgid "Suppresses declaration and definition of move constructor and move assignment operator in _CLASS_GOBJECT and _CLASS_GTKOBJECT." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10388 msgid "For example:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10389 #, no-wrap msgid "" "class Derived : public Glib::Object\n" "{\n" " _CLASS_GOBJECT(Derived, GDerived, G_DERIVED, Glib::Object, GObject)\n" "\n" " _CUSTOM_MOVE_OPERATIONS\n" "\n" "public:\n" " Derived(Derived&& src) noexcept;\n" " Derived& operator=(Derived&& src) noexcept;\n" " // ...\n" "};\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10404 msgid "_CUSTOM_WRAP_NEW" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10406 msgid "Suppresses definition of Glib::wrap_new() function in _CLASS_GOBJECT." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10412 msgid "_CUSTOM_WRAP_FUNCTION" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10414 msgid "Suppresses definition of Glib::wrap() function in _CLASS_GOBJECT and _CLASS_GTKOBJECT." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10420 msgid "_NO_WRAP_FUNCTION" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10422 msgid "Suppresses declaration and definition of Glib::wrap() function in _CLASS_GOBJECT, _CLASS_BOXEDTYPE, _CLASS_BOXEDTYPE_STATIC, _CLASS_OPAQUE_COPYABLE, _CLASS_INTERFACE and _CLASS_GTKOBJECT." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10432 msgid "Method macros" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10435 msgid "_WRAP_METHOD" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10437 msgid "This macro generates the C++ method to wrap a C function." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10438 msgid "_WRAP_METHOD( C++ method signature, C function name)" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10439 msgid "For instance, from entry.hg:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10440 #, no-wrap msgid "" "_WRAP_METHOD(void set_text(const Glib::ustring& text), gtk_entry_set_text)\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10442 msgid "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." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10451 #: C/index-in.docbook:10686 #: C/index-in.docbook:10794 msgid "refreturn" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10453 msgid "Do an extra reference() on the return value, in case the C function does not provide a reference." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10458 #: C/index-in.docbook:10588 msgid "errthrow [\"<exceptions>\"]" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10460 msgid "Use the last GError** parameter of the C function to throw an exception. The optional \"<exceptions>\" is a comma-separated list of exceptions that can be thrown. It determines which @throws Doxygen commands are added to the documentation. Default value is Glib::Error. If you want a comma in the description of an exception, precede it by a backslash. Example: errthrow \"Glib::OptionError Hello\\, world, Glib::ConvertError\"" msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10471 #: C/index-in.docbook:10694 #: C/index-in.docbook:10760 #: C/index-in.docbook:10996 msgid "deprecated [\"<text>\"]" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10473 #: C/index-in.docbook:10696 #: C/index-in.docbook:10762 #: C/index-in.docbook:10998 msgid "Puts the generated code in #ifdef blocks. Text about the deprecation can be specified as an optional parameter." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10479 msgid "ignore_deprecations" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10481 msgid "Puts the generated code in the .cc file in a G_GNUC_BEGIN_IGNORE_DEPRECATIONS / G_GNUC_END_IGNORE_DEPRECATIONS block. (Only in glibmm >= 2.70.1)" msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10487 msgid "constversion" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10489 msgid "Just call the non-const version of the same function, instead of generating almost duplicate code." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10494 #: C/index-in.docbook:10601 #: C/index-in.docbook:10701 #: C/index-in.docbook:10767 #: C/index-in.docbook:11003 msgid "newin \"<version>\"" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10496 #: C/index-in.docbook:10603 #: C/index-in.docbook:10703 #: C/index-in.docbook:10769 #: C/index-in.docbook:11005 msgid "Adds a @newin Doxygen command to the documentation, or replaces the @newin command generated from the C documentation." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10501 #: C/index-in.docbook:10708 #: C/index-in.docbook:10841 #: C/index-in.docbook:10928 msgid "ifdef <identifier>" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10503 #: C/index-in.docbook:10710 #: C/index-in.docbook:10843 #: C/index-in.docbook:10930 msgid "Puts the generated code in #ifdef blocks." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10507 #: C/index-in.docbook:10847 msgid "slot_name <parameter_name>" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10509 #: C/index-in.docbook:10849 msgid "Specifies the name of the slot parameter of the method, if it has one. This enables gmmproc to generate code to copy the slot and pass the copy on to the C function in its final gpointer user_data parameter. The slot_callback option must also be used to specify the name of the glue callback function to also pass on to the C function." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10519 #: C/index-in.docbook:10859 msgid "slot_callback <function_name>" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10521 #: C/index-in.docbook:10861 msgid "Used in conjunction with the slot_name option to specify the name of the glue callback function that handles extracting the slot and then calling it. The address of this callback is also passed on to the C function that the method wraps." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10529 #: C/index-in.docbook:10869 msgid "no_slot_copy" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10531 #: C/index-in.docbook:10871 msgid "Tells gmmproc not to pass a copy of the slot to the C function, if the method has one. Instead the slot itself is passed. The slot parameter name and the glue callback function must have been specified with the slot_name and slot_callback options respectively." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10448 #: C/index-in.docbook:10585 #: C/index-in.docbook:10656 #: C/index-in.docbook:10757 #: C/index-in.docbook:10791 #: C/index-in.docbook:10945 msgid "There are some optional extra arguments: <_:variablelist-1/>" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10544 msgid "Objects used via RefPtr: Pass the RefPtr as a const reference. For instance, const Glib::RefPtr<Gtk::FileFilter>& filter." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10548 msgid "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::FileFilter>& filter." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10553 msgid "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 a std::vector type. For instance, std::vector<Glib::RefPtr<Gdk::Pixbuf>>. You may need to define a Traits type to specify how the C and C++ types should be converted." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10561 msgid "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:" msgstr "" #. (itstool) path: listitem/programlisting #: C/index-in.docbook:10569 #, no-wrap msgid "" "#m4 _CONVERSION(`GSList*',`std::vector<Widget*>',`Glib::SListHandler<Widget*>::slist_to_vector($3, Glib::OWNERSHIP_SHALLOW)')" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10540 msgid "Selecting which C++ types should be used is also important when wrapping C API. Though it's usually obvious what C++ types should be used in the C++ method, here are some hints: <_:itemizedlist-1/>" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10575 msgid "_WRAP_METHOD_DOCS_ONLY" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10577 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10581 msgid "_WRAP_METHOD_DOCS_ONLY(C function name)" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10582 msgid "For instance, from recentinfo.hg:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10583 #, no-wrap msgid "" "_WRAP_METHOD_DOCS_ONLY(gtk_recent_info_get_applications)\n" "" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10590 msgid "Excludes documentation of the last GError** parameter of the C function. The optional \"<exceptions>\" is a comma-separated list of exceptions that can be thrown. It determines which @throws Doxygen commands are added to the documentation. Default value is Glib::Error. If you want a comma in the description of an exception, precede it by a backslash. Example: errthrow \"Glib::OptionError Hello\\, world, Glib::ConvertError\"" msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10608 msgid "voidreturn" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10610 msgid "Don't include a @return Doxygen command in the documentation. Useful if the wrapped C function returns a value, but the corresponding C++ method returns void." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10620 msgid "_IGNORE, _IGNORE_SIGNAL, _IGNORE_PROPERTY" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10622 msgid "gmmproc will warn you on stdout about functions, signals, properties and child properties that you have forgotten to wrap, helping to ensure that you are wrapping the complete API. But if you don't want to wrap some functions, signals, properties or child properties, or if you chose to hand-code some methods then you can use the _IGNORE(), _IGNORE_SIGNAL() or _IGNORE_PROPERTY() macro to make gmmproc stop complaining." msgstr "" #. (itstool) path: para/literallayout #: C/index-in.docbook:10630 #, no-wrap msgid "" "_IGNORE(C function name 1, C function name 2, etc)\n" "_IGNORE_SIGNAL(C signal name 1, C signal name 2, etc)\n" "_IGNORE_PROPERTY(C property name 1, C property name 2, etc)" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10634 msgid "For instance, from flowbox.hg:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10635 #, no-wrap msgid "" "_IGNORE(gtk_flow_box_set_filter_func, gtk_flow_box_set_sort_func)\n" "_IGNORE_SIGNAL(activate-cursor-child, toggle-cursor-child, move-cursor)\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10641 msgid "_WRAP_SIGNAL" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10643 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10649 msgid "_WRAP_SIGNAL( C++ signal handler signature, C signal name)" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10651 #, no-wrap msgid "" "_WRAP_SIGNAL(void clicked(),\"clicked\")\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10653 msgid "Signals usually have function pointers in the GTK struct, with a corresponding enum value and a g_signal_new() in the .c file." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10659 msgid "no_default_handler" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10661 msgid "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, and when adding a signal without a public C default handler." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10670 msgid "custom_default_handler" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10672 msgid "Generate a declaration of the on_something() virtual method in the .h file, but do not generate a definition in the .cc file. Use this when you must generate the definition by hand." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10679 msgid "custom_c_callback" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10681 msgid "Do not generate a C callback function for the signal. Use this when you must generate the callback function by hand." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10688 msgid "Do an extra reference() on the return value of the on_something() virtual method, in case the C function does not provide a reference." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10714 #: C/index-in.docbook:10895 msgid "exception_handler <method_name>" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10716 #: C/index-in.docbook:10897 msgid "Allows to use custom exception handler instead of default one. Exception might be rethrown by user-defined handler, and it will be caught by default handler." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10722 msgid "detail_name <parameter_name>" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10724 msgid "Adds a const Glib::ustring& parameter to the signal_something() method. Use it, if the signal accepts a detailed signal name, i.e. if the underlying C code registers the signal with the G_SIGNAL_DETAILED flag." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10731 msgid "two_signal_methods" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10733 msgid "Used in conjunction with the detail_name option to generate two signal_something() methods, one without a parameter and one with a parameter without a default value. With only the detail_name option one method is generated, with a parameter with default value. Use the two_signal_methods option, if it's necessary in order to preserve ABI." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10747 msgid "_WRAP_PROPERTY" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10749 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10753 msgid "_WRAP_PROPERTY(C property name, C++ type)" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10755 #, no-wrap msgid "" "_WRAP_PROPERTY(\"label\", Glib::ustring)\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10778 msgid "_WRAP_VFUNC" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10780 msgid "This macro generates the C++ method to wrap a virtual C function." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10781 msgid "_WRAP_VFUNC( C++ method signature, C function name)" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10782 msgid "For instance, from widget.hg:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10783 #, no-wrap msgid "" "_WRAP_VFUNC(SizeRequestMode get_request_mode() const, get_request_mode)\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10785 msgid "The C function (e.g. get_request_mode) is described more fully in the *_vfuncs.defs file, and the convert*.m4 files contain the necessary conversion from the C++ parameter type to the C parameter type. Conversions can also be written in the .hg file. Virtual functions often require special conversions that are best kept local to the .hg file where they are used." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10796 msgid "Do an extra reference() on the return value of the something_vfunc() function, in case the virtual C function does not provide a reference." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10802 msgid "refreturn_ctype" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10804 msgid "Do an extra reference() on the return value of an overridden something_vfunc() function in the C callback function, in case the calling C function expects it to provide a reference." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10811 msgid "keep_return" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10813 msgid "Keep a copy of the return value in the C callback function, in case the calling C function does not expect to get its own reference." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10821 msgid "Use the last GError** parameter of the C virtual function (if there is one) to throw an exception." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10826 msgid "custom_vfunc" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10828 msgid "Do not generate a definition of the vfunc in the .cc file. Use this when you must generate the vfunc by hand." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10834 msgid "custom_vfunc_callback" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10836 msgid "Do not generate a C callback function for the vfunc. Use this when you must generate the callback function by hand." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10879 msgid "return_value <value>" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10881 msgid "Defines a non-default return value." msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10885 msgid "err_return_value <value>" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10887 msgid "Defines a non-default return value, used only if the C++ something_vfunc() function throws an exception which is propagated to the C callback function. If return_value is specified, but err_return_value is not, then return_value is used also when an exception is propagated." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10904 msgid "A rule to which there may be exceptions: If the virtual C function returns a pointer to an object derived from GObject, i.e. a reference-counted object, then the virtual C++ function shall return a Glib::RefPtr<> object. One of the extra arguments refreturn or refreturn_ctype is required." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10915 msgid "Other macros" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10918 msgid "_IMPLEMENTS_INTERFACE" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10920 msgid "This macro generates initialization code for the interface." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10921 msgid "_IMPLEMENTS_INTERFACE(C++ interface name)" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10922 msgid "For instance, from grid.hg:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10923 #, no-wrap msgid "" "_IMPLEMENTS_INTERFACE(Orientable)\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10925 msgid "There is one optional extra argument: <_:variablelist-1/>" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:10938 msgid "_WRAP_ENUM" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10940 msgid "This macro generates a C++ enum to wrap a C enum. You must specify the desired C++ name and the name of the underlying C enum." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:10942 msgid "For instance, from enums.hg:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:10943 #, no-wrap msgid "" "_WRAP_ENUM(Orientation, GtkOrientation)\n" "" msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10948 msgid "NO_GTYPE" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10950 msgid "Use this option, if the enum is not a GType. This is the case when there is no *_get_type() function for the C enum, but be careful that you don't just need to include an extra header for that function. You should also file a bug against the C API, because all enums should be registered as GTypes." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10955 msgid "If you specify NO_GTYPE, don't use that enum as the type in _WRAP_PROPERTY. It would cause a runtime error, when the generated property_*() method is called." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10958 msgid "For example, from icontheme.hg:" msgstr "" #. (itstool) path: listitem/programlisting #: C/index-in.docbook:10959 #, no-wrap msgid "" "_WRAP_ENUM(IconLookupFlags, GtkIconLookupFlags, NO_GTYPE)\n" " " msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10964 msgid "gtype_func <function_name>" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10966 msgid "Specifies the name of the *_get_type() function for the C enum. Use this parameter if gmmproc can't deduce the correct function name from the name of the C enum type." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10969 msgid "For example, from dbusproxy.hg in glibmm:" msgstr "" #. (itstool) path: listitem/programlisting #: C/index-in.docbook:10970 #, no-wrap msgid "" "_WRAP_ENUM(ProxyFlags, GDBusProxyFlags, gtype_func g_dbus_proxy_flags_get_type)\n" " " msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10975 msgid "CONV_TO_INT" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10977 msgid "\"Convertible to int.\" Generates a plain enum (not an enum class) within a class. Such an enum is scoped like an enum class, but unlike an enum class, it can be implicitly converted to int." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10980 msgid "For example, from dialog.hg:" msgstr "" #. (itstool) path: listitem/programlisting #: C/index-in.docbook:10981 #, no-wrap msgid "" "_WRAP_ENUM(ResponseType, GtkResponseType, CONV_TO_INT)\n" " " msgstr "" #. (itstool) path: varlistentry/term #: C/index-in.docbook:10986 msgid "s#<from>#<to>#" msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10988 msgid "Substitutes (part of) the name of one or more enum constants. You can add any number of substitutions." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:10990 msgid "For example, from iochannel.hg in glibmm:" msgstr "" #. (itstool) path: listitem/programlisting #: C/index-in.docbook:10991 #, no-wrap msgid "" "_WRAP_ENUM(SeekType, GSeekType, NO_GTYPE, s#^SEEK_#SEEK_TYPE_#)\n" " " msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11014 msgid "_WRAP_ENUM_DOCS_ONLY" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11016 msgid "This macro just generates a Doxygen documentation block for the enum. This is useful for enums that can't be wrapped with _WRAP_ENUM() because they are complexly defined (maybe using C macros) but including the generated enum documentation is still desired. It is used with the same syntax as _WRAP_ENUM() and also processes the same options (though NO_GTYPE, gtype_func <function_name> and CONV_TO_INT are ignored because they make no difference when just generating the enum's documentation)." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11028 msgid "_WRAP_GERROR" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11030 msgid "This macro generates a C++ exception class, derived from Glib::Error, with a Code enum and a code() method. You must specify the desired C++ name, the name of the corresponding C enum, and the prefix for the C enum values." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11033 msgid "This exception can then be thrown by methods which are generated from _WRAP_METHOD() with the errthrow option." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11035 msgid "For instance, from pixbuf.hg:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11036 #, no-wrap msgid "" "_WRAP_GERROR(PixbufError, GdkPixbufError, GDK_PIXBUF_ERROR)\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11038 msgid "_WRAP_GERROR() accepts the same optional arguments as _WRAP_ENUM() (though CONV_TO_INT is ignored because all exception class enums are plain enums within a class)." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11044 msgid "_MEMBER_GET / _MEMBER_SET" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11045 msgid "Use these macros if you're wrapping a simple struct or boxed type that provides direct access to its data members, to create getters and setters for the data members." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11049 msgid "_MEMBER_GET(C++ name, C name, C++ type, C type)" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11050 msgid "_MEMBER_SET(C++ name, C name, C++ type, C type)" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11051 msgid "For example, in rectangle.hg:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11054 #, no-wrap msgid "" "_MEMBER_GET(x, x, int, int)" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11058 msgid "_MEMBER_GET_PTR / _MEMBER_SET_PTR" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11059 msgid "Use these macros to automatically provide getters and setters for a data member that is a pointer type. For the getter function, it will create two methods, one const and one non-const." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11064 msgid "_MEMBER_GET_PTR(C++ name, C name, C++ type, C type)" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11065 msgid "_MEMBER_SET_PTR(C++ name, C name, C++ type, C type)" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11066 msgid "For example, for Pango::Analysis in item.hg:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11068 #, no-wrap msgid "" "// _MEMBER_GET_PTR(engine_lang, lang_engine, EngineLang*, PangoEngineLang*)\n" "// It's just a comment. It's difficult to find a real-world example.\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11074 msgid "_MEMBER_GET_GOBJECT / _MEMBER_SET_GOBJECT" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11075 msgid "Use these macros to provide getters and setters for a data member that is a GObject type that must be referenced before being returned." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11080 msgid "_MEMBER_GET_GOBJECT(C++ name, C name, C++ type, C type)" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11081 msgid "_MEMBER_SET_GOBJECT(C++ name, C name, C++ type, C type)" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11082 msgid "For example, in Pangomm, layoutline.hg:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11083 #, no-wrap msgid "" "_MEMBER_GET_GOBJECT(layout, layout, Pango::Layout, PangoLayout*)\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11090 msgid "gmmproc Parameter Processing" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11091 msgid "gmmproc allows processing the parameters in a method signature for the macros that process method signatures (like _WRAP_METHOD(), _WRAP_CTOR() and _WRAP_CREATE()) in a variety of ways:" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11098 msgid "Parameter Reordering" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11100 msgid "For all the macros that process method signatures, it is possible to specify a different order for the C++ parameters than the existing order in the C function, virtual function or signal. For example, say that the following C function were being wrapped as a C++ method for the Gtk::Widget class:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11106 #, no-wrap msgid "" "void gtk_widget_set_device_events(GtkWidget* widget, GdkDevice* device,\n" " GdkEventMask events);\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11109 msgid "However, changing the order of the C++ method's two parameters is necessary. Something like the following would wrap the function as a C++ method with a different order for the two parameters:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11113 #, no-wrap msgid "" "_WRAP_METHOD(void set_device_events(Gdk::EventMask events{events},\n" " const Glib::RefPtr<const Gdk::Device>& device{device}),\n" " gtk_widget_set_device_events)\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11117 msgid "The {c_param_name} following the method parameter names tells gmmproc to map the C++ parameter to the specified C parameter within the {}. Since the C++ parameter names correspond to the C ones, the above could be re-written as:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11122 #, no-wrap msgid "" "_WRAP_METHOD(void set_device_events(Gdk::EventMask events{.},\n" " const Glib::RefPtr<const Gdk::Device>& device{.}),\n" " gtk_widget_set_device_events)\n" "" msgstr "" #. (itstool) path: warning/para #: C/index-in.docbook:11127 msgid "Please note that when reordering parameters for a _WRAP_SIGNAL() method signature, the C parameter names would always be p0, p1, etc. because the generate_extra_defs utility uses those parameter names no matter what the C API's parameter names may be. It's how the utility is written presently." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11139 msgid "Optional Parameter Processing" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11141 msgid "For all macros processing method signatures except _WRAP_SIGNAL() and _WRAP_VFUNC() it is also possible to make the parameters optional so that extra C++ methods are generated without the specified optional parameter. For example, say that the following *_new() function were being wrapped as a constructor in the Gtk::ToolButton class:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11149 #, no-wrap msgid "" "GtkToolItem* gtk_tool_button_new(GtkWidget* icon_widget, const gchar* label);\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11151 msgid "Also, say that the C API allowed NULL for the function's label parameter so that that parameter is optional. It would be possible to have gmmproc generate the original constructor (with all the parameters) along with an additional constructor without that optional parameter by appending a {?} to the parameter name like so:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11157 #, no-wrap msgid "" "_WRAP_CTOR(ToolButton(Widget& icon_widget, const Glib::ustring& label{?}),\n" " gtk_tool_button_new)\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11160 msgid "In this case, two constructors would be generated: One with the optional parameter and one without it." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11166 msgid "Output Parameter Processing" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11168 msgid "With _WRAP_METHOD() it is also possible for the return of the wrapped C function (if it has one) to be placed in an output parameter of the C++ method instead of having the C++ method also return a value like the C function does. To do that, simply include the output parameter in the C++ method parameter list appending a {OUT} to the output parameter name. For example, if gtk_widget_get_request_mode() is declared as the following:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11177 #, no-wrap msgid "" "GtkSizeRequestMode gtk_widget_get_request_mode(GtkWidget* widget);\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11179 msgid "And having the C++ method set an output parameter is desired instead of returning a SizeRequestMode, something like the following could be used:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11182 #, no-wrap msgid "" "_WRAP_METHOD(void get_request_mode(SizeRequestMode& mode{OUT}) const,\n" " gtk_widget_get_request_mode)\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11185 msgid "The {OUT} appended to the name of the mode output parameter tells gmmproc to place the return of the C function in that output parameter. In this case, however, a necessary initialization macro like the following would also have to be specified:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11190 #, no-wrap msgid "" "_INITIALIZATION(`SizeRequestMode&',`GtkSizeRequestMode',`$3 = (SizeRequestMode)($4)')\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11192 msgid "Which could also be written as:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11193 #, no-wrap msgid "" "_INITIALIZATION(`SizeRequestMode&',`GtkSizeRequestMode',`$3 = ($1)($4)')\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11195 msgid "_WRAP_METHOD() also supports setting C++ output parameters from C output parameters if the C function being wrapped has any. Suppose, for example, that we want to wrap the following C function that returns a value in its C output parameter out_mime_type:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11201 #, no-wrap msgid "" "GInputStream* gdk_clipboard_read_finish(GdkClipboard* clipboard,\n" " GAsyncResult* result, const char** out_mime_type, GError** error)\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11204 msgid "To have gmmproc place the value returned in the C++ out_mime_type output parameter, something like the following _WRAP_METHOD() macro could be used:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11208 #, no-wrap msgid "" "\n" "_WRAP_METHOD(Glib::RefPtr<Gio::InputStream> read_finish(\n" " const Glib::RefPtr<Gio::AsyncResult>& result,\n" " Glib::ustring& out_mime_type{>>}), gdk_clipboard_read_finish, errthrow)\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11213 msgid "The {>>} following the out_mime_type parameter name indicates that the C++ output parameter should be set from the value returned in the C parameter from the C function. gmmproc will generate a declaration of a temporary variable in which to store the value of the C output parameter and a statement that sets the C++ output parameter from the temporary variable. In this case it may be necessary to have an _INITIALIZATION() describing how to set a Glib::ustring& from a const char** such as the following:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11223 #, no-wrap msgid "" "\n" "_INITIALIZATION(`Glib::ustring&',`const char*',`$3 = Glib::convert_const_gchar_ptr_to_ustring($4)')\n" "" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11229 msgid "String Parameter Processing" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11231 msgid "A string-valued input parameter in a C++ method is usually a const Glib::ustring& or a const std::string&. In C code it's a const gchar*. When an empty string is converted to const gchar*, it can be converted either to nullptr or to a pointer to an empty string (with c_str()). Some parameters in some C functions accept a nullptr, and interpret it in a special way. Other parameters must not be nullptr." msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:11244 msgid "for mandatory parameters (with or without default values): empty string to empty string," msgstr "" #. (itstool) path: listitem/para #: C/index-in.docbook:11246 msgid "for optional parameters (with appended {?}): empty string to nullptr." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11240 msgid "The default conversion in _WRAP_METHOD() and similar macros is <_:itemizedlist-1/> If the default conversion is not the best conversion, append {NULL} to a mandatory parameter or {?!NULL} to an optional parameter (!NULL = not NULL). If you append both a C parameter name and NULL, separate them with a space: {c_param_name NULL}." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11260 msgid "Basic Types" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11261 msgid "Some of the basic types that are used in C APIs have better alternatives in C++. For example, there's no need for a gboolean type since C++ has bool. The following list shows some commonly-used types in C APIs and what you might convert them to in a C++ wrapper library." msgstr "" #. (itstool) path: segmentedlist/segtitle #: C/index-in.docbook:11268 msgid "C type" msgstr "" #. (itstool) path: segmentedlist/segtitle #: C/index-in.docbook:11269 msgid "C++ type" msgstr "" #. (itstool) path: seglistitem/seg #: C/index-in.docbook:11270 msgid "gboolean" msgstr "" #. (itstool) path: seglistitem/seg #: C/index-in.docbook:11270 msgid "bool" msgstr "" #. (itstool) path: seglistitem/seg #: C/index-in.docbook:11271 msgid "gint" msgstr "" #. (itstool) path: seglistitem/seg #: C/index-in.docbook:11271 msgid "int" msgstr "" #. (itstool) path: seglistitem/seg #: C/index-in.docbook:11272 #: C/index-in.docbook:11272 msgid "guint" msgstr "" #. (itstool) path: seglistitem/seg #: C/index-in.docbook:11273 msgid "gdouble" msgstr "" #. (itstool) path: seglistitem/seg #: C/index-in.docbook:11273 msgid "double" msgstr "" #. (itstool) path: seglistitem/seg #: C/index-in.docbook:11274 #: C/index-in.docbook:11274 msgid "gunichar" msgstr "" #. (itstool) path: seglistitem/seg #: C/index-in.docbook:11275 msgid "gchar*" msgstr "" #. (itstool) path: seglistitem/seg #: C/index-in.docbook:11275 msgid "Glib::ustring (or std::string for filenames)" msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11281 msgid "Hand-coded source files" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11283 msgid "You might want to include additional 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 meson.build in the extra_h_files and extra_cc_files variables." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11293 msgid "Initialization" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11295 msgid "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:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11303 #, no-wrap msgid "" "void init()\n" "{\n" " Gtk::init_gtkmm_internals(); //Sets up the g type system and the Glib::wrap() table.\n" " wrap_init(); //Tells the Glib::wrap() table about the libsomethingmm classes.\n" "}\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11309 msgid "The implementation 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 wrap_init() function appears in the correct C++ namespace." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11318 msgid "Problems in the C API." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11320 msgid "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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11322 msgid "Unable to predeclare structs" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11324 msgid "By convention, structs are declared in glib/GTK-style headers like so:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11325 #, no-wrap msgid "" "typedef struct _ExampleWidget ExampleWidget;\n" "\n" "struct _ExampleWidget\n" "{\n" " ...\n" "};\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11332 msgid "The extra typedef allows the struct to be used in a header without including its full definition, 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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11337 msgid "This compiler error might look like this:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11339 #, no-wrap msgid "" "example-widget.h:56: error: using typedef-name 'ExampleWidget' after 'struct'\n" "../../libexample/libexamplemm/example-widget.h:34: error: 'ExampleWidget' has a previous declaration here\n" "make[4]: *** [example-widget.lo] Error 1\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11343 msgid "or this:" msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11344 #, no-wrap msgid "" "example-widget.h:60: error: '_ExampleWidget ExampleWidget' redeclared as different kind of symbol\n" "../../libexample/libexamplemm/example-widget.h:34: error: previous declaration of 'typedef struct _ExampleWidget ExampleWidget'\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11347 msgid "This is easy to correct in the C library, so do send a patch to the relevant maintainer." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11351 msgid "Lack of properties" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11353 msgid "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," msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11359 #, no-wrap msgid "" "GtkWidget* example_widget_new(int something, const char* thing)\n" "{\n" " return g_object_new (EXAMPLE_TYPE_WIDGET, \"something\", something, \"thing\", thing, NULL);\n" "}\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11364 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11368 msgid "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." msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11373 msgid "Another workaround is to add a *_construct() function that the C++ constructor can call after instantiating its own type. For instance," msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11376 #, no-wrap msgid "" "GtkWidget* example_widget_new(int something, const char* thing)\n" "{\n" " ExampleWidget* widget;\n" " widget = g_object_new (EXAMPLE_TYPE_WIDGET, NULL);\n" " example_widget_construct(widget, \"something\", something, \"thing\", thing);\n" "}\n" "\n" "void example_widget_construct(ExampleWidget* widget, int something, const char* thing)\n" "{\n" " //Do stuff that uses private API:\n" " widget->priv->thing = thing;\n" " do_something(something);\n" "}\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11390 msgid "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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11398 msgid "Documentation" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11400 msgid "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." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11403 msgid "Reusing C documentation" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11405 msgid "You might wish to reuse documentation that exists for the C library that you are wrapping. GTK-style C libraries typically use gtk-doc or gi-docgen and therefore have source code comments formatted for gtk-doc or gi-docgen and some extra documentation in .sgml and .xml files. The docextract_to_xml.py script, from glibmm's tools/defs_gen 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." msgstr "" #. (itstool) path: section/programlisting #: C/index-in.docbook:11415 #, no-wrap msgid "" "./docextract_to_xml.py -s ~/checkout/gnome/gtk/gtk/ > gtk_docs.xml\n" "" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11417 msgid "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. Alternatively you can write your own documentation in the .hg file." msgstr "" #. (itstool) path: section/title #: C/index-in.docbook:11427 msgid "Documentation build structure" msgstr "" #. (itstool) path: section/para #: C/index-in.docbook:11429 msgid "If you copied the skeleton source tree in mm-common and substituted the placeholder text, then you will already have suitable meson.build and Doxyfile.in files in the doc/reference/ directory. You probably need to modify the tag_file_modules variable in meson.build, though. With the mm-common build setup, the list of Doxygen input files is not defined in the Doxygen configuration file, but passed along from meson/ninja to the standard input of doxygen." msgstr ""