/data/gitorious.org/libyui/libyui-master/src/YDialog.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 GmbH |
\----------------------------------------------------------------------/

  File:         YDialog.h

  Author:       Stefan Hundhammer <sh@suse.de>

/-*/


#ifndef YDialog_h
#define YDialog_h

#include "YSingleChildContainerWidget.h"
#include <stack>

class YShortcutManager;
class YPushButton;
class YDialogPrivate;
class YEvent;
class YEventFilter;

// See YTypes.h for enum YDialogType and enum YDialogColorMode


class YDialog : public YSingleChildContainerWidget
{
protected:
    YDialog( YDialogType        dialogType,
             YDialogColorMode   colorMode = YDialogNormalColor );

    virtual ~YDialog();

public:
    virtual const char * widgetClass() const { return "YDialog"; }

    void open();

    bool isOpen() const;

    YEvent * waitForEvent( int timeout_millisec = 0 );

    YEvent * pollEvent();

    bool isTopmostDialog() const;

    bool destroy( bool doThrow = true );

    static bool deleteTopmostDialog( bool doThrow = true );

    static void deleteAllDialogs();

    static void deleteTo( YDialog * dialog );

    static int openDialogsCount();

    static YDialog * currentDialog( bool doThrow = true );

    static YDialog * topmostDialog( bool doThrow = true )
        { return currentDialog( doThrow ); }

    void setInitialSize();

    void recalcLayout();

    YDialogType dialogType() const;

    bool isMainDialog();

    YDialogColorMode colorMode() const;

    void checkShortcuts( bool force = false );

    void postponeShortcutCheck();

    bool shortcutCheckPostponed() const;

    YPushButton * defaultButton() const;

    void deleteEvent( YEvent * event );

    void addEventFilter( YEventFilter * eventFilter );

    void removeEventFilter( YEventFilter * eventFilter );

    virtual void highlight( YWidget * child ) {}

    virtual void setDefaultButton( YPushButton * defaultButton );

    virtual void activate() = 0;

    static void showText( const string & text, bool richText = false );

    static bool showHelpText( YWidget * widget );


protected:

    virtual void openInternal() = 0;

    virtual YEvent * waitForEventInternal( int timeout_millisec ) = 0;

    virtual YEvent * pollEventInternal() = 0;

    YEvent * filterInvalidEvents( YEvent * event );

    YEvent * callEventFilters( YEvent * event );

    void deleteEventFilters();

    static std::stack<YDialog *> _dialogStack;

private:

    ImplPtr<YDialogPrivate> priv;
};


#endif // YDialog_h