<page xmlns="http://projectmallard.org/1.0/" xmlns:its="http://www.w3.org/2005/11/its" xmlns:xi="http://www.w3.org/2001/XInclude" type="guide" style="task" id="menubar.py" xml:lang="cs">

  <info>

  <title type="text">MenuBar (Python)</title>

  <link type="guide" xref="beginner.py#menu-combo-toolbar"/>

  <link type="seealso" xref="gmenu.py"/>

    <link type="next" xref="colorbutton.py"/>

    <revision version="0.1" date="2012-08-01" status="stub"/>

    <credit type="author copyright">

      <name>Tiffany Antopolski</name>

      <email its:translate="no">tiffany.antopolski@gmail.com</email>

      <years>2012</years>

    </credit>

    <credit type="author copyright">

      <name>Marta Maria Casetti</name>

      <email its:translate="no">mmcasetti@gmail.com</email>

      <years>2012</years>

    </credit>

    <desc>Widget, který sdružuje widgety GtkMenuItem.</desc>

  </info>

  <title>MenuBar vytvořený pomocí XML a GtkBuilder</title>

  <media type="image" mime="image/png" src="media/menubar.png"/>

  
MenuBar vytvořený pomocí XML a GtkBuilder.

  <links type="section"/>

  <section id="xml"> <title>Vytvoření MenuBar pomocí XML</title>

   
Abyste vytvořili nabídkovou lištu pomocí XML:

   <steps>

     <item>
Pomocí svého oblíbeného textového editoru vytvořte <file>menubar.ui</file>.
</item>

     <item>
Na začátek souboru vložte následující řádek:

<?xml version="1.0"? encoding="UTF-8"?>

     </item>

    <item>
Chceme vytvořit rozhraní, které bude obsahovat naši nabídkovou lištu a její podnabídky. Naše nabídková lišta bude obsahovat podnabídky <gui>Soubor</gui>, <gui>Upravit</gui>, <gui>Volby</gui> a <gui>Nápověda</gui>. Do souboru přidáme následující kód XML:

    <?xml version="1.0" encoding="UTF-8"?>

<interface>

  <menu id="menubar">

    <submenu>

      <attribute name="label">File</attribute>

    </submenu>

    <submenu>

      <attribute name="label">Edit</attribute>

    </submenu>

    <submenu>

      <attribute name="label">Choices</attribute>

    </submenu>

    <submenu>

      <attribute name="label">Help</attribute>

    </submenu>

  </menu>

</interface>

     </item>

     <item>
Nyní vytvoříme soubor .py a použijeme GtkBuilder k naimportování souboru <file>menubar.ui</file>, který jsme před chvílí vytvořili.
</item>

   </steps>

   </section>

   <section id="basis"> <title>Přidání MenuBar do okna pomocí GtkBuilder</title>

from gi.repository import Gtk

import sys

class MyWindow(Gtk.ApplicationWindow):

    def __init__(self, app):

        Gtk.Window.__init__(self, title="MenuBar Example", application=app)

        self.set_default_size(200, 200)

class MyApplication(Gtk.Application):

    def __init__(self):

        Gtk.Application.__init__(self)

    def do_activate(self):

        win = MyWindow(self)

        win.show_all()

    def do_startup(self):

        Gtk.Application.do_startup(self)

        # Builder pro přidání uživatelského rozhraní navrženého v Glade do mřížky

        builder = Gtk.Builder()

        # Získá soubor (pokud existuje)

        try:

            builder.add_from_file("menubar_basis.ui")

        except:

            print("file not found")

            sys.exit()

        # Použije metodu Gtk.Application.set_menubar(nabídková_lišta) pro přídání

        # nabídkové lišty do aplikace (Upozornění: NE do okna!)

        self.set_menubar(builder.get_object("menubar"))

app = MyApplication()

exit_status = app.run(sys.argv)

sys.exit(exit_status)

Nyní aplikaci napsanou v jazyce Python spusťte. Měla by vypadat podobně, jako na obrázku na začátku této stránky.

</section>

<section id="xml2"> <title>Přidání položek do nabídky</title>

