Наши партнеры

Библиотека сайта rus-linux.net

Программирование с использованием gtkmm 3. Меню и панели инструментов

Оригинал: Programming with gtkmm 3
Авторы: Murray Cumming, Bernhard Rieder, Jonathon Jongsma, Ole Laursen, Marko Anastasov, Daniel Elstner, Chris Vine, David King, Pedro Ferreira, Kjell Ahlstedt
Дата публикации: 15 Октября 2013 г.
Перевод: А.Панин
Дата перевода: 15 марта 2014 г.

Хотя и существуют специальные API для создания меню и панелей инструментов, вам в большинстве случаев придется работать с ними одновременно, используя менеджер пользовательского интерфейса (UIManager) для описания действий (Actions), которые впоследствии вы сможете связывать с меню и панелями инструментов. Таким образом вы сможете обрабатывать события активации действия вместо обработки событий активации элементов меню и панели инструментов по отдельности. Также вы сможете включать и отключать элементы меню и панели инструментов одновременно с помощью действия.

Работа с рассматриваемыми элементами пользовательского интерфейса предусматривает необходимость использования классов Gtk::ActionGroup, Gtk::Action и Gtk::UIManager, экземпляры которых должны создаваться с помощью методов create(), возвращающих умные указатели RefPtr.

12.1. Действия (Actions)

В первую очередь следует создать действия (на основе класса Gtk::Action) и добавить их в группу действий (представленную классом Gtk::ActionGroup) с помощью метода Gtk::ActionGroup::add().

Аргументы метода Gtk::Action::create() позволяют задать имя действия, а также способ его отображения в меню и на панелях инструментов. Следует использовать стандартные элементы там, где это возможно для того, чтобы избавится от необходимости задания текста названия, акселератора, иконки и текста всплывающей подсказки, а также для использования существующих стандартных переводов.

Вы можете установить обработчик сигналов при вызове метода ActionGroup::add(). Этот обработчик сигналов будет функционировать в моменты активации действия с помощью элемента меню или кнопки на панели инструментов.

Учтите, что вам придется задавать действия для элементов подменю наряду с действиями для элементов меню.

Пример реализации описанных действий представлен ниже:

m_refActionGroup = Gtk::ActionGroup::create();

m_refActionGroup->add( Gtk::Action::create("MenuFile", "_Файл") );
m_refActionGroup->add( Gtk::Action::create("New", Gtk::Stock::NEW),
  sigc::mem_fun(*this, &ExampleWindow::on_action_file_new) );
m_refActionGroup->add( Gtk::Action::create("ExportData", "Экспортировать данные"),
  sigc::mem_fun(*this, &ExampleWindow::on_action_file_open) );
m_refActionGroup->add( Gtk::Action::create("Quit", Gtk::Stock::QUIT),
  sigc::mem_fun(*this, &ExampleWindow::on_action_file_quit) );

Следует помнить о том, что заданные нами имена действий из данного кода будут видимы пользователям в меню и на панелях инструментов. Следовательно, в рамках данного кода вы должны задействовать механизм перевода строк, поместив строки в макрос _(). Конечно же, в тех случаях, когда мы используем стандартные элементы Gtk::Stock, перевод будет доступен автоматически.

12.2. Менеджер пользовательского интерфейса (UIManager)

На следующем этапе вам придется создать объект менеджера пользовательского интерфейса (на основе класса Gtk::UIManager) и добавить созданную группу действий (на основе класса Gtk::ActionGroup) в этот менеджер с помощью метода insert_action_group(). На этом этапе также полезно сообщить родительскому окну о необходимости генерации событий в ответ на активацию определенных клавиатурных сочетаний с помощью метода add_accel_group().

Пример реализации описанных действий представлен ниже:

Glib::RefPtr<Gtk::UIManager> m_refUIManager =
    Gtk::UIManager::create();
m_refUIManager->insert_action_group(m_refActionGroup);
add_accel_group(m_refUIManager->get_accel_group());

После этого вы можете непосредственно описать расположение элементов меню и панелей инструментов, а затем добавить описание элементов пользовательского интерфейса в менеджер пользовательского интерфейса. Для этого "строкового описания пользовательского интерфейса" используется формат XML, причем вы должны использовать имена уже созданных вами действий. Например, это может быть сделано следующим образом:

