• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • tdecore
 

tdecore

  • tdecore
tdeaboutdata.h
1 /*
2  * This file is part of the KDE Libraries
3  * Copyright (C) 2000 Espen Sand (espen@kde.org)
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB. If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  *
20  */
21 
22 #include <tqvaluelist.h>
23 #include <tqstring.h>
24 #include <tqimage.h>
25 #include <tdelocale.h>
26 
27 #ifndef _TDEABOUTDATA_H_
28 #define _TDEABOUTDATA_H_
29 
30 class TDEAboutPersonPrivate;
31 class TDEAboutDataPrivate;
32 
54 class TDECORE_EXPORT TDEAboutPerson
55 {
56 public:
70  TDEAboutPerson( const char *name, const char *task,
71  const char *emailAddress, const char *webAddress )
72  {
73  mName = name;
74  mTask = task;
75  mEmailAddress = emailAddress;
76  mWebAddress = webAddress;
77  }
82  TDEAboutPerson() {}
83 
89  TQString name() const;
90 
96  TQString task() const;
97 
103  TQString emailAddress() const;
104 
110  TQString webAddress() const;
111 
112 private:
113  const char *mName;
114  const char *mTask;
115  const char *mEmailAddress;
116  const char *mWebAddress;
117 
118  TDEAboutPersonPrivate *d;
119 };
120 
121 class TDEAboutTranslatorPrivate;
134 class TDECORE_EXPORT TDEAboutTranslator
135 {
136 public:
144  TDEAboutTranslator(const TQString & name=TQString::null,
145  const TQString & emailAddress=TQString::null);
146 
152  TQString name() const;
153 
159  TQString emailAddress() const;
160 
161 private:
162  TQString mName;
163  TQString mEmail;
164  TDEAboutTranslatorPrivate* d;
165 };
166 
167 
182 class TDECORE_EXPORT TDEAboutData
183 {
184  public:
188  enum LicenseKey
189  {
190  License_Custom = -2,
191  License_File = -1,
192  License_Unknown = 0,
193  License_GPL = 1,
194  License_GPL_V2 = 1,
195  License_LGPL = 2,
196  License_LGPL_V2 = 2,
197  License_BSD = 3,
198  License_Artistic = 4,
199  License_QPL = 5,
200  License_QPL_V1_0 = 5,
201  License_GPL_V3 = 6,
202  License_LGPL_V3 = 7,
203  License_MIT = 8
204  };
205 
206  public:
241  TDEAboutData( const char *appName,
242  const char *programName,
243  const char *version,
244  const char *shortDescription = 0,
245  int licenseType = License_Unknown,
246  const char *copyrightStatement = 0,
247  const char *text = 0,
248  const char *homePageAddress = 0,
249  const char *bugsEmailAddress = 0
250  );
251 
252  ~TDEAboutData();
253 
273  void addAuthor( const char *name,
274  const char *task=0,
275  const char *emailAddress=0,
276  const char *webAddress=0 );
277 
297  void addCredit( const char *name,
298  const char *task=0,
299  const char *emailAddress=0,
300  const char *webAddress=0 );
301 
326  void setTranslator(const char* name, const char* emailAddress);
327 
343  void setLicenseText( const char *license );
344 
350  void setLicenseTextFile( const TQString &file );
351 
357  void setAppName( const char *appName );
358 
367  void setProgramName( const char* programName );
368 
378  void setProgramLogo(const TQImage& image);
379 
385  void setVersion( const char* version );
386 
394  void setShortDescription( const char *shortDescription );
395 
401  void setLicense( LicenseKey licenseKey);
402 
411  void setCopyrightStatement( const char *copyrightStatement );
412 
420  void setOtherText( const char *otherText );
421 
429  void setHomepage( const char *homepage );
430 
437  void setBugAddress( const char *bugAddress );
438 
447  void setProductName( const char *name );
448 
453  const char *appName() const;
454 
462  const char *productName() const;
463 
468  TQString programName() const;
469 
473  const char* internalProgramName() const;
477  void translateInternalProgramName() const;
478 
485  TQImage programLogo() const;
486 
491  TQString version() const;
492 
496  const char* internalVersion() const { return mVersion; }
497 
503  TQString shortDescription() const;
504 
510  TQString homepage() const;
511 
516  TQString bugAddress() const;
517 
521  const char* internalBugAddress() const { return mBugEmailAddress; }
522 
527  const TQValueList<TDEAboutPerson> authors() const;
528 
533  const TQValueList<TDEAboutPerson> credits() const;
534 
539  const TQValueList<TDEAboutTranslator> translators() const;
540 
545  static TQString aboutTranslationTeam();
546 
551  TQString otherText() const;
552 
560  TQString license() const;
561 
566  TQString copyrightStatement() const;
567 
575  TQString customAuthorPlainText() const;
576 
584  TQString customAuthorRichText() const;
585 
593  bool customAuthorTextEnabled() const;
594 
605  void setCustomAuthorText(const TQString &plainText, const TQString &richText);
606 
612  void unsetCustomAuthorText();
613 
614  private:
615  const char *mAppName;
616  const char *mProgramName;
617  const char *mVersion;
618  const char *mShortDescription;
619  int mLicenseKey;
620  const char *mCopyrightStatement;
621  const char *mOtherText;
622  const char *mHomepageAddress;
623  const char *mBugEmailAddress;
624  TQValueList<TDEAboutPerson> mAuthorList;
625  TQValueList<TDEAboutPerson> mCreditList;
626  const char *mLicenseText;
627  static const char *defaultBugTracker;
628 
629  TDEAboutDataPrivate *d;
630 };
631 
632 #endif
633 
TDEAboutData
This class is used to store information about a program.
Definition: tdeaboutdata.h:183
TDEAboutData::LicenseKey
LicenseKey
Descibes the license of the software.
Definition: tdeaboutdata.h:189
TDEAboutPerson
This structure is used to store information about a person or developer.
Definition: tdeaboutdata.h:55
TDEAboutPerson::TDEAboutPerson
TDEAboutPerson(const char *name, const char *task, const char *emailAddress, const char *webAddress)
Convenience constructor.
Definition: tdeaboutdata.h:70
TDEAboutTranslator
This structure is used to store information about a translator.
Definition: tdeaboutdata.h:135
KStdAction::name
const char * name(StdAction id)
tdelocale.h

tdecore

Skip menu "tdecore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

tdecore

Skip menu "tdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdecore by doxygen 1.9.1
This website is maintained by Timothy Pearson.