Handbok KSplash

Innan ditt program börjar sitt beräkningsintensiva arbete, eller innan det börjar ladda insticksprogram, etc. starta KSplash enligt följande:

DCOPClient *c = kapp->dcopClient();
QString error;
QCString KSplashName;
int pid = 0;
QStringList args;
args << "--theme=MittFinaTema" << "--managed";
if (kapp->startServiceByDesktopName("ksplash", args, &error,
&KSplashName, &pid))
{
  KMessageBox::sorry(0, error, "Kunde inte starta Ksplash");
  // Någon felhantering här.
}

Vi antar att det bara finns en instans av KSplash som kör. Övriga fall är något mer komplicerade. Se DCOP-dokumentationen för ytterligare information.

Innan du visar några meddelanden, måste du ställa in antal steg som du ska visa. KDE:s startprocedur använder till exempel sju steg.

QByteArray data;
    QDataStream arg(data,IO_WriteOnly);
    arg << someNumber;
    if (!(c->send(KSplashName, "KSplashIface", "setStartupItemCount(int)",
data))
      // Någon felhantering här.

Så fort du vill visa ett meddelande med eller utan ikon, använd

arg << QString("ikonnamn") << QString("programnamn") <<
QString("Beskrivning");
    if (!(c->send(KSplashName, "KSplashIface",
"programStarted(QString,QString,QString)", data))
    {
      // Någon felhantering här.
    }

Varje gång du anropar programStarted, ökas antal steg som är klara. När programmet är klart med starten, gör följande för att få startskärmen att försvinna.

if (!(c->send(KSplashName, "KSplashIface", "startupComplete()", data))
    {
      // Felhantering här.
    }

Det är det hela! Du behöver ingenting mer för att dra fördel av allt som KSplash kan erbjuda.

Vi använder oss av KDE:s programramverk, som tar hand om att bygga insticksmodulen och ger oss plattformsoberoende utan något eget arbete. För att göra det, försäkra dig om att du har paketet kdesdk installerat. Kör kommandot kapptemplate för att skapa ett program som heter "2k". Då skapas en toppnivåkatalog som innehåller generella filer som AUTHORS, etc. Vi är mest intresserade av underkatalogen som heter 2k. Gå till katalogen och ta bort alla filer som finns där. Nu har vi skelettet som vi behöver.

Nästa steg är att skapa filen .desktop, som när den installeras, talar om för KSplash att vår insticksmodul är tillgänglig. För att följa namngivningskonventionerna som beskrevs i föregående sektion, skapa en fil som heter ksplash2k.desktop i katalogen. Den ska innehålla följande rader:

[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

Encoding, Type, Comment och ServiceTypes är likadana för alla insticksmoduler. Insticksmodulens namn och biblioteksnamnet följer konventionen som tidigare angavs. Raden X-KSplash-Default har ett Booleskt värde som avgör om den normalt visas i inställningscentralen. Utom för några mycket ovanliga fall, ska värdet vara sant (true).

Nu när vi har klarat av det inledande arbetet, låt oss börja med den roliga delen, att skapa en klass som tillhandahåller beteendet som vi vill ha. Även om vi har frihet att göra vad som helst med klassen, finns det vissa begränsningar.

Det sista kravet kan verka komplicerat, men som vi senare kommer att se, kan du ofta ignorera det genom att lägga till en enda rad i dina källkodsfiler.

Med dessa begränsningar, visar vi nu hur deklarationsfilen theme2k.h ser ut:

#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

Låt oss analysera listningen ovan. Klassen Theme2k följer namngivningskonventionen, och ärver från ThemeEngine. Den tillhandahåller metoden Theme2k::names(), och har en konstruktor som använder parametrar som krävs: Theme2k( QWidget *, const char *, const QStringList& ); och tillhandahåller också en enkel metod vid namn Theme2k::slotSetText(). Bekymra dig för närvarande inte om klassen RotWidget. Det är en liten grafisk komponentklass som tillhandahåller lite ögongodis åt användaren. Vår insticksmodul är mycket enkel, och visar inte några ikoner eller en förloppsrad. Om du vill visa ikoner, överskrid funktionen slotSetPixmap. Liknande funktioner finns för att ställa in förloppsradens hastighet (slotUpdateSteps) och öka nuvarande steg (slotUpdateProgress).

Vi betraktar bara relevanta delar av implementeringen. För en listning av hela implementeringen, se appendix. Det första vi gör är att få kraven på biblioteket ur världen:

K_EXPORT_COMPONENT_FACTORY( ksplash2k, KGenericFactory<Theme2k> );

Makrot K_EXPORT_COMPONENT_FACTORY deklareras i kgenericfactory.h. Låt oss fortsätta till konstruktorn! Eftersom det här är en mycket enkel insticksmodul, är konstruktorn ganska rättfram.

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

Metoden readSettings() åskådliggör det riktiga sättet att hämta temats inställningar. (Du vill väl att din insticksmodul ska användas i teman, eller hur?)

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

Eftersom vi tycker om våra användare, tillhandahåller vi passande standardvärden för parametrar som inte finns med i temafilen. Observera att vi alltid ska ange gruppen som "KSplash Theme: temanamn" för att fungera ihop med framtida specifikationer av teman. Metoden initUI() är inte särskilt intressant, eftersom den bara bygger upp de grafiska komponenterna. Se appendix för detaljinformation.

Eftersom vi bestämde oss för att använda KDE:s ramverk för att kompilera insticksmodulen, måste vi skapa filen Makefile.am. Den ska se ut så här:

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

För mer information om hur man skriver Makefile.am filer för KDE, se KDE:s hemsida för utvecklare. Det enda av intresse är att vi tillhandahåller ett förvalt tema baserat på insticksmodulen, och en förhandsgranskningsbild av det. Av hänsyn till användarna, bör du tillhandahålla ett exempel på filen Theme.rc som illustrerar användningen av de olika alternativen.