# &ksplash;i käsiraamat

&Teemu.Rytilahti; &Teemu.Rytilahti.mail;
&Brian.C.Ledbetter; &Brian.C.Ledbetter.mail;
&Ravikiran.Rajagopal; &Ravikiran.Rajagopal.mail;
Marek
Laane

    bald@online.ee

Tõlge eesti keelde
2003
Teemu Rytilahti
2003-04
Ravikiran Rajagopal
&FDLNotice;
2003-01-10
1.01.00

&ksplash; on kena käivitusekraan, mis näitab rakenduse laadimise edenemist.

KDE
kdebase
ksplash
ksplashml
käivitusekraan
silmarõõm

## Sissejuhatus

&ksplash; on kena käivitusekraan, mis näitab rakenduse laadimise edenemist. Palun anna kõigist probleemidest või mõtetest täiustamise kohta teada &kde; meililistides. &ksplash;i peamised omadused on:

- Teemade kasutamine
- Pluginate kasutamine (võimaldab täielikku kohandamist oma suva järgi)
- Võimalus kasutada suvalise rakendusega, mis pruugib DCOP-i

Käesolev käsiraamat selgitab, kuidas luua teemasid kasutamiseks juba olemasolevate pluginatega. Kui ükski plugin ei suuda sinu tuju järgi olla, võib õppida &ksplash;i välimust igati ja täielikult muutma pluginat ise C++ keeles kirja pannes.

## Teemade kasutamine

Kui tahad kasutada saidi KDE-Look teemasid, paki need ainult endale kasutamiseks lahti kataloogi `~/.kde/share/apps/ksplash/Themes/` või kataloogi `$`KDEDIR`/share/apps/ksplash/Themes/`, kui soovid need teha kättesaadavaks kõigile süsteemi kasutajatele.

Kogu selle vaeva võib lasta automaatselt ära teha küll ka &kde; juhtimiskeskuse kaardi Välimus moodulil Käivitusekraan.

### &kcontrol;e mooduli kasutamine

See moodul võimaldab paigaldada, testida ja eemaldada &ksplash;i teemasid.

Moodul näitab kõiki parajasti saadaolevaid &ksplash;i teemasid. Kui valida neist mõni, saab selle eelvaatlust näha akna põhiosas. Kui oled leidnud selle, mida soovid kasutada, klõpsa nupule OK või Rakenda. Kui soovid moodulist väljuda muudatusi tegemata, klõpsa nupule Loobu, või nupule Vaikeväärtused, kui soovid taastada süsteemse vaikekäivitusekraani.

Uue mooduli paigaldamiseks klõpsa nupule Lisa... ja otsi vajalik teema arvutist üles. Sul ei ole vaja teemafaile ise lahti pakkida, võid rahumeeli valida ka tihendatud teemafaili. Teema paigaldamine ei tähenda veel, et seda kohe kasutama hakataks - selleks tuleb see loendis valida ja klõpsata nupule OK või Rakenda.

Eelvaatlust lubab küll käivitusekraanist ülevaate saada, kuid tõenäoliselt tahaksid seda siiski nii-öelda päriselt näha, et näiteks kontrollida, kuidas toimib animatsioon. Teemasid on võimalik testida, kui valida loendist teema ja klõpsata nupule Test.

Kui sa ei soovi enam mõnda teemat kasutada, võib selle eemaldada, kui valida loendis teema ja klõpsata nupule Eemalda. Pane tähele, et tavakasutajal ei ole üldiselt õigust eemaldada süsteemselt paigaldatud teemasid. Samuti on päris soovitatav mitte eemaldada käivitusekraani, mille nimeks on vaikimisi

## Kuidas luua teemasid &ksplash;ile

### Üldine

Oma teema loomine &ksplash;ile on päris lihtne. Kui oled teema valmis saanud, võid selle postitada veebileheküljele KDE-Look, et sinu suurepärasest ilumeelest saaksid osa ka teised.

#### Teema identifitseerimine

Võtame ette teema `MinuLaheTeema` loomise. Et &ksplash; teemat tunnistaks, tuleb see salvestada kataloogi `MinuLaheTeema`, mis omakorda paikneb kataloogis `~/.kde/apps/ksplash/Themes/`. Teemat sisaldab fail nimega `Theme.rc`. Selles võib ära määrata terve hulga erilisi omadusi, muuta kasutatavat pluginamootorit ja nii edasi. Kõiki vähegi mõeldavaid seadistusi kasutada ei ole mõistagi kohustuslik, sest tavaliselt on seadistustele määratud üsna mõistlikud vaikeväärtused. Faili `Theme.rc` kirjete põhisüntaks on lihtne: `[võti] = [väärtus]`. Võtmete definitsioonid leiab käsiraamatu edasistes osades.