Glib::ustring ui_info =
    "<ui>"
    "  <menubar name='MenuBar'>"
    "    <menu action='MenuFile'>"
    "      <menuitem action='New'/>"
    "      <menuitem action='Open'/>"
    "      <separator/>"
    "      <menuitem action='Quit'/>"
    "    </menu>"
    "    <menu action='MenuEdit'>"
    "      <menuitem action='Cut'/>"
    "      <menuitem action='Copy'/>"
    "      <menuitem action='Paste'/>"
    "    </menu>"
    "  </menubar>"
    "  <toolbar  name='ToolBar'>"
    "    <toolitem action='Open'/>"
    "    <toolitem action='Quit'/>"
    "  </toolbar>"
    "</ui>";

m_refUIManager->add_ui_from_string(ui_info);

Помните о том, что все эти имена являются всего лишь идентификаторами, которые мы использовали при создании действий. Они не представляют текст, который пользователь увидит в меню и на панелях инструментов. Мы передавали эти читаемые пользователем имена в процессе создания действий.

Для создания экземпляров классов Gtk::MenuBar или Gtk::ToolBar, которые будут представлять на самом деле видимые виджеты, вы должны использовать метод Gtk::UIManager::get_widget(), после чего добавлять полученный виджет в контейнер. Например, это может быть сделано следующим образом:

Gtk::Widget* pMenubar = m_refUIManager->get_widget("/MenuBar");
pBox->add(*pMenuBar, Gtk::PACK_SHRINK);

12.3. Всплывающие меню (Popup Menu)

В обычных условиях меню просто добавляются в окно, но они также могут временно показываться в результате нажатия на кнопку мыши. К примеру, контекстное меню может быть показано в момент, когда пользователь нажимает правую кнопку мыши.

Строка размещения элементов меню для менеджера пользовательского интерфейса должна включать элемент "popup". Например, эта строка может выглядеть следующим образом:

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

m_refUIManager->add_ui_from_string(ui_info);

Для показа всплывающего меню следует использовать метод popup() объекта на основе класса Gtk::Menu, передавая идентификатор кнопки и время активации, предоставляемые обработчиком сигнала "button_press_event", который вам придется обрабатывать в любом случае. Пример обработчика:

bool ExampleWindow::on_button_press_event(GdkEventButton* event)
{
  if( (event->type == GDK_BUTTON_PRESS) &&
      (event->button == 3) )
  {
    m_Menu_Popup->popup(event->button, event->time);
    return true; //Обработка произведена.
  }
  else
    return false;
}

12.4. Примеры

12.4.1. Пример создания главного меню

Рисунок 12-1: Главное меню

Исходный код

Файл: examplewindow.h (Для использования совместно с gtkmm 3, а не с gtkmm 2)

Файл: examplewindow.cc (Для использования совместно с gtkmm 3, а не с gtkmm 2)

#include "examplewindow.h"
#include <gtkmm/stock.h>
#include <iostream7gt;

