/data/gitorious.org/libyui/libyui-master/src/YApplication.h

/**************************************************************************
Copyright (C) 2000 - 2010 Novell, Inc.
All Rights Reserved.

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

This program 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 General Public License for more details.

You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

**************************************************************************/



/*---------------------------------------------------------------------\
|                                                                      |
|                      __   __    ____ _____ ____                      |
|                      \ \ / /_ _/ ___|_   _|___ \                     |
|                       \ V / _` \___ \ | |   __) |                    |
|                        | | (_| |___) || |  / __/                     |
|                        |_|\__,_|____/ |_| |_____|                    |
|                                                                      |
|                               core system                            |
|                                                                      |
|                                         (c) SuSE Linux Products GmbH |
\----------------------------------------------------------------------/

  File:         YApplication.h

  Author:       Stefan Hundhammer <sh@suse.de>

/-*/

#ifndef YApplication_h

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


using std::string;

class YWidget;
class YWidgetID;
class YApplicationPrivate;


class YApplication
{
protected:

    friend class YUI;
    YApplication();

    virtual ~YApplication();

public:

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

    virtual string iconBasePath() const;

    virtual void setIconBasePath( const string & newIconBasePath );

    YIconLoader *iconLoader();

    int defaultFunctionKey( const string & label ) const;

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

    void clearDefaultFunctionKeys();

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

    string language( bool stripEncoding = false ) const;

    virtual string glyph( const string & glyphSymbolName );

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

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

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

    virtual bool openContextMenu( const YItemCollection & itemCollection );


    virtual void setProductName( const string & productName );

    string productName() 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 string & fileName ) {}

    virtual void beep() {}

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

    virtual void redrawScreen() {}

    virtual void initConsoleKeyboard() {}

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

    virtual int runInTerminal( const string & command );


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


private:

    ImplPtr<YApplicationPrivate> priv;

};

#define YApplication_h

#endif // YApplication_h