##### Lihtne `Theme.rc` fail

    [KSplash Theme: MinuLaheTeema]
    Name = MinuLaheTeema
    Description = Kena XpLike mootorit kasutav teema
    Version = 1.0
    Author = Tegelik nimi <tegelik_meiliaadress@mail.ee>
    ## Selle teema puhul kasutatakse XpLike mootorit.
    Engine = XpLike
    Show Icon = false
    Welcome Text = KDE käivitamine

Pärast teema nime, kirjelduse ja autori määramist tuleb valida teema mootor (sageli nimetatakse seda ka pluginaks). Seejärel saab meelepäraseks muuta mootori mitmesugused võimalused, pannes paika võtme-väärtuse paarid, nagu näha toodud näites.

Tuleb kindlasti tähele panna, et kataloog, kuhu teemafailid on salvestatud (antud juhul `~/.kde/apps/ksplash/Themes/MyCoolTheme`), ning teema identifikaator (antud juhul `[KSplash Theme: MyCoolTheme]` ) failis `Theme.rc` oleks samasugused, sest muidu ei tunne &ksplash; teemat ära.

#### Taustafailid

Kui &ksplash; tööd alustab, püüab ta leida sinu parajasti valitsevale ekraaniresolutsioonile vastavat taustapilti, kui teemamootor seda kasutama peaks. Taustapildi fail peaks kandma järgmises vormingus nime: `BackgroundLAIUSxKÕRGUS.png`.

Näiteks `Background-1024x768`. Kui resolutsioonile vastavat taustapilti ei leita, püütakse muuta algupärase `Background.png` või failis `Theme.rc` määratud faili suurust, et see sobiks kokku valitseva resolutsiooniga. Selline lennult suuruse muutmine võib võtta tükk aega, mispärast oleks kasulik omada vähemalt järgmistes mõõtmetes taustapilte: 1280x1024, 1024x768 ja 800x600.

### Teemamootorite valikud

#### Standardteema

##### Standardteema valikud

Nimi | Argument | Seletus
Statusbar Position | [top/bottom] | Määrab olekuriba asukoha ekraanil. Vaikimisi on see all (bottom).
Statusbar Visible | [true/false] | Määrab, kas olekuriba näidata või mitte. Vaikimisi on see väärtus tõene (true).
Progress Visible | [true/false] | Määrab, kas laadimise edenemist näidata või mitte. Vaikimisi on see väärtus tõene (true).
Statusbar Font | [fondinimi] | Olekuribal kasutatav font. Vaikimisi on see Helvetica.
Statusbar Font Size | [suurus] | Olekuriba fondi suurus. Vaikimisi on see 16.
Statusbar Font Bold | [true/false] | Määrab, kas olekuriba font on rasvases kirjas või mitte. Vaikimisi on see väärtus tõene (true).
Statusbar Font Italic | [true/false] | Määrab, kas olekuriba font on kaldkirjas või mitte. Vaikimisi on see väärtus väär (false).
Statusbar Foreground | [värv] | Olekuriba esiplaani värv. Vaikimisi on see valge (white).
Statusbar Background | [värv] | Olekuriba tausta värv. Vaikimisi on see must (black).
Statusbar Icon | [true/false] | Määrab, kas olekuribal peaks olema ikoon või mitte.
Icons Visible | [true/false] | Määrab, kas ikoonid on näha või mitte. Vaikimisi on see väärtus tõene (true).
Icons Jumping | [true/false] | Määrab, kas ikoonid hüppavad või mitte. Vaikimisi on see väärtus tõene (true).
Icon Position | [0-3,10-13] | Asukoht, kus ikoone näidatakse. Vaikimisi all vasakul.
Splash Screen | [nimi] | Muudab näidatavat käivituslogo pilti.

#### Redmondi teema

##### Redmondi teema valikud

