wxWidgets/include/wx/gtk/app.h

/////////////////////////////////////////////////////////////////////////////
// Name:        app.h
// Purpose:
// Author:      Robert Roebling
// Id:          $Id$
// Copyright:   (c) 1998 Robert Roebling, Julian Smart
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef __GTKAPPH__
#define __GTKAPPH__

#ifdef __GNUG__
#pragma interface
#endif

#include "wx/defs.h"
#include "wx/window.h"
#include "wx/frame.h"

//-----------------------------------------------------------------------------
// classes
//-----------------------------------------------------------------------------

class wxApp;
class wxLog;

//-----------------------------------------------------------------------------
// global data
//-----------------------------------------------------------------------------

extern wxApp *wxTheApp;

//-----------------------------------------------------------------------------
// global functions
//-----------------------------------------------------------------------------

void wxExit(void);
bool wxYield(void);

//-----------------------------------------------------------------------------
// constants
//-----------------------------------------------------------------------------

#define wxPRINT_WINDOWS         1
#define wxPRINT_POSTSCRIPT      2

//-----------------------------------------------------------------------------
// wxApp
//-----------------------------------------------------------------------------

class wxApp: public wxEvtHandler
{
  DECLARE_DYNAMIC_CLASS(wxApp)

  public:

    wxApp();
    ~wxApp();

    static void SetInitializerFunction(wxAppInitializerFunction fn) { m_appInitFn = fn; }
    static wxAppInitializerFunction GetInitializerFunction() { return m_appInitFn; }

    /* override for altering the way wxGTK intializes the GUI (palette/visual/colorcube).
     * under wxMSW, OnInitGui() does nothing by default. when overriding this method,
     * the code in it is likely to be platform dependent, otherwise use OnInit(). */
    virtual bool OnInitGui();
    
    /* override to create top level frame, display splash screen etc. */
    virtual bool OnInit() { return FALSE; }
    
    virtual int OnRun() { return MainLoop(); }
    virtual int OnExit() { return 0; }

    wxWindow *GetTopWindow();
    void SetTopWindow( wxWindow *win );
    
    virtual int MainLoop();
    void ExitMainLoop();
    bool Initialized();
    virtual bool Pending();
    virtual void Dispatch();

    inline void SetWantDebugOutput( bool flag ) { m_wantDebugOutput = flag; }
    inline bool GetWantDebugOutput() { return m_wantDebugOutput; }

    void OnIdle( wxIdleEvent &event );
    bool SendIdleEvents();
    bool SendIdleEvents( wxWindow* win );

    inline wxString GetAppName() const 
      { if (m_appName != "") return m_appName; else return m_className; }
    inline void SetAppName( const wxString& name ) { m_appName = name; }
    
    inline wxString GetClassName() const { return m_className; }
    inline void SetClassName( const wxString& name ) { m_className = name; }
    
    const wxString& GetVendorName() const { return m_vendorName; }
    void SetVendorName( const wxString& name ) { m_vendorName = name; }

    inline void SetExitOnFrameDelete( bool flag ) { m_exitOnFrameDelete = flag; }
    inline bool GetExitOnFrameDelete() const { return m_exitOnFrameDelete; }

    void SetPrintMode( int WXUNUSED(mode) ) {}
    int GetPrintMode() const { return wxPRINT_POSTSCRIPT; }

#if wxUSE_LOG
    /* override this function to create default log target of arbitrary
     * user-defined classv (default implementation creates a wxLogGui object) */
    virtual wxLog *CreateLogTarget();
#endif // wxUSE_LOG

  // implementation 

    static bool Initialize();
    static bool InitialzeVisual();
    static void CleanUp();

    bool ProcessIdle();
#if wxUSE_THREADS
    void ProcessPendingEvents();
#endif
    void DeletePendingObjects();

    /// This can be used to suppress the generation of Idle events.
    inline void SuppressIdleEvents(bool arg = TRUE) { m_suppressIdleEvents = arg; }
    inline bool GetSuppressIdleEvents() const { return m_suppressIdleEvents; }
    
    bool            m_initialized;
    bool            m_exitOnFrameDelete;
    bool            m_wantDebugOutput;
    wxWindow       *m_topWindow;
    
    gint            m_idleTag;
#if wxUSE_THREADS
    gint            m_wakeUpTimerTag;
#endif
    unsigned char  *m_colorCube;

    int             argc;
    char          **argv;

    wxString        m_vendorName;
    wxString        m_appName;
    wxString        m_className;

    static wxAppInitializerFunction m_appInitFn;
 private:
    /// Set to TRUE while we are in wxYield().
    bool m_suppressIdleEvents;
  DECLARE_EVENT_TABLE()
};

#endif // __GTKAPPH__