# Podręcznik &ksplash;

&Teemu.Rytilahti; &Teemu.Rytilahti.mail;
&Brian.C.Ledbetter; &Brian.C.Ledbetter.mail;
&Ravikiran.Rajagopal; &Ravikiran.Rajagopal.mail;
Krzysztof
Woźniak

    wozniakk@ceti.pl

Polskie tłumaczenie
2003
Teemu Rytilahti
2003-04
Ravikiran Rajagopal
&FDLNotice;
2003-01-10
1.01.00

Program &ksplash; wyświetla efektowny ekran powitalny pokazujący postęp uruchamiania różnych programów w środowisku &kde;.

KDE
kdebase
ksplash
ksplashml
ekran powitalny
efekty wizualne

## Wprowadzenie

&ksplash; wyświetla ekran powitalny pokazujący postęp uruchamiania programów środowiska &kde;. Wszelkie problemy i zgłaszanie nowych możliwości powinny być kierowane na listy mailingowe &kde;. Najważniejsze cechy programu &ksplash;:

- Możliwość konfiguracji za pomocą motywów
- Daje możliwość wykorzystania wtyczek w celu pełnego dopasowania do potrzeb użytkownika.
- Może z niego korzystać dowolny program dzięki mechanizmowi DCOP

Niniejszy podręcznik zawiera opis procedury tworzenia własnych tematów dla dostępnych w systemie wtyczek. Jeżeli żadna z dostępnych wtyczek nie zaspokaja potrzeb użytkownika, to możliwe jest stworzenie w języku C++ własnej wtyczki tak aby działanie &ksplash; w pełni odpowiadało jego gustom.

## Korzystanie z tematów

Aby skorzystać z tematów pobranych ze stron KDE-Look, należy je rozpakować do katalogu: `~/.kde/share/apps/ksplash/Themes/` dla pojedynczego użytkownika, lub do katalogu `$`KDEDIR`/share/apps/ksplash/Themes/` co udostępni go dla wszystkich użytkowników systemu.

Automatyczne wykonanie tych czynności możliwa jest w module Ekran powitalny w menu Wygląd i motywy w centrum sterowania &kde;.

### Korzystanie z modułu &kcontrol;

Moduł ten pozwala na instalację, testowanie i usuwanie tematów &ksplash;.

W dolnej części oka modułu, wyświetlona zostanie lista dostępnych tematów dla &ksplash;. Po wybraniu pozycji z listy, w głównej części okna wyświetlony zostanie podgląd tematu. Jeżeli wybrany już zostanie żadana pozycja, należy nacisnąć przycisk OK lub Zastosuj. Naciśnięcie Anuluj spowoduje zamknięcie okna bez akceptacji zmian, zaś naciśnięcie przycisku Domyślne przywróci standardowe ustawienia systemowe dla ekranu powitalnego.

Instalacja nowych tematów możliwa jest za pomocą przycisku Dodaj.... Pojawi się okno wyboru pliku, w którym odszukujemy pobrany plik tematu. Nie trzeba go wcześniej rozpakowywać. Instalacja nowego tematu nie spowoduje jego automatycznej aktywacji, aby tego dokonać należy nacisnąć przycisk OK lub Zastosuj.

Chociaż podgląd wybranego tematu jest widoczny w oknie konfiguracji tematów, to możliwy jest także podgląd działania tematu "na żywo" wraz z animacjami itp. Można go uruchomić wybierając temat z listy i naciskając przyciskTestuj,

Możliwe jest usuwanie niewykorzystywanych tematów za pomocą przycisku Usuń. Należy jednak pamiętać, iż zalogowany użytkownik może nie mieć uprawnień do usuwania tematów systemowych, dostępnych dla pozostałych użytkowników. Zaleca się również zachowanie tematu Domyślnego.

## Tworzenie tematów dla &ksplash;

### Informacje ogólne

Utworzenie własnego tematu dla &ksplash; jest proste. Zachęcamy wszystkich użytkowników do przesyłania własnych tematów do KDE-Look aby inni mogli z nich również skorzystać.

#### Nazwanie tematu