Nimi | Argument | Seletus
Background Image | [failinimi] | Kasutaja määratud kasutatav taustapilt.
User Icon | [ikooninimi] | Kasutajale näidatava standardikooni nimi. Vaikimisi `go`.
Welcome Text | [tekst] | Käivitusekraanil näidatav tekst. Vaikimisi "Welcome" (inglise keele korral). Eestinduses võiks olla "Tere tulemast".
Username Text | [tekst] | Tekst, mida näidatakse kasutaja tegeliku nime asemel.
Welcome Text Position | [x,y] | Asukoht ekraanil, kus näidatakse tervitusteksti.
Username Text Position | [x,y] | Asukoht ekraanil, kus näidatakse kasutajanime.
Action Text Position | [x,y] | Asukoht ekraanil, kus näidatakse parajasti käivat tegevust.
Icon Position | [x,y] | Asukoht ekraanil, kus näidatakse kasutaja ikooni.
Show Welcome Text | [true/false] | Lülitab tervitusteksti näitamist. Vaikimisi tõene (true).
Show Welcome Shadow | [true/false] | Lülitab tervitusteksti varju näitamist. Vaikimisi tõene (true).
Show Username | [true/false] | Lülitab kasutajanime näitamist. Vaikimisi tõene (true).
Show Action | [true/false] | Lülitab parajasti sooritatava tegevuse näitamist. Vaikimisi tõene (true).
Show Icon | [true/false] | Määrab, kas ikooni näidata või mitte. Vaikimisi tõene (true).
Use KDM User Icon | [true/false] | Kasutaja sisselogimisikooni näitamine. Vaikimisi tõene (true).

#### MacX teema

##### MacX teema valikud

Nimi | Argument | Seletus
Icon Size Minimum | [suurus] | Omistab ikoonidele miinimumsuuruse. Vaikimisi 16.
Icon Size Maximum | [suurus] | Omistab ikoonidele maksimumsuuruse. Vaikimisi 64.
Optimized Icon Rendering | [true/false] | Optimeerib ikoonide teisendamist. Vaikimisi tõene (true).
Progress Bar Visible | [true/false] | Vaikimisi tõene (true).
Progress Bar Position | [top/bottom] | Määrab, kas olekuriba asub all (bottom) või ülal (top). Vaikimisi all.
Icons Jumping | [true/false] | Määrab, kas ikoonid hüppavad või mitte. Vaikimisi väär (false).

#### MacClassic teema

##### MacClassic teema valikud

Nimi | Argument | Seletus
Icon Position | [0-3,10-13] | Ikoonide asukoht ekraanil. Vaikimisi all vasakul.
Icons Jumping | [true/false] | Määrab, kas ikoonid hüppavad või mitte. Vaikimisi väär (false).
Icons Visible | [true/false] | Määrab, kas ikoonid on näha või mitte. Vaikimisi on see väärtus tõene (true).
Splash Screen | [nimi] | Muudab näidatavat käivituslogo pilti.

#### 2k teema

##### 2k teema valikud

Nimi | Argument | Seletus
Title Background Color | [värv] | Tiitli tausta värv. Vaikimisi tumesinine (dark blue).
Title Foreground Color | [värv] | Tiitli esiplaani värv. Vaikimisi valge (white).
Status Text Color | [värv] | Staatusetekstide värv. Vaikimisi sama, mis tiitli tausta värv.
Rotator Color 1 | [värv] | Määrab esimese rotaatori värvi. Vaikimisi tumesinine (dark blue).
Rotator Color 2 | [värv] | Määrab teise rotaatori värvi. Vaikimisi tsüaan (cyan).
Rotator Speed | [väärtus] | Määrab rotaatori kiiruse. Vaikimisi 30.
Window Title | [tekst] | Määrab aknatiitli teksti.
Logo File | [failinimi] | Määrab kasutatava logo.

## &ksplash;i kasutamine oma rakendustel

Selles peatükis kirjeldame lihtsat viisi, kuidas kasutada &ksplash;i oma &kde; rakenduse käivituslogona. Kui sa ei tegele rakenduste arendamisega &kde; tarbeks, võid peatüki ka vahele jätta.

### Põhinõuded

Valitud &kde; rakendus peab olema &DCOP;-teadlik. &DCOP; on &kde; rakendustevahelise suhtlemise tehnoloogia. Kui kasutad standardset &kde; rakenduse raamistikku, peaks selle eest olema automaatselt hoolt kantud. Kui vajad rohkem infot &DCOP;i ja sellega seotud &kde; tehnoloogia kohta, uuri &kde; arendajate kodulehekülge.

### &ksplash;i käivitamine

