Development/Tutorials/Using KActions (fi)

From KDE TechBase
< Development‎ | Tutorials
Revision as of 10:35, 11 January 2008 by Ozzi (talk | contribs)


Development/Tutorials/Using_KActions


Perehdytys 3 - KActions ja XMLGUI
Tutorial Series   Beginner Tutorial
Previous   Perehdytys 2 - Main-ikkunan luonti, XML perustietous
What's Next   Perehdytys 4 - Tallettaminen ja Avaaminen
Further Reading   None

Lyhyesti

Tämä perehdytys esittelee toiminnot. Toiminnot tarjoavat yhtenäisen tavan käyttäjälle vuorovaikuttaa ohjelman kanssa.

Jos esimerkiksi haluamme antaa perehdytyksessä 3 käyttäjlle mahdollisuuden tyhjentää tekstieditori hiiren näpäytyksellä työkaluriviltä, vaihtoehtoisesti Tiedosto-valikon kautta tai näppäinyhdistelmän avulla, voidaan tämä tehdä helposti käyttämällä KAction-luokkaa.

KAction

KAction on objekti joka sisältää kaiken tarvittavan tiedon ikonista ja näppäinyhdistelmistä jotka on yhdistetty joihinkin toimintoon. Toiminto taas on yhdistetty slot:n joka huolehtii toiminnon suorittamisesta.

Koodi

main.cpp

  1. include <KApplication>
  2. include <KAboutData>
  3. include <KCmdLineArgs>
  1. include "mainwindow.h"

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

 KAboutData aboutData( "tutorial3", "tutorial3",
     ki18n("Tutorial 3"), "1.0",
     ki18n("A simple text area using KAction etc."),
     KAboutData::License_GPL,
     ki18n("Copyright (c) 2007 Developer") );
 KCmdLineArgs::init( argc, argv, &aboutData );
 KApplication app;

 MainWindow* window = new MainWindow();
 window->show();
 return app.exec();

} Tällä kerralla muutokset tähän tiedostoon ovat hyvin vähäisiä. Ainoastaan "tutorial 2" on korjattu "tutorial 3".

mainwindow.h

  1. ifndef MAINWINDOW_H
  2. define MAINWINDOW_H
  1. include <KXmlGuiWindow>
  2. include <KTextEdit>

class MainWindow : public KXmlGuiWindow { 

 public:
   MainWindow(QWidget *parent=0);

 private:
   KTextEdit* textArea;
   void setupActions();

};

  1. endif

Otsikkotiedostoon on lisätty void setupActions() jossa tehdään kaikki tarvittavat asettelut toimintoa varten.

mainwindow.cpp

  1. include "mainwindow.h"
  1. include <KApplication>
  2. include <KAction>
  3. include <KLocale>
  4. include <KActionCollection>
  5. include <KStandardAction>

MainWindow::MainWindow(QWidget *parent) 

   : KXmlGuiWindow(parent)

{ 

 textArea = new KTextEdit;
 setCentralWidget(textArea);

 setupActions();

}

void MainWindow::setupActions() { 

 KAction* clearAction = new KAction(this);
 clearAction->setText(i18n("Clear"));
 clearAction->setIcon(KIcon("document-new"));
 clearAction->setShortcut(Qt::CTRL + Qt::Key_W);
 actionCollection()->addAction("clear", clearAction);
 connect(clearAction, SIGNAL(triggered(bool)),
         textArea, SLOT(clear()));

 KStandardAction::quit(kapp, SLOT(quit()),
                       actionCollection());

 setupGUI();

}

Selvitys

Tämä perehdytys perustuu edelliseen perehdytykseen. Suurin osa koodi muutoksista on mainwindow.cpp tiedostossa. Muodostajassa kutsutaan nyt setupActions() setupGUI() sijaan. setupActions():ssa sijaitsee uusi KAction koodi joka lopuksi kutsuu setupGUI()-funktiota.

KAction objektin luominen

KActionin käyttöönotossa on muutamia vaiheita. Ensimmäinen on sisällyttää KAction-kirjasto ja luoda uusi KAction:

  1. include <KAction>

... KAction* clearAction = new KAction(this);

KAction:n ominaisuuksien asettelu

Teksti

