consolewidget.h

/** @file consolewidget.h  Console commandline and message history.
 *
 * @authors Copyright (c) 2013 Jaakko Keränen <jaakko.keranen@iki.fi>
 *
 * @par License
 * GPL: http://www.gnu.org/licenses/gpl.html
 *
 * <small>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, see:
 * http://www.gnu.org/licenses</small> 
 */

#ifndef DENG_CLIENT_CONSOLEWIDGET_H
#define DENG_CLIENT_CONSOLEWIDGET_H

#include <QObject>

#include "guiwidget.h"
#include "buttonwidget.h"
#include "consolecommandwidget.h"
#include "logwidget.h"

/**
 * Console command line and message history.
 *
 * ConsoleWidget expects to be bottom-left anchored. It resizes its height
 * automatically. The user can drag the right edge to resize the widget.
 *
 * @ingroup gui
 */
class ConsoleWidget : public GuiWidget
{
    Q_OBJECT

public:
    ConsoleWidget();

    ButtonWidget &button();
    ConsoleCommandWidget &commandLine();
    LogWidget &log();

    de::Rule const &shift();

    bool isLogOpen() const;

    /**
     * Enables or disables the console log background blur.
     *
     * @todo Blurring is presently forcibly disabled when a game is loaded.
     *
     * @param yes  @c true to enable blur, otherwise @c false.
     */
    void enableBlur(bool yes = true);

    // Events.
    void viewResized();
    void update();
    bool handleEvent(de::Event const &event);

public slots:
    void openLog();
    void closeLog();
    void clearLog();
    void showFullLog();
    void setFullyOpaque();
    void commandLineFocusLost();
    void focusOnCommandLine();
    void openMenu();
    void closeMenu();
    void commandWasEntered(de::String const &);

protected slots:
    void logContentHeightIncreased(int delta);

private:
    DENG2_PRIVATE(d)
};

#endif // DENG_CLIENT_CONSOLEWIDGET_H