Začneme přidáním dvou položek nabídky do nabídky <gui>File</gui>: <gui>New</gui> a <gui>Quit</gui>. Provedeme to přidáním oddílu s těmito položkami do podnabídky File. Soubor <file>menubar.ui</file> by měl vypadat jako tento (řádky 6 až 13 včetně obsahují nově přidaný oddíl):

   <listing>

      <title>menubar.ui</title>

<?xml version="1.0" encoding="UTF-8"?>

<interface>

  <menu id="menubar">

    <submenu>

      <attribute name="label">File</attribute>

      <section>

        <item>

          <attribute name="label">New</attribute>

        </item>

        <item>

          <attribute name ="label">Quit</attribute>

        </item>

      </section>

    </submenu>

    <submenu>

      <attribute name="label">Edit</attribute>

    </submenu>

    <submenu>

      <attribute name="label">Choices</attribute>

    </submenu>

    <submenu>

      <attribute name="label">Help</attribute>

    </submenu>

  </menu>

</interface>

</listing>

  
Podle tohoto vzoru nyní můžete přidat položky <gui>Copy</gui> a <gui>Paste</gui> do podnabídky <gui>Edit</gui> a položku <gui>About</gui> do podnabídky <gui>Help</gui>.

  </section>

  <section id="actions">

    <title>Nastavení akcí</title>

    
Nyní vytvoříme akce pro „New“ a „Quit“ napojené na funkce zpětného volání v souboru .py. Například „new“ vytvoříme jako:

new_action = Gio.SimpleAction.new("new", None)

new_action.connect("activate", self.new_callback)

    
A vytvoříme funkci zpětného volání pro „new“ jako

def new_callback(self, action, parameter):

    print "You clicked \"New\""

    
Nyní v souboru XML napojíme položky nabídky na akce v souboru XML přidáním atributu „action“:

<item>

  <attribute name="label">New</attribute>

  <attribute name="action">app.new</attribute>

</item>

    
Všimněte si, že pro akce, které se vztahují k aplikaci, používáme předponu app. a pro akce, které se vztahují k oknu, používáme předponu win..

    
Nakonec v souboru <file>.py</file> přidáme akci do aplikace nebo do okna – například app.new bude přidáno do aplikace v metodě do_startup(self) jako

self.add_action(new_action)

    
Podrobnější vysvětlení signálů a zpětných volání viz <link xref="signals-callbacks.py"/>.
 

  </section>

  <section id="win-app"><title>Akce: Aplikace nebo okno?</title>

    
Výše jsme vytvořili akce "new" a "open" jako součást třídy MyApplication. Akce, které ovládají přímo aplikaci, jako je "quit" by se vytvořily podobně.

    
Některé akce, jako je "copy" (kopírovat) nebo "paste" (vložit) se vztahují k oknu a ne k aplikaci. Akce okna by měly být vytvářeny jako součást třídy okna.

    
Soubor s celým příkladem obsahuje jak akce aplikace, tak akce okna. Akce okna jsou obvykle zároveň i součástí <link xref="gmenu.py">aplikační nabídky</link>. Není dobrým zvykem vkládat akce okna do aplikační nabídky. Pro předváděcí účely zahrnuje soubor s celým příkladem, který následuje, kód XML v souboru <file>.ui</file>, který vytvoří aplikační nabídku včetně položek "New" a "Open" a ty jsou zavěšeny na stejnou akci, jako položky nabídkové lišty se stejným názvem.

  </section>

  <section id="choices">

    <title>Podnabídka „Choices“ a položky se stavem</title>

    <media type="image" mime="image/png" src="media/menubar_choices.png"/>

    
Řádky 30 až 80 včetně v <link xref="menubar.py#xml-code"/> ukazují kód XML použitý k vytvoření uživatelského rozhraní pro nabídku <gui>Choices</gui>.

    
Dosud vytvořené akce jsou bezstavové, tj. takové, které si nepamatují stave nebo nezávisí na stavu akce samotné. Akce, které potřebujeme vytvořit pro podnabídku <gui>Choices</gui> jsou na druhou stranu stavové. Příkladem vytvoření stavové akce je:

shape_action = Gio.SimpleAction.new_stateful("shape", GLib.VariantType.new('s'), GLib.Variant.new_string('line'))

    
kde proměnné v metodě jsou: název, typ parametru (v tomto případě řetězec, úplný seznam s významem znaků viz <link href="http://developer.gnome.org/glib/unstable/glib-GVariantType.html">zde</link>), počáteční stav (v tomto případě 'line', v případě pravdivostní hodnoty True by to mělo být Glib.Variant.new_boolean(True) apod.; úplný seznam viz <link href="http://developer.gnome.org/glib/unstable/glib-GVariant.html">zde</link>).

    
Po vytvoření stavové jednoduché akce ji napojíme na funkci zpětného volání a přidáme ji do okna (nebo do aplikace v některých případech), stejně jako dřív:

shape_action.connect("activate", self.shape_callback)

self.add_action(shape_action)

  </section>

  <section id="xml-code">

    <title>Celý soubor s uživatelským rozhraním ve formátu XML pro tento příklad</title>

    <?xml version="1.0" encoding="UTF-8"?>

<interface>

  <menu id="menubar">

    <submenu>

      <attribute name="label">File</attribute>

      <section>

        <item>

          <attribute name="label">New</attribute>

          <attribute name="action">app.new</attribute>

        </item>

        <item>

          <attribute name="label">Quit</attribute>

          <attribute name="action">app.quit</attribute>

        </item>

      </section>

    </submenu>

    <submenu>

      <attribute name="label">Edit</attribute>

      <section>

        <item>

          <attribute name="label">Copy</attribute>

          <attribute name="action">win.copy</attribute>

        </item>

        <item>

          <attribute name="label">Paste</attribute>

          <attribute name="action">win.paste</attribute>

        </item>

      </section>

    </submenu>

    <submenu>

      <attribute name="label">Choices</attribute>

      <submenu>

        <attribute name="label">Shapes</attribute>

          <section>

            <item>

              <attribute name="label">Line</attribute>

              <attribute name="action">win.shape</attribute>

              <attribute name="target">line</attribute>

            </item>

            <item>

              <attribute name="label">Triangle</attribute>

              <attribute name="action">win.shape</attribute>

              <attribute name="target">triangle</attribute>

            </item>

            <item>

              <attribute name="label">Square</attribute>

              <attribute name="action">win.shape</attribute>

              <attribute name="target">square</attribute>

            </item>

            <item>

              <attribute name="label">Polygon</attribute>

              <attribute name="action">win.shape</attribute>

              <attribute name="target">polygon</attribute>

            </item>

            <item>

              <attribute name="label">Circle</attribute>

              <attribute name="action">win.shape</attribute>

              <attribute name="target">circle</attribute>

            </item>

          </section>

      </submenu>

      <section>

        <item>

          <attribute name="label">On</attribute>

          <attribute name="action">app.state</attribute>

          <attribute name="target">on</attribute>

        </item>

        <item>

          <attribute name="label">Off</attribute>

          <attribute name="action">app.state</attribute>

          <attribute name="target">off</attribute>

        </item>

      </section>

      <section>

        <item>

          <attribute name="label">Awesome</attribute>

          <attribute name="action">app.awesome</attribute>

        </item>

      </section>

    </submenu>

    <submenu>

      <attribute name="label">Help</attribute>

      <section>

        <item>

          <attribute name="label">About</attribute>

          <attribute name="action">win.about</attribute>

        </item>

      </section>

    </submenu>

  </menu>

  <menu id="appmenu">

    <section>

      <item>

        <attribute name="label">New</attribute>

        <attribute name="action">app.new</attribute>

      </item>

      <item>

        <attribute name="label">Quit</attribute>

        <attribute name="action">app.quit</attribute>

      </item>

    </section>

  </menu>

</interface>

  </section>

  <section id="python-code">

    <title>Kompletní soubor v jazyce Python pro tento příklad</title>

    from gi.repository import Gtk

from gi.repository import GLib

from gi.repository import Gio

import sys