Nyt meillä siis on KAction objekti, joten voimme alkaa muokkaamaan sen ominaisuuksia. Seuraava koodi asettaa tekstin joka näytetään valikossa sekä työkaluvalikossa olevan ikonin alapuolella. clearAction->setText(i18n("Clear")); Huomaa että teksti on syötetty i18n()-funktionin läpi. Tämä on pakollinen jotta käyttöliittymä on käännettävissä eri kielille. Lisätietoja lokalisoinnista löytyy i18n perehdytyksestä).

Ikoni

Jos toiminto on aikomus näyttää työkalurivillä, olisi hyvä jos sillä olisi toimintoa kuvaava ikoni. Seuraava koodi asettaa standardin KDE document-new(Uusi asiakirja) ikonin clearAction toiminnolle: clearAction->setIcon(KIcon("document-new"));

Pikanäppäinyhdistelmä

Pikanäppäinyhdistelmän asettaminen toiminnollemme on yhtälailla helppo. Seuraava koodi osoittaa yhdistelmän Ctrl+W clearAction toiminnolle: clearAction->setShortcut(Qt::CTRL + Qt::Key_W);

Kokoelmaan lisääminen

Jotta toimintoon olisi mahdollista päästä käsiksi XMLGUI-kehyksen(selitetty tarkemmin myöhemmin) läpi, se pitää lisätä ohjelman toiminto kokoelmaan. Toimintokokoelmaa käsitellään actionCollection()-funktion avulla seuraavasti: actionCollection()->addAction("clear", clearAction); Tässä clearAction KAction on lisätty kokoelmaan nimellä clear. Nimeä (clear) on käytetään XMLGUI-kehyksessä kuvaamaan tätä toimintoa.

Toiminnon yhdistäminen

Kun toiminto on asetettu kuntoon, si pitää yhdistää johonkin joka toteuttaa toiminnon. Tässä tapauksessa (koska haluamme tyhjentää tekstialueen), yhdistämme toiminnon KTextEdit:n kuuluvaan clear()-funktioon (joka tyhjentää tekstialueen) seuraavasti: connect( clearAction, SIGNAL( triggered(bool) ), 

        textArea, SLOT( clear() ) );

Tämä sama voidaan tehdä Qt:n kanssa käyttämällä QAction.

KStandardAction

Toimintoja varten jotka esiintyvät lähes jokaisessa KDE ohjelmassa kuten 'sulje', 'tallenna' ja 'avaa' on olemassa valmiiksi luotuja sopivia toimintoja jotka on käytettävissä KStandardAction:n avulla.