Enne seda, kui sinu rakendus alustab arvutikurnamist või pluginate laadimist &etc;, kutsu &ksplash; nii välja:

    DCOPClient *c = kapp->dcopClient();
    QString error;
    QCString KSplashName;
    int pid = 0;
    QStringList args;
    args << "--theme=MyCoolTheme" << "--managed";
    if (kapp->startServiceByDesktopName("ksplash", args, &error, &KSplashName, &pid))
    {
      KMessageBox::sorry(0, error, "Unable to invoke KSplash");
      // Some error processing here.
    }

Me eeldame, et korraga töötab ainult üks &ksplash;i protsess, muidu lähevad asjad natuke keerulisemaks. Täpsemalt loe selle kohta &DCOP;i dokumentatsioonist.

### Teadete näitamine

Enne kui näidata mingeid teateid, tuleb määrata, mitut sammu näidatakse. Näiteks &kde; käivitusprotseduuril on 7 sammu.

    QByteArray data;
        QDataStream arg(data,IO_WriteOnly);
        arg << someNumber;
        if (!(c->send(KSplashName, "KSplashIface", "setStartupItemCount(int)", data))
          // Some error processing here.

Kui soovid näidata teadet ikooniga või ilma, kasuta

    arg << QString("ikooniNimi") << QString("rakenduseNimi") << QString("Mingi kirjeldus");
        if (!(c->send(KSplashName, "KSplashIface", "programStarted(QString,QString,QString)", data))
        {
          // Some error processing here.
        }

Iga kord, kui kutsuda välja `programStarted`, lisatakse uus samm. Kui rakendus on käivitumise lõpetanud, pane käivitulogo kaduma:

    if (!(c->send(KSplashName, "KSplashIface", "startupComplete()", data))
        {
          // Some error processing here.
        }

Ja ongi kõik! Selleks, et osa saada kõigest, mida &ksplash; sulle pakkuda suudab, ei ole vaja midagi rohkem teha.

## Uute &ksplash;i pluginate kirjutamine

&ksplash;ile uute pluginate kirjutamine pole kuigi raske. Selles peatükis kirjutame lihtsa plugina, mis emuleerib hästi tuntud operatsioonisüsteemi käivitusekraani. Me eeldame, et sa tunned C++ põhialuseid ja oled kas või põgusalt tuttav KDE/Qt programmeerimisega.

### Põhinõuded

Loome plugina nimetusega `2k`. Plugina nime kasutatakse mitmes kohas ning oluline on seda kõikjal ühtmoodi kasutada, et &ksplash; selle ikka ära tunneks. Õigupoolest on &ksplash;i pluginad dünaamiliselt laetavad teegid, mille juures tuleb järgida järgmisi nimekonventsioone:

- Teek peaks kandma nime `ksplash+teemanimiväiketähtedega`. Meie teema puhul siis `ksplash2k`.
- Sellele peab vastama töölauafail nimega `ksplash+teemanimiväiketähtedega.desktop`, meie juhul siis `ksplash2k.desktop`.
- Lõpuks peab teegi tagastatud objekt olema klass nimega `Theme+teemanimi`, meie juhul `Theme2k`.

Ei tasu masendusse langeda, kui sa kõigest kohe aru ei saanud. Hiljem vaatame kõiki punkte lähemalt. Veel üks oluline punkt on see, et pluginaklassi päritolu peab olema `ThemeEngine`.

### Näidisraamistiku loomine

Me kasutame &kde; rakenduse raamistikku, mis hoolitseb plugina loomise eest ja pakub meile sõltumatust platvormist, ilma et me selleks ise erilisi pingutusi peaksime ette võtma. Selleks kontrolli, et paigaldatud oleks pakett `kdesdk`. Anna käsk `kapptemplate` rakenduse nimega "2k" tekitamiseks. See loob tipptaseme kataloogi, kus on mitmed üldised failid, näiteks AUTHORS &etc; Meid huvitab kõige enam alamkataloog `2k`. Mine sellesse alamkataloogi ja kustuta seal kõik failid. Nüüd on meil olemas vajalik "luustik".

Järgmine samm on luua `.desktop`-fail, mis paigaldamise korral teatab &ksplash;ile, et meie plugin on saadaval. Vastavalt eelmises osas kirjeldatud nimekonventsioonidele loome siin kataloogis faili `ksplash2k.desktop`. See peaks sisaldama järgmisi ridu:

    [Desktop Entry]
    Encoding=UTF-8
    Type=Service
    Comment=KSplash Plugin
    Name=KSplash2k
    ServiceTypes=KSplash/Plugin
    X-KDE-Library=ksplash2k
    X-KSplash-Default=true
    X-KSplash-PluginName=2k
    X-KSplash-ObjectName=Theme2k

Kodeering (`Encoding`), tüüp (`Type`), kommentaar (`Comment`) ja teenuse tüüp (`ServiceTypes`) on kõigile pluginatele ühesugused. Plugina ja teegi nimi järgivad eespool mainitud nimekonventsiooni. Kirje `X-KSplash-Default` kasutab tõeväärtust, mis määrab, kas seda näidatakse vaikimisi juhtimiskeskuse moodulis. Kui mõned harvad erandid kõrvale jätta, peaks see väärtus olema tõene (`true`).

### Pluginaklassi deklaratsioon

Eeltöö on tehtud, asume nüüd tõeliselt vaimustava osa kallale - looma klassi, mis pakub just sellist käitumist, mida me soovime. Me võime selle klassiga ette võtta küll peaaegu kõike, mida soovime, kuid siiski on siin teatud piirangud.

1. Pluginaklasside päritolu peab olema klass `ThemeEngine`.

2. Pluginaklassid peavad kandma nime vastavalt reeglile `Theme+PluginaNimi`.

3. Pluginaklassid peavad pakkuma `staatilise` funktsiooni `names`, mis tagastab nimede nimekirja, mida see saab välja kutsuda.

4. Kui pluginat saab seadistada juhtimismoodulis, peab see seadistamiseks pakkuma `ThemeEngineClass`-põhise klassi.

5. Pluginaklassid peavad tühistama vähemalt ühe virtuaalsetest funktsioonidest `slotSetText`, `slotSetPixmap`, `slotUpdateProgress` ja `slotUpdateSteps`, et see oleks kasutatav.

6. Konstruktor peab olema kujul `ThemeEngine( QWidget *parent, const char *name, const QStringList &args )`, et seda saaks kasutada koos klassiga `KGenericFactory`.

Viimane nõue võib tunduda keerukana, kuid hiljem näeme, et üheainsa rea lisamisega lähtefailidesse võib seda enamasti ignoreerida.

### Päisefaili kood

Piiranguid arvestades vaatame nüüd, milline näeb välja päisefail `theme2k.h`:

#### `theme2k.h` listing

    #ifndef __THEME2K_H__
    #define __THEME2K_H__

    #include <qlabel.h>
    #include <qwidget.h>

    #include <kdialogbase.h>
    #include <kpixmap.h>
    #include <ksplash/themeengine.h>

    class RotWidget;

    class Cfg2k: public ThemeEngineConfig
    {
      Q_OBJECT
    public:
      Cfg2k( KConfig * );
    };

    class ObjKsTheme;
    class Theme2k: public ThemeEngine
    {
      Q_OBJECT
    public:
      Theme2k( QWidget *, const char *, const QStringList& );

      inline const QString name()
      {
        return( QString("KSplash2k") );
      }
      inline const KDialogBase *config( KConfig *kc )
      {
        return new Cfg2k( kc );
      }
      static QStringList names()
      {
        QStringList Names;
        Names << "KSplash2k";
        Names << "ks2k";
        Names << "2k";
        Names << "2000";
        return( Names );
      };

    public slots:
      inline void slotSetText( const QString& s )
      {
        if( mText && mText->text() != s ) mText->setText( s );
      };

    private:
      void initUi();
      void readSettings();

      QLabel *mText;
      RotWidget *mRotator;
      QColor mTBgColor, mTFgColor, mRotColor1, mRotColor2, mStatusColor;
      int mRotSpeed;
      QString mWndTitle, mLogoFile;
    };

    #endif

Analüüsime nüüd seda listingut. Klass `Theme2k` rahuldab nimekonventsiooni ja tema päritolu on `ThemeEngine`. Ta pakub `Theme2k::names()` ja tal on konstruktor, mis võtab soovitavad parameetrid `Theme2k( QWidget *, const char *, const QStringList& );` ning pakub ka lihtsa meetodi `Theme2k::slotSetText()`. Hetkel ei ole mõtet pead vaevata klassiga `RotWidget`. See on väike element, mis pakub kasutajale veidi silmailu. Meie plugin on äärmiselt lihtne ega näita mingeid ikoone või edenemisriba. Kui soovid ikoone näidata, tühista funktsioon `slotSetPixmap`. Sarnased funktsioonid on olemas edenemisriba vahemikule (`slotUpdateSteps`) ja käesoleva sammu kasvamisele (`slotUpdateProgress`).

### Plugina teostus

Uurime ainult meile kordaminevaid teostuse osi. Kogu teostuse listingut võib näha lisas. Kõigepealt tuleb välja saada teeginõue:

#### Teeginõue

    K_EXPORT_COMPONENT_FACTORY( ksplash2k, KGenericFactory<Theme2k> );

Makro `K_EXPORT_COMPONENT_FACTORY` on deklareeritud failis `kgenericfactory.h`. Edasi konstruktori kallale. Kuna see on väga lihtne plugin, on ka konstruktor lihtne ja selge.

#### Plugina konstruktor

    Theme2k::Theme2k( QWidget *parent, const char *name, const QStringList &args  )
        :ThemeEngine( parent, name, args )
    {
      readSettings();
      initUi();
    }

Meetod `readSettings()` illustreerib korrektset teemaseadistuste hankimise viisi. Sa ju soovid, et inimesed kasutaks sinu pluginaid oma teemades, või kuidas?

#### Teemaseadistuste hankimine

    void Theme2k::readSettings()
    {
      if( !mTheme )
        return;

      KConfig *cfg = mTheme->themeConfig();
      if( !cfg )
        return;

      cfg->setGroup( QString("KSplash Theme: %1").arg(mTheme->theme()) );

      QColor DefaultTBgColor( Qt::darkBlue );
      QColor DefaultTFgColor( Qt::white );

      mTBgColor = cfg->readColorEntry( "Title Background Color", &DefaultTBgColor );
      mTFgColor = cfg->readColorEntry( "Title Foreground Color", &DefaultTFgColor );
      mStatusColor = cfg->readColorEntry("Status Text Color", &mTBgColor );

      QColor DefaultRot1( Qt::darkBlue );
      QColor DefaultRot2( Qt::cyan );
      mRotColor1 = cfg->readColorEntry( "Rotator Color 1", &DefaultRot1 );
      mRotColor2 = cfg->readColorEntry( "Rotator Color 2", &DefaultRot2 );

      mRotSpeed = cfg->readNumEntry( "Rotator Speed", 30 );
      mWndTitle = cfg->readEntry( "Window Title", i18n("Please wait...") );
      mLogoFile = cfg->readEntry( "Logo File", QString::null );
    }

Kuna meile meeldivad meie kasutajad, pakume neile parameetritena mõistlikke vaikeväärtusi, mida teemafailis ei leidu. Pane tähele, et alati tuleb grupiks määrata "KSplash Theme: themename", et ühilduda tulevase teema spetsifikatsiooniga. Meetod `initUI()` meid praegu eriti ei huvita, sest see ainult loob elemente. Selle kohta vaata lähemalt lisast.

### Plugina kompileerimine

Kuna me otsustasime kasutada plugina kompileerimiseks &kde; raamistikku, tuleb meil luua `Makefile.am`. See peaks välja nägema nii:

#### `Makefile.am` listing

    INCLUDES = $(all_includes)

    kde_module_LTLIBRARIES = ksplash2k.la

    ksplash2k_la_SOURCES = theme2k.cpp rotwidget.cpp
    ksplash2k_la_LDFLAGS = $(all_libraries) $(KDE_RPATH)
    ksplash2k_la_LIBADD = $(LIB_KDEUI) -lksplashthemes

    METASOURCES = AUTO

    noinst_HEADERS        = theme2k.h rotwidget.h

    servicesdir = $(kde_servicesdir)
    services_DATA = ksplash2k.desktop

    themedir = $(kde_datadir)/ksplash/Themes/2k
    theme_DATA = Theme.rc Preview.png

Rohkem infot `Makefile.am` kirjutamise kohta &kde; tarbeks leiab &kde; arendajate veebileheküljelt. Ainus asi, mida tasub märkida, on see, et me pakume sellele pluginale põhineva vaiketeema ning sellele ka eelvaatluse. Kasutajate huve silmas pidades tuleks pakkuda näidisfail `Theme.rc`, mis illustreerib erinevate valikut kasutamist.

## Küsimused ja vastused

&reporting.bugs; &updating.documentation;

Ma ei leia ühtegi teemat, mis &ksplash;is töötaks? Miks?

Tõenäoliselt ei ole sul teemale korrektseid pluginaid. Pluginad asuvad paketis `kde-artwork`. Laadi see alla, paigalda ja proovi uuesti.

Mis fail on `Theme.rc` ja kuidas seda luua?

`Theme.rc` on fail, kus saab määrata teema seadistused. Täpsemat infot vaata osast Kuidas luua teemasid &ksplash;ile.

## Autorid ja litsents

&ksplash;

Rakenduse autoriõigus © 2003: &Ravikiran.Rajagopal; &Ravikiran.Rajagopal.mail;

### Kaasautorid

- &Brian.C.Ledbetter; &Brian.C.Ledbetter.mail;

Dokumentatsiooni autoriõigus © 2003: &Teemu.Rytilahti; &Teemu.Rytilahti.mail;

&underFDL; &underGPL;

## Paigaldamine

### Nõuded

&ksplash;i edukaks kasutamiseks on vajalik &kde; 3.2 või uuem. Mõned teemad võivad nõuda spetsiifilisi pluginaid. Kui teema ei hakka tööle, võta ühendust teema autoriga ja selgita välja, kuidas ja kust hankida vajalik plugin.

### Kompileerimine ja paigaldamine

&install.compile.documentation;

## Lähtekood

### `theme2k.cpp` listing

    #include <qlabel.h>
    #include <qwidget.h>

    #include <kapplication.h>
    #include <kconfig.h>
    #include <kdebug.h>
    #include <kdialogbase.h>
    #include <kgenericfactory.h>
    #include <kglobalsettings.h>
    #include <klocale.h>
    #include <ksplash/objkstheme.h>
    #include <kstandarddirs.h>

    #include "rotwidget.h"
    #include "theme2k.h"
    #include "theme2k.moc"

    K_EXPORT_COMPONENT_FACTORY( ksplash2k, KGenericFactory<Theme2k> );

    Cfg2k::Cfg2k( KConfig * )
    {}

    Theme2k::Theme2k( QWidget *parent, const char *name, const QStringList &args  )
        :ThemeEngine( parent, name, args )
    {
      readSettings();
      initUi();
    }

    void Theme2k::initUi()
    {
      QVBox *vbox = new QVBox( this );
      vbox->setFrameShape( QFrame::WinPanel );
      vbox->setFrameShadow( QFrame::Raised );

      QHBox *labelBox = new QHBox( vbox );
      labelBox->setPalette( mTBgColor );
      labelBox->setMargin( 1 );
      QLabel *lbl = new QLabel( mWndTitle, labelBox );
      lbl->setFont( QFont( "Arial", 12, QFont::Bold ) );
      lbl->setPaletteForegroundColor( mTFgColor );

      QLabel *logo = new QLabel( vbox );
      logo->setPalette( Qt::white );

      QString px( locate( "appdata", mTheme->themeDir() + (mLogoFile.isNull()?QString("/Logo.png"):mLogoFile) ) );
      if (px.isNull())
        px = locate("appdata","Themes/Default/splash_top.png");
      if( !px.isNull() )
      {
        QPixmap pix( px );
        logo->setPixmap( pix );
      }
      else
      {
        logo->setText( "<B>KDE</B>2000" );
        logo->setAlignment( AlignCenter|AlignVCenter );
      }

      mRotator = new RotWidget( vbox, mRotColor1, mRotColor2, mRotSpeed );

      QHBox *hbox = new QHBox( vbox );
      labelBox->setSpacing( 4 );
      labelBox->setMargin( 4 );

      mText = new QLabel( hbox );
      mText->setPaletteForegroundColor( mStatusColor );
      mText->setPaletteBackgroundColor( mTFgColor );
      mText->setText( mWndTitle );
      mText->setFixedHeight( 48 );

      setFixedSize( vbox->sizeHint() );
      QRect rect(KGlobalSettings::splashScreenDesktopGeometry());
      move( rect.x() + (rect.width() - size().width())/2,
            rect.y() + (rect.height() - size().height())/2 );
    }

    void Theme2k::readSettings()
    {
      if( !mTheme )
        return;

      KConfig *cfg = mTheme->themeConfig();
      if( !cfg )
        return;

      cfg->setGroup( QString("KSplash Theme: %1").arg(mTheme->theme()) );

      QColor DefaultTBgColor( Qt::darkBlue );
      QColor DefaultTFgColor( Qt::white );

      mTBgColor = cfg->readColorEntry( "Title Background Color", &DefaultTBgColor );
      mTFgColor = cfg->readColorEntry( "Title Foreground Color", &DefaultTFgColor );
      mStatusColor = cfg->readColorEntry("Status Text Color", &mTBgColor );

      QColor DefaultRot1( Qt::darkBlue );
      QColor DefaultRot2( Qt::cyan );
      mRotColor1 = cfg->readColorEntry( "Rotator Color 1", &DefaultRot1 );
      mRotColor2 = cfg->readColorEntry( "Rotator Color 2", &DefaultRot2 );

      mRotSpeed = cfg->readNumEntry( "Rotator Speed", 30 );
      mWndTitle = cfg->readEntry( "Window Title", i18n("Please wait...") );
      mLogoFile = cfg->readEntry( "Logo File", QString::null );
    }

### `rotwidget.h` listing

    #ifndef         __ROTWIDGET_H__
    #define         __ROTWIDGET_H__

    #include <qlabel.h>
    #include <qtimer.h>
    #include <qwidget.h>

    #include <kdialogbase.h>
    #include <kpixmap.h>

    /**
     * @short Display a rotating-gradient widget.
     */
    class         RotWidget: public QWidget
    {
      Q_OBJECT
    public:
      RotWidget( QWidget *, const QColor&, const QColor&, int );
      ~RotWidget();

    private slots:
      void stepEvent();

    protected:
      void        preparePixmap( int );
      void        paintEvent( QPaintEvent * );
      void        resizeEvent( QResizeEvent * );

      QColor m_color1, m_color2;
      int m_step, m_speed;
      QTimer *m_stepTimer;

      QList<KPixmap> m_stepPixmap;
    };

    #endif

### `rotwidget.cpp` listing

    #include <kdebug.h>
    #include <kdialogbase.h>
    #include <kpixmapeffect.h>

    #include <qlabel.h>
    #include <qpainter.h>
    #include <qwidget.h>

    #include "rotwidget.h"
    #include "rotwidget.moc"

    RotWidget::RotWidget( QWidget *parent, const QColor& c1, const QColor& c2, int sp )
        :QWidget(parent), m_color1(c1), m_color2(c2), m_step(0), m_speed(sp)
    {
      if( (m_speed <= 0) || (m_speed > 20) )
        m_speed = 1;
      setFixedHeight( 6 );

      for( int i = 0; i <= width(); i++ )
        preparePixmap( i );

      m_stepTimer = new QTimer( this );
      connect(m_stepTimer, SIGNAL(timeout()), this, SLOT(stepEvent()));
      m_stepTimer->start( 50 );
    }

    RotWidget::~RotWidget()
    {
    }

    void RotWidget::stepEvent()
    {
      // This is inefficient as we create too many pixmaps, optimize later.
      m_step += m_speed;
      if( m_step > width() )
        m_step = 0;
      repaint( true );
    }

    // Todo: Optimize drawing.
    void RotWidget::paintEvent( QPaintEvent *pe )
    {
      QPainter p;
      p.begin( this );

      QRect r = pe->rect();

      if( m_stepPixmap.at( m_step ) )
        bitBlt( this, r.x(), r.y(), m_stepPixmap.at( m_step ), r.x(), r.y(), r.width(), r.height() );
      else
        p.fillRect( rect(), Qt::black );
      p.end();
    }

    void RotWidget::resizeEvent( QResizeEvent *re )
    {
      m_stepPixmap.clear();
      for( int i = 0; i <= re->size().width(); i++ )
        preparePixmap( i );
    }

    void RotWidget::preparePixmap( int step )
    {
      if( step < 0 )
        return;

      // Explicitly draw our first pixmap. The rest we will bitBlt() from here.
      if( step == 0 )
      {
        KPixmap tmp; tmp.resize( size().width() / 2, size().height() );
        KPixmap tmp2(tmp);
        KPixmapEffect::gradient( tmp, m_color1, m_color2, KPixmapEffect::HorizontalGradient );
        KPixmapEffect::gradient( tmp2, m_color2, m_color1, KPixmapEffect::HorizontalGradient );
        KPixmap *px = new KPixmap( size() );
        QPainter p;
        p.begin( px );
        p.drawPixmap( 0, 0, tmp );
        p.drawPixmap( size().width()/2, 0, tmp2 );
        p.end();
        m_stepPixmap.append( px );
      }
      else if( m_stepPixmap.at( step-1 ) )
      {
        QPixmap *prev = m_stepPixmap.at( step-1 );
        QPixmap next; next.resize( size() );
        // convert
        // prev = "[------------]"
        // to
        // next = "------------]["
        bitBlt( &next, 0, 0, prev, 1, 0, prev->width()-1, prev->height() );
        bitBlt( &next, width()-1, 0, prev, 0, 0, 1, prev->height() );
        KPixmap *n = new KPixmap( next );
        m_stepPixmap.append( n );
      }
    }

&documentation.index;