Użytkownik chcący stworzyć temat o nazwie `MojFajnyTemat` musi umieścić go w katalogu `MojFajnyTemat` znajdującym się w katalogu `~/.kde/apps/ksplash/Themes/`, tylko wtedy &ksplash; będzie mógł z niego korzystać. W katalogu powinien zostać utworzony plik `Theme.rc` zawierający ustawienia konfiguracyjne tematu. Dostępnych jest bardzo dużo opcji konfigurujących zachowanie tematu, rodzaj wykorzystywanej wtyczki, itp. Nie trzeba jednak ustawiać każdej dostępnej opcji, zwykle mają one pewne wartości domyślne. Zasady wprowadzania parametrów w pliku `Theme.rc` mają prostą postać: `[opcja] = [wartość]`. Poniżej opisane zostaną dostępne opcje konfiguracyjne tematów.

##### Przykład pliku `Theme.rc`

    [KSplash Theme: MojFajnyTemat]
    Name = MojFajnyTemat
    Description = Fajny temat korzystajacy z silnika XpLike
    Version = 1.0
    Author = Imie i nazwisko <adresemail@mail.com>
    ## Korzystaj z silnika XpLike.
    Engine = XpLike
    Show Icon = false
    Welcome Text = Uruchamianie KDE

Po wprowadzeniu nazwy, opisu i autora tematu, należy wybrać silnik tematu (nazywany także wtyczką). Następnie należy określić parametry specyficzne dla tego silnika, poprzez wprowadzenie par klucz-wartość podobnie jak w przykładzie pokazanym powyżej.

Należy się upewnić czy katalog zawierający pliki tematu(`~/.kde/apps/ksplash/Themes/MojFajnyTemat` w omawianym przykładzie) oraz jego identyfikator tematu (tutaj: `[KSplash Theme: MojFajnyTemat]`) w pliku `Theme.rc` są identyczne. W przeciwnym wypadku &ksplash; nie rozpozna tego tematu.

#### Pliki z obrazem tła

Podczas uruchamiania &ksplash; próbuje odnaleźć plik tła (jeżeli dana wtyczka go wymaga) dla bieżącej rozdzielczości ekranu. Nazwa pliku tła powinna być następująca: `Background-WWWxHHH.png`.

Przykładowo plik może nosić nazwę: `Background-1024x768`. Jeżeli program nie odnajdzie pliku tła o rozmiarach zgodnych z bieżącą rozdzielczością ekranu, nastąpi wtedy próba zmiany rozmiaru pliku oryginalnego tzn. `Background.png` lub pliku podanego w definicji tematu: `Theme.rc` i dopasowanie do bieżącej rozdzielczości. Taka zmiana zajmuje trochę czasu, dlatego też należy przygotować pliki tła dla najczęściej występujących rozdzielczości ekranu tzn: 1280x1024, 1024x768 oraz 800x600.

### Opcje dla silników tematów

#### Temat domyślny

##### Opcje tematu domyślnego

Name | Argument | Objaśnienie
Always Show Progress | [true/false] | Włącza lub wyłącza opcję pokazywania postępu uruchamiania. Wartość domyślna to: true
Label Foreground | [color] | Określa kolor tekstu znajdującego się w pasku stanu. Wartość domyślna to #FFFFFF (biały).
Icons Flashing | [true/false] | Włącza lub wyłącza migotanie ikon. Wartość domyślna to: true.

#### Temat standardowy

##### Opcje tematu standardowego

Name | Argument | Objaśnienie
Statusbar Position | [top/bottom] | Przełącza pozycję paska stanu. Wartość domyślna to dół ekranu (bottom).
Statusbar Visible | [true/false] | Włącza lub wyłącza wyświetlanie paska stanu. Wartość domyślna to: true.
Progress Visible | [true/false] | Włącza lub wyłącza opcję pokazywania postępu uruchamiania. Wartość domyślna to: true
Statusbar Font | [fontname] | Określa nazwę czcionki stosowanej w pasku stanu. Wartość domyślna to: Helvetica.
Statusbar Font Size | [size] | Wielkość czcionki dla tekstu paska stanu. Wartość domyślna to 16.
Statusbar Font Bold | [true/false] | Włącza pogrubienie czcionki w pasku stanu. Wartość domyślna to: true.
Statusbar Font Italic | [true/false] | Włącza pochylenie czcionki w pasku stanu. Wartość domyślna to: false.
Statusbar Foreground | [color] | Określa kolor tekstu w pasku stanu. Wartość domyślna to: white (biały).
Statusbar Background | [color] | Określa kolor tła dla paska stanu. Wartość domyślna to: black (czarny).
Statusbar Icon | [true/false] | Włącza wyświetlanie ikony dla paska stanu.
Icons Visible | [true/false] | Włącza lub wyłącza pokazywanie ikon. Wartość domyślna to: true.
Icons Jumping | [true/false] | Włącza lub wyłącza podskakiwanie ikon. Wartość domyślna to: true.
Icon Position | [0-3,10-13] | Pozycja wyświetlania ikon. Wartość domyślna to: bottom-left (w dolnej lewej części ekranu)
Splash Screen | [name] | Zmienia wyświetlany na ekranie powitalnym obrazek.