class MyWindow(Gtk.ApplicationWindow):

    def __init__(self, app):

        Gtk.Window.__init__(self, title="MenuBar Example", application=app)

        self.set_default_size(200, 200)

        # Vytvoří bezstavovou akci (název, typ parametru)

        copy_action = Gio.SimpleAction.new("copy", None)

        # Napojí ji na funkci zpětného volání

        copy_action.connect("activate", self.copy_callback)

        # Přidá ji do okna

        self.add_action(copy_action)

        # Vytvoří bezstavovou akci (název, typ parametru)

        paste_action = Gio.SimpleAction.new("paste", None)

        # Napojí ji na funkci zpětného volání

        paste_action.connect("activate", self.paste_callback)

        # Přidá ji do okna

        self.add_action(paste_action)

        # Vytvoří stavovou akci (název, typ_parametru, počáteční_stav)

        shape_action = Gio.SimpleAction.new_stateful(

            "shape", GLib.VariantType.new('s'), GLib.Variant.new_string('line'))

        # Napojí ji na funkci zpětného volání

        shape_action.connect("activate", self.shape_callback)

        # Přidá ji do okna

        self.add_action(shape_action)

        # Vytvoří stavovou akci

        about_action = Gio.SimpleAction.new("about", None)

        # Napojí ji na funkci zpětného volání

        about_action.connect("activate", self.about_callback)

        # Přidá ji do aplikace

        self.add_action(about_action)

    # Funkce zpětného volání pro copy_action

    def copy_callback(self, action, parameter):

        print("\"Copy\" activated")

    # Funkce zpětného volání pro paste_action

    def paste_callback(self, action, parameter):

        print("\"Paste\" activated")

    # Funkce zpětného volání pro shape_action

    def shape_callback(self, action, parameter):

        print("Shape is set to", parameter.get_string())

        # Note that we set the state of the action!

        action.set_state(parameter)

    # Funkce zpětného volání pro about (viz příklad AboutDialog)

    def about_callback(self, action, parameter):

        # Gtk.AboutDialog

        aboutdialog = Gtk.AboutDialog()

        # Seznam autorů kódu a dokumentace (bude použit později)

        authors = ["GNOME Documentation Team"]

        documenters = ["GNOME Documentation Team"]

        # Vyplní AboutDialog

        aboutdialog.set_program_name("MenuBar Example")

        aboutdialog.set_copyright(

            "Copyright \xc2\xa9 2012 GNOME Documentation Team")

        aboutdialog.set_authors(authors)

        aboutdialog.set_documenters(documenters)

        aboutdialog.set_website("http://developer.gnome.org")

        aboutdialog.set_website_label("GNOME Developer Website")

        # Napojí signál "response" na on_close, aby se zavřel 

        # AboutDialog, když je kliknuto na "close"

        aboutdialog.connect("response", self.on_close)

        # Zobrazí AboutDialog

        aboutdialog.show()

    # Funkce zpětného volání pro likvidaci AboutDialog

    def on_close(self, action, parameter):

        action.destroy()