ExampleWindow::ExampleWindow()
: m_Box(Gtk::ORIENTATION_VERTICAL)
{
  set_title("Пример создания главного меню");
  set_default_size(200, 200);

add(m_Box); // размещение виджета меню MenuBar на вершине контейнера, при этом все остальные виджеты будут расположены ниже.

//Создание действий для меню и панелей инструментов:
  Glib::RefPtr<Gio::SimpleActionGroup> refActionGroup =
    Gio::SimpleActionGroup::create();

//Файл|Подменю "Создать":
  refActionGroup->add_action("newstandard",
    sigc::mem_fun(*this, &ExampleWindow::on_menu_file_new_generic));

refActionGroup->add_action("newfoo",
    sigc::mem_fun(*this, &ExampleWindow::on_menu_file_new_generic));

refActionGroup->add_action("newgoo",
    sigc::mem_fun(*this, &ExampleWindow::on_menu_file_new_generic));

//Меню "Файл":
  refActionGroup->add_action("quit",
    sigc::mem_fun(*this, &ExampleWindow::on_menu_file_quit));

//Меню "Правка":
  refActionGroup->add_action("copy",
    sigc::mem_fun(*this, &ExampleWindow::on_menu_others));
  refActionGroup->add_action("paste",
    sigc::mem_fun(*this, &ExampleWindow::on_menu_others));
  refActionGroup->add_action("something",
    sigc::mem_fun(*this, &ExampleWindow::on_menu_others));

//Меню с выбором вариантов для демонстрации элементов с радио-кнопками,
  //создаваемое с использованием специальных методов для работы со строковыми и числовыми выбираемыми значениями:
  m_refChoice = refActionGroup->add_action_radio_string("choice",
    sigc::mem_fun(*this, &ExampleWindow::on_menu_choices),
    "a");

m_refChoiceOther = refActionGroup->add_action_radio_integer("choiceother",
    sigc::mem_fun(*this, &ExampleWindow::on_menu_choices_other),
    1);

m_refToggle = refActionGroup->add_action_bool("sometoggle",
    sigc::mem_fun(*this, &ExampleWindow::on_menu_toggle),
    false);

//Меню "Помощь":
  refActionGroup->add_action("about",
    sigc::mem_fun(*this, &ExampleWindow::on_menu_others) );

insert_action_group("example", refActionGroup);

m_refBuilder = Gtk::Builder::create();

//TODO: add_accel_group(m_refBuilder->get_accel_group());

//Строковое описание пользовательского интерфейса для меню и панели инструментов:
  Glib::ustring ui_info =
    "<interface>"
    "  <menu id='menu-example'>"
    "    <submenu>"
    "      <attribute name='label' translatable='yes'>_Файл</attribute>"
    "      <section>"
    "        <item>"
    "          <attribute name='label' translatable='yes'>Создать _стандартный</attribute>"
    "          <attribute name='action'>example.newstandard</attribute>"
    "          <attribute name='accel'><Primary>n</attribute>"
    "        </item>"
    "        <item>"
    "          <attribute name='label' translatable='yes'>Создать _Foo</attribute>"
    "          <attribute name='action'>example.newfoo</attribute>"
    "        </item>"
    "        <item>"
    "          <attribute name='label' translatable='yes'>Создать _Goo</attribute>"
    "          <attribute name='action'>example.newgoo</attribute>"
    "        </item>"
    "      </section>"
    "      <section>"
    "        <item>"
    "          <attribute name='label' translatable='yes'>_Выход</attribute>"
    "          <attribute name='action'>example.quit</attribute>"
    "          <attribute name='accel'><Primary>q</attribute>"
    "        </item>"
    "      </section>"
    "    </submenu>"
    "    <submenu>"
    "      <attribute name='label' translatable='yes'>_Правка</attribute>"
    "      <section>"
    "        <item>"
    "          <attribute name='label' translatable='yes'>_Копировать</attribute>"
    "          <attribute name='action'>example.copy</attribute>"
    "          <attribute name='accel'><Primary>c</attribute>"
    "        </item>"
    "        <item>"
    "          <attribute name='label' translatable='yes'>_Вставить</attribute>"
    "          <attribute name='action'>example.paste</attribute>"
    "          <attribute name='accel'><Primary>v</attribute>"
    "        </item>"
    "        <item>"
    "          <attribute name='label' translatable='yes'>_Дополнительно</attribute>"
    "          <attribute name='action'>example.something</attribute>"
    "        </item>"
    "      </section>"
    "    </submenu>"
    "    <submenu>"
    "      <attribute name='label' translatable='yes'>_Варианты выбора</attribute>"
    "      <section>"
    "        <item>"
    "          <attribute name='label' translatable='yes'>Вариант _A</attribute>"
    "          <attribute name='action'>example.choice</attribute>"
    "          <attribute name='target'>a</attribute>"
    "        </item>"
    "        <item>"
    "          <attribute name='label' translatable='yes'>Вариант _B</attribute>"
    "          <attribute name='action'>example.choice</attribute>"
    "          <attribute name='target'>b</attribute>"
    "        </item>"
    "      </section>"
    "    </submenu>"
    "    <submenu>"
    "      <attribute name='label' translatable='yes'>_Другие варианты</attribute>"
    "      <section>"
    "        <item>"
    "          <attribute name='label' translatable='yes'>Вариант 1</attribute>"
    "          <attribute name='action'>example.choiceother</attribute>"
    "          <attribute name='target' type='i'>1</attribute>"
    "        </item>"
    "        <item>"
    "          <attribute name='label' translatable='yes'>Вариант 2</attribute>"
    "          <attribute name='action'>example.choiceother</attribute>"
    "          <attribute name='target' type='i'>2</attribute>"
    "        </item>"
    "      </section>"
    "      <section>"
    "        <item>"
    "          <attribute name='label' translatable='yes'>Дополнительный переключатель</attribute>"
    "          <attribute name='action'>example.sometoggle</attribute>"
    "        </item>"
    "      </section>"
    "    </submenu>"
    "    <submenu>"
    "      <attribute name='label' translatable='yes'>_Справка</attribute>"
    "      <section>"
    "        <item>"
    "          <attribute name='label' translatable='yes'>_О программе</attribute>"
    "          <attribute name='action'>example.about</attribute>"
    "        </item>"
    "      </section>"
    "    </submenu>"
    "  </menu>"
    "</interface>";

try
  {
    m_refBuilder->add_from_string(ui_info);
  }
  catch(const Glib::Error& ex)
  {
    std::cerr << "не удалось создать меню: " <<  ex.what();
  }

//Получение виджета меню и добавление его в контейнерный виджет:
  Glib::RefPtr<Glib::Object> object =
    m_refBuilder->get_object("menu-example");
  Glib::RefPtr<Gio::Menu> gmenu =
    Glib::RefPtr<Gio::Menu>::cast_dynamic(object);
  if(!gmenu)
    std::cerr << "Экземпляр класса Gtk::GMenu не найден." << std::endl;

//Меню:
  //Если мы просто создадим экземпляр класса Gtk::MenuBar на основе Gio::Menu
  //и упакуем его в окно, например, с промежуточной упаковкой в контейнер, представленный
  //классом Gtk::Box, акселераторы не будут работать.
  //Они работают только тогда, когда мы используем экземпляр класса Gtk::ApplicationWindow
  //совместно с методом Gtk::Application::set_menubar(). (или set_app_menu).
  //  Gtk::MenuBar* pMenubar = Gtk::manage(new Gtk::MenuBar(gmenu));
  Glib::RefPtr<Gtk::Application> app = get_application();
  if(!app)
    std::cerr << "Объект приложения не найден." << std::endl;
  else
    app->set_menubar(gmenu);

//Создание панели инструментов и добавление ее в контейнерный виджет:
  Gtk::Toolbar* toolbar = Gtk::manage(new Gtk::Toolbar());
  Gtk::ToolButton* button = Gtk::manage(new Gtk::ToolButton());
  button->set_icon_name("document-new");
  //Мы не сможем этого сделать, если не нарушим ABI класса Gtk::ToolButton: button->set_detailed_action_name("example.new");
  gtk_actionable_set_detailed_action_name (GTK_ACTIONABLE (button->gobj()), "example.newstandard");
  toolbar->add(*button);

button = Gtk::manage(new Gtk::ToolButton());
  button->set_icon_name("application-exit");
  //Мы не сможем сделать этого, если не нарушим ABI класса Gtk::ToolButton: button->set_detailed_action_name("example.quit");
  gtk_actionable_set_detailed_action_name (GTK_ACTIONABLE (button->gobj()), "example.quit");
  toolbar->add(*button);

m_Box.pack_start(*toolbar, Gtk::PACK_SHRINK);

show_all_children();
}