#### Temat Redmond

##### Opcje dla tematu Redmond

Name | Argument | Objaśnienie
Background Image | [filename] | Pozwala na określenie przez użytkownika własnego obrazu tła.
User Icon | [Iconname] | Nazwa standardowego zestawu wyświetlanych ikon. Wartością domyślną jest zestaw `go`.
Welcome Text | [text] | Napis wyświetlany na ekranie powitalny. Wartość domyślna to: "Welcome".
Username Text | [text] | Tekst wyświetlany zamiast rzeczywistej nazwy użytkownika.
Welcome Text Position | [x,y] | Pozycja wyświetlania tekstu powitalnego na ekranie.
Username Text Position | [x,y] | Pozycja wyświetlania nazwy użytkownika na ekranie.
Action Text Position | [x,y] | Pozycja wyświetlania bieżącej akcji na ekranie.
Icon Position | [x,y] | Pozycja wyświetlania ikony użytkownika na ekranie.
Show Welcome Text | [true/false] | Włącza lub wyłącza wyświetlanie tekstu powitalnego. Wartość domyślna to: true.
Show Welcome Shadow | [true/false] | Włącza wyświetlanie cienia dla tekstu powitalnego. Wartość domyślna to: true.
Show Username | [true/false] | Włącza wyświetlanie nazwy użytkownika. Wartość domyślna to: true.
Show Action | [true/false] | Włącza lub wyłącza wyświetlanie aktualnie wykonywanej czynności. Wartość domyślna to: true.
Show Icon | [true/false] | Włącza lub wyłącza wyświetlanie ikon. Wartość domyślna to: true.
Use KDM User Icon | [true/false] | Wyświetla ikonę logowania użytkownika. Wartość domyślna to: true.

#### Temat MacX

##### Opcje dla tematu MacX

Name | Argument | Objaśnienie
Icon Size Minimum | [size] | Ustawia minimalny rozmiar ikon. Wartość domyślna to: 16.
Icon Size Maximum | [size] | Ustawia maksymalny rozmiar ikon. Wartość domyślna to: 84.
Optimized Icon Rendering | [true/false] | Włącza optymalizację wyświetlania ikon. Wartość domyślna to: true.
Progress Bar Visible | [true/false] | Wartość domyślna to: true.
Progress Bar Position | [top/bottom] | Określa położenie paska postępu. Wartość domyślna to: bottom (dół ekranu).
Icons Jumping | [true/false] | Włącza lub wyłącza podskakiwanie ikon. Wartość domyślna to: false.

#### Temat MacClassic

##### Opcje dla tematu MacClassic

Name | Argument | Objaśnienie
Icon Position | [0-3,10-13] | Miejsce wyświetlania ikon na ekranie. Wartością domyślną jest: bottom left (lewy dół).
Icons Jumping | [true/false] | Włącza lub wyłącza podskakiwanie ikon. Wartość domyślna to: false.
Icons Visible | [true/false] | Włącza lub wyłącza pokazywanie ikon. Wartość domyślna to: true.
Splash Screen | [name] | Zmienia wyświetlany na ekranie powitalnym obrazek.

#### Temat 2k

##### Opcje dla tematu 2k

