YApplication.h

/*
  Copyright (C) 2000-2012 Novell, Inc
  This library is free software; you can redistribute it and/or modify
  it under the terms of the GNU Lesser General Public License as
  published by the Free Software Foundation; either version 2.1 of the
  License, or (at your option) version 3.0 of the License. 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 Lesser General Public
  License for more details. You should have received a copy of the GNU
  Lesser General Public License along with this library; if not, write
  to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
  Floor, Boston, MA 02110-1301 USA
*/


/*-/

  File:     YApplication.h

  Author:   Stefan Hundhammer <shundhammer@suse.de>

/-*/

#ifndef YApplication_h

#include <string>
#include <map>
#include "YUI.h"
#include "ImplPtr.h"
#include "YMenuItem.h"
#include  "YIconLoader.h"



class YWidget;
class YWidgetID;
struct YApplicationPrivate;


class YApplication
{
protected:

    friend class YUI;
    YApplication();

    virtual ~YApplication();

public:

    YWidget * findWidget( YWidgetID * id, bool doThrow = true ) const;

    virtual std::string iconBasePath() const;

    virtual void setIconBasePath( const std::string & newIconBasePath );

    YIconLoader * iconLoader();

    int defaultFunctionKey( const std::string & label ) const;

    void setDefaultFunctionKey( const std::string & label, int fkey );

    void clearDefaultFunctionKeys();

    virtual void setLanguage( const std::string & language,
                  const std::string & encoding = std::string() );

    std::string language( bool stripEncoding = false ) const;

    virtual std::string glyph( const std::string & glyphSymbolName );

    virtual std::string askForExistingDirectory( const std::string & startDir,
                                                 const std::string & headline ) = 0;

    virtual std::string askForExistingFile( const std::string & startWith,
                                            const std::string & filter,
                                            const std::string & headline ) = 0;

    virtual std::string askForSaveFileName( const std::string & startWith,
                                            const std::string & filter,
                                            const std::string & headline ) = 0;

    virtual bool openContextMenu( const YItemCollection & itemCollection );


    virtual void setProductName( const std::string & productName );

    std::string productName() const;

    void setReleaseNotes( const std::map<std::string,std::string> & relNotes );

    std::map<std::string,std::string> releaseNotes() const;

    void setShowProductLogo( bool show );

    bool showProductLogo() const;

    virtual int deviceUnits( YUIDimension dim, float layoutUnits );

    virtual float layoutUnits( YUIDimension dim, int deviceUnits );

    virtual void setReverseLayout( bool reverse );

    bool reverseLayout() const;

    virtual void busyCursor() {}

    virtual void normalCursor() {}

    virtual void makeScreenShot( const std::string & fileName ) {}

    virtual void beep() {}


    //
    // NCurses (text mode) specific
    //

    virtual void redrawScreen() {}

    virtual void initConsoleKeyboard() {}

    virtual void setConsoleFont( const std::string & console_magic,
                 const std::string & font,
                 const std::string & screen_map,
                 const std::string & unicode_map,
                 const std::string & language )
    {}

    virtual int runInTerminal( const std::string & command );



    virtual void openUI() {}
    virtual void closeUI() {}

    //
    // Display information.
    //
    // Width and height are returned in the the UI's native dimension:
    // Pixels for graphical UIs, character cells for text UIs.
    // -1 means "value cannot be obtained" for int functions.
    //
    // Derived classes are required to implement these functions.
    //

    virtual int  displayWidth()         = 0;
    virtual int  displayHeight()        = 0;
    virtual int  displayDepth()         = 0;
    virtual long displayColors()        = 0;

    // Size of main dialogs
    virtual int  defaultWidth()         = 0;
    virtual int  defaultHeight()        = 0;

    //
    // UI capabilities
    //

    virtual bool isTextMode()           = 0;
    virtual bool hasImageSupport()      = 0;
    virtual bool hasIconSupport()       = 0;
    virtual bool hasAnimationSupport()      = 0;
    virtual bool hasFullUtf8Support()       = 0;
    virtual bool richTextSupportsTable()    = 0;
    virtual bool leftHandedMouse()      = 0;
    virtual bool hasWizardDialogSupport() { return false; }


    virtual void setApplicationTitle ( const std::string& title );

    virtual const std::string& applicationTitle() const;

    virtual void setApplicationIcon ( const std::string& icon );

     virtual const std::string& applicationIcon() const;

private:

    ImplPtr<YApplicationPrivate> priv;

};

#define YApplication_h

#endif // YApplication_h