YDialog.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:     YDialog.h

  Author:   Stefan Hundhammer <shundhammer@suse.de>

/-*/


#ifndef YDialog_h
#define YDialog_h

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

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;

    void requestMultiPassLayout();

    int layoutPass() 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;


    //
    // Dialog helpers - see source file YDialogHelpers.cc
    //

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

    static bool showHelpText( YWidget * widget );

    static bool showRelNotesText();


protected:

    virtual void openInternal() = 0;

    void doLayout();

    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