ExampleWindow::~ExampleWindow()
{
}

void ExampleWindow::on_menu_file_quit()
{
  hide(); //Закрывает главное окно и прерывает работу функции app->run().
}

void ExampleWindow::on_menu_file_new_generic()
{
   std::cout << "Элемент меню Файл|Создать был выбран." << std::endl;
}

void ExampleWindow::on_menu_others()
{
  std::cout << "Элемент меню был выбран." << std::endl;
}

void ExampleWindow::on_menu_choices(const Glib::ustring& parameter)
{
  //Состояние радио-кнопки, связанной с действием, не меняется автоматически:
  m_refChoice->change_state(parameter);
  
  Glib::ustring message;
  if(parameter == "a")
    message = "Был выбран вариант a.";
  else
    message = "Был выбран вариант b.";

std::cout << message << std::endl;
}

void ExampleWindow::on_menu_choices_other(int parameter)
{
  //Состояние радио-кнопки, связанной с действием, не меняется автоматически:
  m_refChoice->change_state(parameter);

Glib::ustring message;
  if(parameter == 1)
    message = "Был выбран вариант 1.";
  else
    message = "Был выбран вариант 2.";

std::cout << message << std::endl;
}

void ExampleWindow::on_menu_toggle()
{
  bool active = false;
  m_refToggle->get_state(active);

//Состояние переключателя, связанного с действием, не меняется автоматически:
  m_refToggle->change_state(!active);
  active = !active;

Glib::ustring message;
  if(active)
    message = "Переключатель активен.";
  else
    message = "Переключатель не активен.";

std::cout << message << std::endl;
}

