containerinterface.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 2007 Philippe Fremy (phil at freehackers dot org)
   Copyright (C) 2008 Joseph Wenninger (jowenn@kde.org)


   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

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

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef KDELIBS_KTEXTEDITOR_CONTAINER_INTERFACE_H
#define KDELIBS_KTEXTEDITOR_CONTAINER_INTERFACE_H

#include <ktexteditor/ktexteditor_export.h>

#include <QtCore/QObject>

namespace KTextEditor
{

class Document;
class View;


class KTEXTEDITOR_EXPORT ContainerInterface
{
  public:
    ContainerInterface();

    virtual ~ContainerInterface();

    virtual void setContainer( QObject * container ) = 0;

    virtual QObject * container() = 0;
}; // class ContainerInterface

class KTEXTEDITOR_EXPORT MdiContainer
{
  public:

    MdiContainer();

    virtual ~MdiContainer();

    virtual void setActiveView( View * view )=0;

    virtual View * activeView()=0;

    virtual Document * createDocument()=0;

    virtual bool closeDocument( Document * doc )=0;

    virtual View * createView( Document * doc )=0;

    virtual bool closeView( View * view )=0;
}; // class MdiContainer


class KTEXTEDITOR_EXPORT ViewBarContainer
{
  public:
    enum Position{LeftBar=0,TopBar=1,RightBar=2,BottomBar=3};
    ViewBarContainer();

    virtual ~ViewBarContainer();

    virtual QWidget* getViewBarParent(View *view,enum Position position)=0;

    virtual void addViewBarToLayout(View *view,QWidget *bar,enum Position position)=0;
    
    virtual void showViewBarForView(View *view,enum Position position)=0;
    virtual void hideViewBarForView(View *view,enum Position position)=0;

    virtual void deleteViewBarForView(View *view,enum Position position)=0;

};

} // namespace KTextEditor

Q_DECLARE_INTERFACE(KTextEditor::ContainerInterface, "org.kde.KTextEditor.ContainerInterface")
Q_DECLARE_INTERFACE(KTextEditor::MdiContainer, "org.kde.KTextEditor.MdiContainer")
Q_DECLARE_INTERFACE(KTextEditor::ViewBarContainer, "org.kde.KTextEditor.ViewBarContainer")
#endif // KDELIBS_KTEXTEDITOR_CONTAINER_EXTENSION_H