class MyApplication(Gtk.Application):

    def __init__(self):

        Gtk.Application.__init__(self)

    def do_activate(self):

        win = MyWindow(self)

        win.show_all()

    def do_startup(self):

        # PRVNÍ, CO SE MUSÍ UDĚLAT: do_startup()

        Gtk.Application.do_startup(self)

        # Vytvoří bezstavovou akci

        new_action = Gio.SimpleAction.new("new", None)

        # Napojí ji na funkci zpětného volání

        new_action.connect("activate", self.new_callback)

        # Přidá ji do aplikace

        self.add_action(new_action)

        # Vytvoří bezstavovou akci

        quit_action = Gio.SimpleAction.new("quit", None)

        # Napojí ji na funkci zpětného volání

        quit_action.connect("activate", self.quit_callback)

        # Přidá ji do aplikace

        self.add_action(quit_action)

        # Vytvoří stavovou akci

        state_action = Gio.SimpleAction.new_stateful(

            "state",  GLib.VariantType.new('s'), GLib.Variant.new_string('off'))

        # Napojí ji na funkci zpětného volání

        state_action.connect("activate", self.state_callback)

        # Přidá ji do aplikace

        self.add_action(state_action)

        # Vytvoří stavovou akci

        awesome_action = Gio.SimpleAction.new_stateful(

            "awesome", None, GLib.Variant.new_boolean(False))

        # Napojí ji na funkci zpětného volání

        awesome_action.connect("activate", self.awesome_callback)

        # Přidá ji do aplikace

        self.add_action(awesome_action)

        # Builder, který přidá navrh uživatelského rozhraní z Glade do mřížky

        builder = Gtk.Builder()

        # Získá soubor (pokud existuje)

        try:

            builder.add_from_file("menubar.ui")

        except:

            print("file not found")

            sys.exit()

        # Použije metodu Gtk.Application.set_menubar(menubar) pro přidání

        # nabídkové lišty a aplikační nabídky (Poznámka: NE do okna!)

        self.set_menubar(builder.get_object("menubar"))

        self.set_app_menu(builder.get_object("appmenu"))

    # Funkce zpětného volání pro new

    def new_callback(self, action, parameter):

        print("You clicked \"New\"")

    # Funkce zpětného volání pro quit

    def quit_callback(self, action, parameter):

        print("You clicked \"Quit\"")

        sys.exit()

    # Funkce zpětného volání pro state

    def state_callback(self, action, parameter):

        print("State is set to", parameter.get_string())

        action.set_state(parameter)

    # Funkce zpětného volání pro awesome

    def awesome_callback(self, action, parameter):

        action.set_state(GLib.Variant.new_boolean(not action.get_state()))

        if action.get_state().get_boolean() is True:

            print("You checked \"Awesome\"")

        else:

            print("You unchecked \"Awesome\"")

app = MyApplication()

exit_status = app.run(sys.argv)

sys.exit(exit_status)

  </section>

  <section id="mnemonics-and-accelerators"><title>Horké klávesy a klávesové zkratky</title>

    
Popisky mohou obsahovat horké (mnemotechnické) klávesy. Mají podobu podtržených písmen v popiscích a používají se pro ovládání z klávesnice. Horké klávesy se vytváří umístěním podtržítka před příslušný znak. Například "_File" namísto "File" v atributu label v <file>menubar.ui</file>.

   
Horké klávesy jsou vidět, když zmáčknete klávesu <key>Alt</key>. Zmáčknutím <keyseq><key>Alt</key> <key>F</key></keyseq> otevřete nabídku <gui>File</gui>.

    
Klávesové zkratky mohou být přidány přímo do definicí uživatelského rozhraní. Například je běžné, že aplikaci lze ukončit zmáčknutím <keyseq><key>Ctrl</key><key>Q</key></keyseq>, nebo že lze uložit soubor zmáčknutím <keyseq><key>Ctrl</key><key>S</key></keyseq>. Pro přidání klávesové zkratky do definice uživatelského rozhraní stačí akorát přidat do položky atribut "accel".

<attribute name="accel">&lt;Primary&gt;q</attribute> vytvoří sekvenci <keyseq><key>Ctrl</key><key>Q</key></keyseq> při přidávání položky Quit. „Primary“ má zde význam klávesy <key>Ctrl</key> na počítačích PC nebo klávesy <key>⌘</key> na počítačích Mac.

<item>

  <attribute name="label">_Quit</attribute>

  <attribute name="action">app.quit</attribute>

  <attribute name="accel">&lt;Primary&gt;q</attribute>

</item>

  </section>

  <section id="translatable"><title>Přeložitelné řetězce</title>

   
Protože aplikace GNOME jsou překládány do <link href="http://l10n.gnome.org/languages/">mnoha jazyků</link>, je důležité, aby řetězce ve vaší aplikaci byly přeložitelné. U popisku to zajistíte jednoduše nastavením translatable="yes":

     <attribute name="label" translatable="yes">Quit</attribute>

  </section>

  <section id="references">

    <title>Odkazy k API</title>

    
V této ukázce se používá následující:

    <list>

      <item>
<link href="http://developer.gnome.org/gio/unstable/GSimpleAction.html">GSimpleAction</link>
</item>

      <item>
<link href="http://developer.gnome.org/gtk3/unstable/GtkBuilder.html">GtkBuilder</link>
</item>

    </list>

  </section>

</page>