tdeapplication.h

/* This file is part of the KDE libraries
    Copyright (C) 1997 Matthias Kalle Dalheimer (kalle@kde.org)
    Copyright (c) 1998, 1999 KDE Team
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
 
#ifndef _TDEAPP_H
#define _TDEAPP_H
 
// Version macros. Never put this further down.
#include "tdeversion.h"
#include "tdelibs_export.h"
 
class TDEConfig;
class KCharsets;
class DCOPClient;
class DCOPObject;
 
typedef unsigned long Atom;
#if !defined(TQ_WS_X11)
typedef void Display;
#endif
 
#include <tqapplication.h>
#include <tqpixmap.h>
#include <tdeinstance.h>
 
struct _IceConn;
class TQPopupMenu;
class TQStrList;
class KSessionManaged;
class TDEStyle;
class KURL;
 
#define kapp TDEApplication::kApplication()
 
class TDEApplicationPrivate;

class TDECORE_EXPORT TDEApplication : public TQApplication, public TDEInstance
{
 
  TQ_OBJECT
public:
  enum CaptionLayout {
    CaptionAppLast=1 , 
    CaptionAppFirst  , 
    CaptionNoApp  
  };

  TDEApplication( bool allowStyles=true, bool GUIenabled=true, bool SMenabled=true);
 
#ifdef Q_QDOC
#else // Q_QDOC
#ifdef TDEAPPLICATION_BINARY_COMPAT_HACK
  // FIXME
  // FOR BINARY COMPATIBILITY ONLY
  // REMOVE WHEN PRACTICAL!
  TDEApplication( bool allowStyles=true, bool GUIenabled=true);
#endif // TDEAPPLICATION_BINARY_COMPAT_HACK
#endif // Q_QDOC
 
#ifdef TQ_WS_X11
  TDEApplication(Display *display, bool allowStyles);

  TDEApplication(Display *display, bool disable_argb, TQt::HANDLE visual, TQt::HANDLE colormap, bool allowStyles);

  TDEApplication(Display *display, TQt::HANDLE visual = 0, TQt::HANDLE colormap = 0,
               bool allowStyles=true);

  TDEApplication(Display *display, int& argc, char** argv, const TQCString& rAppName,
               bool allowStyles=true, bool GUIenabled=true);
#endif

  // REMOVE FOR KDE 4.0 - using it only gives crashing applications because
  // TDECmdLineArgs::init isn't called
  TDEApplication(int& argc, char** argv,
              const TQCString& rAppName, bool allowStyles=true, bool GUIenabled=true, bool SMenabled=true) TDE_DEPRECATED;
 
#ifdef Q_QDOC
#else // Q_QDOC
#ifdef TDEAPPLICATION_BINARY_COMPAT_HACK
  // FIXME
  // FOR BINARY COMPATIBILITY ONLY
  // REMOVE WHEN PRACTICAL!
  TDEApplication(int& argc, char** argv,
              const TQCString& rAppName, bool allowStyles, bool GUIenabled) TDE_DEPRECATED;
#endif // TDEAPPLICATION_BINARY_COMPAT_HACK
#endif // Q_QDOC

  static void addCmdLineOptions();
 
  virtual ~TDEApplication();

  static TDEApplication* kApplication() { return KApp; }

  TDEConfig* sessionConfig();

  bool isRestored() const { return TQApplication::isSessionRestored(); }

  void disableSessionManagement();

  void enableSessionManagement();

  enum ShutdownConfirm {
    ShutdownConfirmDefault = -1,
    ShutdownConfirmNo = 0,
    ShutdownConfirmYes = 1
  };

  enum ShutdownType {
    ShutdownTypeDefault = -1,
    ShutdownTypeNone = 0,
    ShutdownTypeReboot = 1,
    ShutdownTypeHalt = 2
  };

  enum ShutdownMode {
    ShutdownModeDefault = -1,
    ShutdownModeSchedule = 0,
    ShutdownModeTryNow = 1,
    ShutdownModeForceNow = 2,
    ShutdownModeInteractive = 3
  };

  bool requestShutDown( ShutdownConfirm confirm = ShutdownConfirmDefault,
                        ShutdownType sdtype = ShutdownTypeDefault,
            ShutdownMode sdmode = ShutdownModeDefault );

    void propagateSessionManager();

  void commitData( TQSessionManager& sm );

  void saveState( TQSessionManager& sm );

  bool sessionSaving() const;

  static DCOPClient *dcopClient();

  static void disableAutoDcopRegistration();

  TQPixmap icon() const;

  TQString iconName() const;

  TQPixmap miniIcon() const;

  TQString miniIconName() const;

  void setTopWidget( TQWidget *topWidget );

  void invokeHelp( const TQString& anchor,
                   const TQString& appname,
                   const TQCString& startup_id ) const;
 
  // KDE4 merge with above with startup_id = ""
  void invokeHelp( const TQString& anchor = TQString::null,
                   const TQString& appname = TQString::null ) const;

  void invokeHTMLHelp( const TQString& aFilename, const TQString& aTopic = TQString::null ) const TDE_DEPRECATED;

  void invokeMailer( const TQString &address, const TQString &subject, const TQCString& startup_id );
  // KDE4 merge with above with startup_id = ""
  void invokeMailer( const TQString &address, const TQString &subject );

  void invokeMailer( const KURL &mailtoURL, const TQCString& startup_id, bool allowAttachments );
  // KDE4 merge with above with allowAttachments = false
  void invokeMailer( const KURL &mailtoURL, const TQCString& startup_id );
  // KDE4 merge with above with startup_id = ""
  void invokeMailer( const KURL &mailtoURL );

  void invokeMailer(const TQString &to, const TQString &cc, const TQString &bcc,
                    const TQString &subject, const TQString &body,
                    const TQString &messageFile, const TQStringList &attachURLs,
                    const TQCString& startup_id );
  // KDE4 merge with above with startup_id = ""
  void invokeMailer(const TQString &to, const TQString &cc, const TQString &bcc,
                    const TQString &subject, const TQString &body,
                    const TQString &messageFile = TQString::null, const TQStringList &attachURLs = TQStringList());
 
public slots:
  void invokeBrowser( const TQString &url, const TQCString& startup_id );
  // KDE4 merge with above with startup_id = ""
  void invokeBrowser( const TQString &url );

  void cut();

  void copy();

  void paste();

  void clear();

  void selectAll();

  void broadcastKeyCode(unsigned int keyCode);
 
public:
  static TQCString launcher();

  static int startServiceByName( const TQString& _name, const TQString &URL,
                TQString *error=0, TQCString *dcopService=0, int *pid=0, const TQCString &startup_id = "", bool noWait = false );

  static int startServiceByName( const TQString& _name, const TQStringList &URLs=TQStringList(),
                TQString *error=0, TQCString *dcopService=0, int *pid=0, const TQCString &startup_id = "", bool noWait = false );

  static int startServiceByDesktopPath( const TQString& _name, const TQString &URL,
                TQString *error=0, TQCString *dcopService=0, int *pid = 0, const TQCString &startup_id = "", bool noWait = false );

  static int startServiceByDesktopPath( const TQString& _name, const TQStringList &URLs=TQStringList(),
                TQString *error=0, TQCString *dcopService=0, int *pid = 0, const TQCString &startup_id = "", bool noWait = false );

  static int startServiceByDesktopName( const TQString& _name, const TQString &URL,
                TQString *error=0, TQCString *dcopService=0, int *pid = 0, const TQCString &startup_id = "", bool noWait = false );

  static int startServiceByDesktopName( const TQString& _name, const TQStringList &URLs=TQStringList(),
                TQString *error=0, TQCString *dcopService=0, int *pid = 0, const TQCString &startup_id = "", bool noWait = false );

  static int tdeinitExec( const TQString& name, const TQStringList &args,
                TQString *error, int *pid, const TQCString& startup_id );
  // KDE4 merge with above with startup_id = ""
  static int tdeinitExec( const TQString& name, const TQStringList &args=TQStringList(),
                TQString *error=0, int *pid = 0 );

  static int tdeinitExecWait( const TQString& name, const TQStringList &args,
                TQString *error, int *pid, const TQCString& startup_id );
  // KDE4 merge with above with startup_id = ""
  static int tdeinitExecWait( const TQString& name, const TQStringList &args=TQStringList(),
                TQString *error=0, int *pid = 0 );

  TQString caption() const;

  TDE_DEPRECATED TDEStyle* tdestyle() const { return 0; }

  TQString makeStdCaption( const TQString &userCaption,
                          bool withAppName=true, bool modified=false ) const;

  TQString tempSaveName( const TQString& pFilename ) const;

  TQString checkRecoverFile( const TQString& pFilename, bool& bRecover ) const;
 
#if defined(TQ_WS_X11)
   Display *getDisplay() { return display; }
#endif

   void getX11RGBAInformation(Display *dpy);

   static bool isCompositionManagerAvailable();

   bool detectCompositionManagerAvailable(bool force_available=false, bool available=true);

   static Display* openX11RGBADisplay();

   TQt::HANDLE getX11RGBAVisual(Display *dpy);

   TQt::HANDLE getX11RGBAColormap(Display *dpy);

   bool isX11CompositionAvailable();

  void enableStyles();

  void disableStyles();

  void installX11EventFilter( TQWidget* filter );

  void removeX11EventFilter( const TQWidget* filter );

  static int random();

  static TQString randomString(int length);

  void addKipcEventMask(int id);

  void removeKipcEventMask(int id);

  TQCString startupId() const;

  void setStartupId( const TQCString& startup_id );

  void updateUserTimestamp( unsigned long time = 0 );
  
  unsigned long userTimestamp() const;

  void updateRemoteUserTimestamp( const TQCString& dcopId, unsigned long time = 0 );
  
  TQString geometryArgument() const;

  void installKDEPropertyMap();

  bool authorize(const TQString &genericAction);

  bool authorizeTDEAction(const char *action);

  bool authorizeURLAction(const TQString &action, const KURL &baseURL, const KURL &destURL);

  void allowURLAction(const TQString &action, const KURL &_baseURL, const KURL &_destURL);

  bool authorizeControlModule(const TQString &menuId);
  
  TQStringList authorizeControlModules(const TQStringList &menuIds);

  static ButtonState keyboardMouseState();
 
  // Same values as ShiftMask etc. in X.h
  enum { ShiftModifier = 1<<0,
         LockModifier = 1<<1,
         ControlModifier = 1<<2,
         Modifier1 = 1<<3,
         Modifier2 = 1<<4,
         Modifier3 = 1<<5,
         Modifier4 = 1<<6,
         Modifier5 = 1<<7 };
  static uint keyboardModifiers() TDE_DEPRECATED;

  enum { Button1Pressed = 1<<8,
         Button2Pressed = 1<<9,
         Button3Pressed = 1<<10,
         Button4Pressed = 1<<11,
         Button5Pressed = 1<<12 };
  static uint mouseState() TDE_DEPRECATED;

  static int currentX11VT();
 
 
public slots:
  void ref();

  void deref();
 
protected:
  TDEApplication( bool allowStyles, bool GUIenabled, TDEInstance* _instance );
 
#ifdef TQ_WS_X11
  TDEApplication( Display *display, TQt::HANDLE visual, TQt::HANDLE colormap,
          bool allowStyles, TDEInstance* _instance );

  bool x11EventFilter( XEvent * );
 
  Display *display;
#endif
  Atom kipcCommAtom;
  int kipcEventMask;

  static TDEApplication *KApp;
  int pArgc;

  void invokeEditSlot( const char *slot );
 
private slots:
  void dcopFailure(const TQString &);
  void dcopBlockUserInput( bool );
  void x11FilterDestroyed();
  void checkAppStartedSlot();
 
private:
  TQString sessionConfigName() const;
  TDEConfig* pSessionConfig; //instance specific application config object
  static DCOPClient *s_DCOPClient; // app specific application communication client
  static bool s_dcopClientNeedsPostInit;
  TQString aCaption; // the name for the window title
  bool bSessionManagement;
  struct oldPixmapType { TQPixmap a, b; };
  mutable union {
    struct {
      TQPixmap *icon, *miniIcon;
    } pm;
    char unused[sizeof(oldPixmapType)];
  } aIconPixmap; // KDE4: remove me
  TQString aIconName;
  TQString aMiniIconName;
  bool useStyles;
  TQWidget *smw;
 
  void init( bool GUIenabled );
 
  void parseCommandLine( ); // Handle KDE arguments (Using TDECmdLineArgs)
 
  void read_app_startup_id();
 
  void dcopAutoRegistration();
  void dcopClientPostInit();
  void initUrlActionRestrictions();
 
  bool argb_visual;
#if defined(TQ_WS_X11)
  TQt::HANDLE argb_x11_visual;
  TQt::HANDLE argb_x11_colormap;
#endif
 
public:
  bool notify(TQObject *receiver, TQEvent *event);

  int xErrhandler( Display*, void* );

  int xioErrhandler( Display* );

  void iceIOErrorHandler( _IceConn *conn );

  static bool loadedByKdeinit;

  static void startKdeinit();

  enum SettingsCategory { SETTINGS_MOUSE, SETTINGS_COMPLETION, SETTINGS_PATHS,
         SETTINGS_POPUPMENU, SETTINGS_QT, SETTINGS_SHORTCUTS };

  static TQPalette createApplicationPalette();

  static TQPalette createApplicationPalette( TDEConfig *config, int contrast );

  static void installSigpipeHandler();

  static bool guiEnabled();
 
signals:
  void tdedisplayPaletteChanged();

  void tdedisplayStyleChanged();

  void tdedisplayFontChanged();

  void appearanceChanged();

  void toolbarAppearanceChanged(int);

  void backgroundChanged(int desk);

  void settingsChanged(int category);

  void iconChanged(int group);

  void kipcMessage(int id, int data);

  void saveYourself();

  void shutDown();

  void updateIconLoaders();

  void coreFakeKeyPress(unsigned int keyCode);
 
private:
  void propagateSettings(SettingsCategory category);
  void tdedisplaySetPalette();
  void tdedisplaySetStyle();
  void tdedisplaySetFont();
  void applyGUIStyle();
  static void sigpipeHandler(int);
 
  int captionLayout;
 
  TDEApplication(const TDEApplication&);
  TDEApplication& operator=(const TDEApplication&);
protected:
  virtual void virtual_hook( int id, void* data );
private:
  TDEApplicationPrivate* d;
};
 

TDECORE_EXPORT bool checkAccess(const TQString& pathname, int mode);
 
class KSessionManagedPrivate;

class TDECORE_EXPORT KSessionManaged
{
public:
  KSessionManaged();
  virtual ~KSessionManaged();

  virtual bool saveState( TQSessionManager& sm );
  virtual bool commitData( TQSessionManager& sm );
 
protected:
  virtual void virtual_hook( int id, void* data );
private:
  KSessionManagedPrivate *d;
};
 
 
#endif