Nämä ovat erittäin helppoja ottaa käyttöön. Kun ensin on otettu kirjasto käyttöön (#include <KStandardAction>), tarvitsee vain ottaa haluttu toiminto käyttöön, esim: KStandardAction::quit(kapp, SLOT(quit()), actionCollection()); Tämä luo Lopeta-toiminnon, oikean ikonin, tekstin ja pikanäppäinyhdistelmän kanssa sekä jopa lisää sen Tiedosto-valikkoon.

Toiminnon lisääminen valikoihin ja työkaluriville

Tällä hetkellä, uusi "Tyhjennä" toiminto on luotu, mutta sitä ei ole vielä yhdistetty yhteenkään valikkoon tai työkaluriviin. Tähän tarkoitukseen käytämme KDE tekniikkaa nimeltään XMLGUI, jonka avulla voidaan toteuttaa mm. siirrettävät työkalurivit.

Note
Myöhemmissä KDE4 versioisssa XMLGUI-kehys saatetaan vaihtaa liveui-kehykseen, mutta tällä hetkellä XMLGUI on ainoa oikea tapa asettaa käyttöliittymä


XMLGUI

KXmlGuiWindow:n setupGUI()-funktion käyttöliittymän muodostus on riippuvainen XMLGUI-järjestelmästä joka hakee XML-tiedostosta käyttöliittymän muodostuksessa tarvittavat tiedot.

XML tiedston nimeämissäännöt ovat riippuvaisia siitä ohjelmannimestä joka on asetettu KAboutData:ssa (tässä tapauksessa tutorial3) siten että XML-toedostonimi muodostuu: ohjelmannimi + ui.rc (tässä tapauksessa siis tutorial3ui.rc).

ohjelmannimiui.rc - tiedosto

Koska käyttöliittymä on määritelty XML-tiedoston avulla, ulkoasun täytyy noudattaa tiettyjä sääntöjä. Tämä perehdytys ei paneudu kovin syvällisesti tähän aiheeseen. Lisätietoja: XMLGUI - Tekniikka(tulossa ?).

tutorial3ui.rc

<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE kpartgui SYSTEM "kpartgui.dtd"> <gui name="tutorial3" version="1"> 

 <ToolBar name="mainToolBar" >
   <text>Main Toolbar</text>
   <Action name="clear" />
 </ToolBar>
 <MenuBar>
   <Menu name="file" >
     <Action name="clear" />
   </Menu>
 </MenuBar>

</gui>

<Toolbar>-kohdassa kuvaillaan ikkunan yläosassa, yleensä ikonein varusteltu, vaakasuuntainen laidasta laitaan sijaitseva työkalurivi. Tässä tapauksessa työkaluriville on annettu yksilöllinen nimi mainToolBar ja sen näkyvä nimi on asetettu <text>-merkinnällä Main Toolbar:ksi. Tyhjennä-toiminto on asetettu työkaluriville <Action>-merkinnän avulla. Toiminnon nimi on sama joka aikasemmin lisättiin addAction()-funktion avulla toimintokokoelmaan mainwindow.cpp-tiedostossa.

Toiminto on mahdollista lisätä myös valikkoriville. Tässä tapauksessa Tyhjennä toiminto on lisätty Tiedosto(File) valikkoon, samalla tavalla kuin se lisättiin työkalurivillekkin.

Muista vaihtaa 'version'-määrite(versionumero) <gui>-merkinnästä jos muutat .rc-tiedostoa saattaaksesi viimeisimmän asennuksen mukaisen version järjestelmänvälmuistiin.

CMake

Lopuksi tutorial3ui.rc-tiedosto täytyy sijoittaa jonnekkin mistä KDE voi sen löytää (sitä ei voi pelkästään jättää lähdehakemistoon). Tämä tarkoittaa että tämä projekti tarvitsee asentaa jonnekkin.

CMakeLists.txt

project(tutorial3)

find_package(KDE4 REQUIRED) include_directories(${KDE4_INCLUDES})

set(tutorial3_SRCS 

 main.cpp
 mainwindow.cpp

)

kde4_add_executable(tutorial3 ${tutorial3_SRCS})

target_link_libraries(tutorial3 ${KDE4_KDEUI_LIBS})

install(TARGETS tutorial3 DESTINATION ${BIN_INSTALL_DIR}) install(FILES tutorial3ui.rc 

       DESTINATION  ${DATA_INSTALL_DIR}/tutorial3)

Tämä tiedosto on lähes identtinen Perehdytys 2:n vastaavan kanssa. Ainoastaan tiedoston loppuun on lisätty kaksi uutta riviä jotka kertovat minne tiedostot tulee asentaa. tutorial3(suoritettava binääri, ohjelma) asennetaan hakemistoon joka on määritelty BIN_INSTALL_DIR-muttujassa ja tutorial3ui.rc-tiedosto joka siis määrittelee ohjelman ulkoasun, asennetaan ohjelman data-hakemistoon.

Käännä, Asenna ja Suorita

Jos sinulla ei ole kirjoitusoikeutta KDE4:n asennushakemistoon, voit asentaa ohjelmasi myös kotikansiossa olevaan hakemistoon.

Kertoaksesi CMakelle, minne ohjelma tulee asentaa, tarvitsee käyttää DCMAKE_INSTALL_PREFIX-kytkintä. Luultavasti haluat asentaa nämä perehdytykset kotihakemistoosi (KDE asennushakemisto on oletuksena asennushakemisto) joten ehdotan seuraavaa: mkdir build && cd build cmake .. -DCMAKE_INSTALL_PREFIX=$HOME/kde4_harjoittelu make install $HOME/kde4_harjoittelu/bin/tutorial3 Ylläoleva luo KDE-hakemistorakenteen kotihakemistosi kde_harjoittelu-hakemiston alle sekä asentaa ohjelman sinne oikeille paikoilleen.

Seuraavaksi

Nyt olet valmis siirtymään eteenpäin Perehdytys 4 - Tallettaminen ja Avaaminen-kohtaan.

Retrieved from "https://techbase.kde.org/index.php?title=Development/Tutorials/Using_KActions_(fi)&oldid=19532"