Файл: main.cc (Для использования совместно с gtkmm 3, а не с gtkmm 2)

12.4.2. Пример создания всплывающего меню

Рисунок 12-2: Всплывающее меню

Исходный код

Файл: examplewindow.h (Для использования совместно с gtkmm 3, а не с gtkmm 2)

Файл: examplewindow.cc (Для использования совместно с gtkmm 3, а не с gtkmm 2)

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

ExampleWindow::ExampleWindow()
: m_Box(Gtk::ORIENTATION_VERTICAL),
  m_Label("Используйте правую кнопку мыши для показа всплывающего меню."),
  m_pMenuPopup(0)
  /* m_Image(Gtk::Stock::DIALOG_QUESTION, Gtk::ICON_SIZE_MENU) */
{
  set_title("Пример создания всплывающего меню");
  set_default_size(200, 200);

add(m_Box);

//Добавление области захвата событий для возможности захвата события нажатия кнопки мыши:
  m_Box.pack_start(m_EventBox);
  m_EventBox.signal_button_press_event().connect(sigc::mem_fun(*this,
              &ExampleWindow::on_button_press_event) );

m_EventBox.add(m_Label);

//Создание действий:

//Заполнение меню:

Glib::RefPtr<Gio::SimpleActionGroup> refActionGroup =
    Gio::SimpleActionGroup::create();

//Файл|Подменю "Создать":
  //Эти действия меню уже должны существовать для функционирования главного меню,
  //так как контекстное меню не должно содержать элементы, которые доступны только через
  //это контекстное меню.

refActionGroup->add_action("edit",
    sigc::mem_fun(*this, &ExampleWindow::on_menu_file_popup_generic));

refActionGroup->add_action("process", //TODO: Как использовать "<control>P" в качестве акселератора. 
    sigc::mem_fun(*this, &ExampleWindow::on_menu_file_popup_generic));

refActionGroup->add_action("remove",
    sigc::mem_fun(*this, &ExampleWindow::on_menu_file_popup_generic));

insert_action_group("examplepopup", refActionGroup);

m_refBuilder = Gtk::Builder::create();

//Строковое описание пользовательского интерфейса для меню и панели инструментов:
  Glib::ustring ui_info =
    "<interface>"
    "  <menu id='menu-examplepopup'>"
    "    <section>"
    "      <item>"
    "        <attribute name='label' translatable='yes'>Редактировать</attribute>"
    "        <attribute name='action'>examplepopup.edit</attribute>"
    "      </item>"
    "      <item>"
    "        <attribute name='label' translatable='yes'>Обработать</attribute>"
    "        <attribute name='action'>examplepopup.process</attribute>"
    "      </item>"
    "      <item>"
    "        <attribute name='label' translatable='yes'>Удалить</attribute>"
    "        <attribute name='action'>examplepopup.remove</attribute>"
    "      </item>"
    "    </section>"
    "  </menu>"
    "</interface>";

try
  {
    m_refBuilder->add_from_string(ui_info);
  }
  catch(const Glib::Error& ex)
  {
    std::cerr << "Не удалось создать меню: " <<  ex.what();
  }

//Получение виджета меню:
  Glib::RefPtr<Glib::Object> object =
    m_refBuilder->get_object("menu-examplepopup");
  Glib::RefPtr<Gio::Menu> gmenu =
    Glib::RefPtr<Gio::Menu>::cast_dynamic(object);
  if(!gmenu)
    g_warning("Экземпляр класса Gtk::GMenu не найден");

m_pMenuPopup = new Gtk::Menu(gmenu);

show_all_children();
}

ExampleWindow::~ExampleWindow()
{
}

void ExampleWindow::on_menu_file_popup_generic()
{
   std::cout << "Элемент всплывающего меню был выбран." << std::endl;
}

bool ExampleWindow::on_button_press_event(GdkEventButton* event)
{
  if( (event->type == GDK_BUTTON_PRESS) && (event->button == 3) )
  {
    if(!m_pMenuPopup->get_attach_widget())
    {
      m_pMenuPopup->attach_to_widget(*this);
    }

if(m_pMenuPopup)
      m_pMenuPopup->popup(event->button, event->time);

return true; //Произошла обработка события.
  }
  else
    return false;
}

Файл: main.cc (Для использования совместно с gtkmm 3, а не с gtkmm 2)

Следующий раздел : 13. Палитра инструментов (ToolPalette).