Name | Argument | Objaśnienie
Title Background Color | [color] | Kolor tła dla tytułu. Wartość domyślna to: dark blue (ciemno niebieski).
Title Foreground Color | [color] | Kolor tekstu tytułu. Wartość domyślna to: white (biały).
Status Text Color | [color] | Kolor tekstu stanu. Wartością domyślną jest kolor tła dla tekstu tytułu.
Rotator Color 1 | [color] | Określa kolor wiatraka 1. Wartość domyślna to kolor ciemno niebieski (dark blue).
Rotator Color 2 | [color] | Określa kolor wiatraka 2. Wartość domyślna to kolor modry (cyan).
Rotator Speed | [value] | Szybkość obrotu wiatraka. Wartość domyślna to 30.
Window Title | [text] | określa tekst wyświetlany w tytule okna.
Logo File | [filename] | Określa plik z obrazem do wyświetlenia.

## Wykorzystanie &ksplash; w programach użytkownika.

W tym rozdziale opisany jest sposób wykorzystania &ksplash; w programach tworzonych przez użytkownika. Jeżeli czytelnik nie tworzy programów dla środowiska &kde;, to może pominąć tą część.

### Podstawowe wymagania

Tworzona aplikacja &kde; musi wykorzystywać mechanizm &DCOP; tzn. technologię komunikacji pomiędzy programami w środowisku &kde;. W przypadku wykorzystania szkieletu aplikacji &kde; dzieje się to automatycznie. Więcej informacji dotyczących &DCOP; i innych technologii środowiska &kde; dostępnych jest na stronach dla programistów i twórców &kde;.

### Uruchamianie &ksplash;

Zanim program użytkownika rozpocznie pracę obciążającą procesor lub przed rozpoczęciem jej ładowania itp. należy wywołać &ksplash; w sposób następujący:

    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.
    }

W przykładzie przyjęto założenie, iż uruchomione zostało tylko jedno wystąpienie programu &ksplash;. Inne przypadki są bardziej złożone, a ich opis dostępny jest w dokumentacji mechanizmu &DCOP;.

### Wyświetlanie komunikatów

Zanim wyświetlone zostaną jakiekolwiek komunikaty, należy określić ilość wyświetlanych etapów (kroków) uruchamiania. Na przykład procedura uruchamiania środowiska &kde; zawiera 7 kroków.

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

Zawsze gdy należy wyświetlić wiadomość (z ikoną lub bez) należy wywołać funkcję

    arg << QString("iconName") << QString("programName") <<
    QString("Some description");
        if (!(c->send(KSplashName, "KSplashIface",
    "programStarted(QString,QString,QString)", data))
        {
          // Some error processing here.
        }

Każde wywołanie funkcji `programStarted`, zwiększa licznik kroków uruchamiania. Jeżeli program skończy się uruchamiać to poniższy kod zamyka ekran powitalny:

    if (!(c->send(KSplashName, "KSplashIface", "startupComplete()", data))
        {
          // obsługa błędów.
        }

To wszystko !. Nic już więcej nie trzeba robić, aby skorzystać z możliwości, które oferuje program &ksplash;.

## Tworzenie wtyczek dla programu &ksplash;

Tworzenie nowych wtyczek dla programu &ksplash; jest stosunkowo proste. W tym rozdziale, pokazana zostanie procedura tworzenia prostej wtyczki, która będzie naśladować ekran powitalny pewnego dobrze znanego systemu operacyjnego. Dla zrozumienia zawartości tego rozdziału użytkownik powinien znać podstawy języka C++ oraz zasady budowy aplikacji dla KDE/Qt.

### Podstawowe wymagania

Utworzona zostanie wtyczka o nazwie `2k`. Nazwa wtyczki wykorzystywana jest w wielu różnych miejscach, i ważne jest aby była konsekwentnie używana aby mogła zostać rozpoznana przez &ksplash;. Wtyczki &ksplash; są dynamicznie ładowanymi bibliotekami, których powinny być nazwane zgodnie z poniższą konwencją:

- Biblioteka powinna mieś nazwę `ksplash+nazwa_wtyczki_małymi_literami`. W opisywanym przykładzie, będzie to nazwa `ksplash2k`.
- Oprócz biblioteki, powinien istnieć odpowiadający jej plik desktop o nazwie `ksplash+nazwa_wtyczki_małymi_literami.desktop`. W opisywanym przykładzie, będzie to `ksplash2k.desktop`.
- Obiekt zwracanym przez bibliotekę, powinien być klasą o nazwie `Theme+nazwa_tematu`. Tutaj będzie to `Theme2k`.

Jeżeli powyższe informacje wydają się niezrozumiałe, to nie należy się tym martwić. W dalszej części zostanie przedstawione więcej szczegółów na ten temat. Kolejnym istotnym wymaganiem jest to, aby klasa nowej wtyczki była potomna wobec klasy `ThemeEngine`.

### Tworzenie szkieletu programu

Ponieważ wykorzystany zostanie standardowy szablon aplikacji &kde;, nie będzie konieczne tworzenie kodu uzależnionego od platformy sprzętowej, na której program będzie uruchamiany. Aby skorzystać z szablonu należy zainstalować pakiet `kdesdk`. Utworzenie szkieletu programu sprowadza się do uruchomienie polecenia `kapptemplate`, które utworzy główny katalog programu "2k" wraz z pewnymi typowymi plikami jak np. AUTHORS, itp. Najważniejsza część programu znajdzie się w podkatalogu `2k`. Należy przejść do niego oraz wykasować wszystkie znajdujące się tam pliki. W tym momencie szkielet aplikacji jest już gotowy.

Następnym krokiem jest utworzenie pliku `.desktop`, którego celem jest informowanie programu &ksplash; o dostępności tworzonej wtyczki. Należy stosować konsekwencję nazywania plików opisaną w poprzedniej części i utworzyć plik o nazwie `ksplash2k.desktop` w odpowiednim katalogu. Powinien mieć on następującą zawartość:

    [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

Parametry `Encoding`, `Type`, `Comment` oraz `ServiceTypes` są takie same jak we wszystkich innych wtyczkach. Nazwa wtyczki i nazwa biblioteki musi być zgodna z omawianą wcześniej konwencją nazewniczą. Parametr `X-KSplash-Default` zawiera wartość true lub false (prawda lub fałsz) określając czy wtyczka będzie widoczna w oknie modułu konfiguracji wtyczek. Poza bardzo wyjątkowymi sytuacjami, parametr ten powinien mieć wartość `true`.

### Deklaracja klasy: plugin

Po zakończeniu prac przygotowawczych, należy przejść do najciekawszej części - stworzenia klasy z programem określającym wymagane przez użytkownika zachowanie. Mimo tego, iż użytkownik może nakazać programowi wykonanie dowolnych czynności, to powinien pamiętać o kilku ograniczeniach.

1. Klasa Plugin musi dziedziczyć klasę `ThemeEngine`.

2. Wtyczka musi być nazwana zgodnie z zasadą: `Theme+Nazwa_Wtyczki`.

3. Klasa powinna zawierać definicję statycznej funkcji typu o nazwie `names` zwracającej listę nazw używanych do uruchamiania wtyczki.

4. Jeżeli wtyczka ma być konfigurowana w module centrum sterowania, to kod programu powinien zawierać zdefiniowaną klasę bazującą na klasie `ThemeEngineConfig` umożliwiającą konfigurację wtyczki.

5. Aby wtyczka mogła funkcjonować, to jej klasa musi zawierać definicję - zastąpienie - co najmniej jednej z następujących funkcji wirtualnych: `slotSetText`, `slotSetPixmap`, `slotUpdateProgress` lub `slotUpdateSteps`.

6. Konstruktor powinien być następujący `ThemeEngine( QWidget *parent, const char *name, const QStringList &args )` tak aby mógł być wykorzystany przez klasę `KGenericFactory`.

Ostatnie wymaganie może wydawać się skomplikowane, jednak jak okaże się to poniżej, poprzez dodanie jednego wiersza to kodu programu, można go praktycznie zignorować.

### Kod dla pliku nagłówkowego

Poniżej przedstawiono zawartość pliku nagłówkowego `theme2k.h` uwzględniającego powyższe wymagania:

#### Zawartość pliku `theme2k.h`

    #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

Analizując zawartość powyższego kodu programu zauważyć można następujące elementy. Klasa `Theme2k` została nazwana zgodnie z omawianą wcześniej konwencją nazewniczą, jest potomna względem klasy `ThemeEngine`. Zawiera ona metodę `Theme2k::names()` oraz konstruktor obsługujący wymagane parametry wtyczki: `Theme2k( QWidget *, const char *, const QStringList& );` dodatkowo zdefiniowana została metoda `Theme2k::slotSetText()`.Na razie nie należy zwracać uwagi na klasę `RotWidget`, która udostępnia obsługę miłych dla oka elementów interfejsu użytkownika. Omawiana w przykładzie wtyczka jest bardzo prosta, nie wyświetla ona żadnych ikon czy też paska postępu. Jeżeli użytkownik chciałby wyświetlać ikony, to powinien zdefiniować funkcję `slotSetPixmap`. Istnieją również funkcje określające rozmiar - ilość kroków - paska postępu (`slotUpdateSteps`) oraz zwiększające pozycję na pasku (`slotUpdateProgress`) o jeden krok.

### Kod implementacji wtyczki

Omówione zostały tylko najważniejsze części implementacji. Pełny kod programu dostępny jest w załączniku. Pierwszą częścią jest zadeklarowanie wymaganych bibliotek:

#### Wymagane biblioteki

    K_EXPORT_COMPONENT_FACTORY( ksplash2k, KGenericFactory<Theme2k> );

Makro `K_EXPORT_COMPONENT_FACTORY` jest zdefiniowane w pliku `kgenericfactory.h`. Kontynuując, ponieważ jest to bardzo prosta wtyczka, to konstruktor klasy jest bardzo prosty.

#### Konstruktor wtyczki

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

Metoda `readSettings()` pokazuje właściwy sposób odczytywania ustawień tematu. (Jest to niezbędne gdy chcemy aby inni użytkownicy korzystali z tworzonej wtyczki przy tworzeniu własnych tematów)

#### Odczyt opcji konfiguracji tematu

    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 );
    }

Ponieważ należy dbać o użytkownika, ważne jest aby dopasować rozsądne wartości domyślne dla parametrów nie zdefiniowanych w pliku tematu. Należy pamiętać, aby zawsze ustawić grupę na "KSplash Theme: nazwa_tematu" aby zachować zgodność z przyszłymi możliwymi specyfikacjami tematów. Metoda `initUI()` nie jest zbyt interesująca, ponieważ jedynie tworzy elementy kontrolne interfejsu użytkownika. Więcej na ten temat w załączniku.

### Kompilacja wtyczki

Ponieważ do kompilacji wtyczki wykorzystywane jest środowisko programistyczne &kde; to niezbędne jest utworzenie pliku `Makefile.am`. Powinien on wyglądać tak:

#### Zawartość pliku `Makefile.am`

    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

Więcej informacji dotyczących tworzenia plików `Makefile.am` dla programów środowiska &kde; znajduje się na stronach deweloperów &kde;. Jedyną rzeczą o której należy pamiętać jest utworzenie domyślnego tematu bazującego na utworzonej wtyczce wraz z odpowiednim obrazkiem podglądu. W dobrym tonie jest również przygotowanie przykładowego pliku `Theme.rc` zawierającego komentarze ilustrujące działanie różnorodnych opcji konfiguracyjnych.

## Pytania i odpowiedzi

&reporting.bugs; &updating.documentation;

Dlaczego nie mogę znaleźć żadnych tematów pracujących z &ksplash;?

Prawdopodobnie nie zainstalowano właściwych wtyczek. Są one dostępne w pakiecie `kde-artwork`. Należy go pobrać, zainstalować i spróbować ponownie.

Do czego służy plik `Theme.rc` i jak można go utworzyć?

Plik `Theme.rc` zawiera ustawienia tematu. Więcej informacji dotyczących konfiguracji tematów zawiera część Tworzenie tematów dla &ksplash;.

## Zasługi i licencje

&ksplash;

Prawa autorskie do programu © 2003 &Ravikiran.Rajagopal; &Ravikiran.Rajagopal.mail;

### Współtwórcy

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

Prawa autorskie do dokumentacji © 2003 &Teemu.Rytilahti; &Teemu.Rytilahti.mail;

&underFDL; &underGPL;

## Instalacja

### Wymagania

Do poprawnego działania &ksplash; wymagane jest środowieko &kde; w wersji 3.2 lub wyższej. Niektóre tematy mogą wymagać specjalnych wtyczek, jeżeli dany temat nie działa, to należy się skontaktować z jego autorem i zorientować się gdzie można pozyskać właściwą wtyczkę.

### Kompilacja i instalacja

&install.compile.documentation;

## Kod źródłowy

### Zawartość pliku `theme2k.cpp`

    #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 );
    }

### Zawartość pliku `rotwidget.h`

    #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

### Zawartość pliku `rotwidget.cpp`

    #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;