|
|
|
/* This file is part of the KDE project
|
|
|
|
Copyright (C) 2002 Anders Lund <anders.lund@lund.tdcadsl.dk>
|
|
|
|
|
|
|
|
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 _KATE_DOCKVIEW_BASE_H_
|
|
|
|
#define _KATE_DOCKVIEW_BASE_H_
|
|
|
|
|
|
|
|
#include <tqvbox.h>
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Namespace collecting as much of the internal Kate classes as we
|
|
|
|
* can manage.
|
|
|
|
*/
|
|
|
|
namespace Kate
|
|
|
|
{
|
|
|
|
|
|
|
|
/**
|
|
|
|
Base class for dockwidget views
|
|
|
|
This class creates a widget meant to be set as the main widget
|
|
|
|
for a KDockWidget.
|
|
|
|
|
|
|
|
This class provides a title in two parts, titlePrefix and title. The
|
|
|
|
size policies are set so that neither will prevent resizing the view to
|
|
|
|
a width smaller than the texts, the titlePrefix (on the left) will remain
|
|
|
|
fully visible for as long as possible.
|
|
|
|
|
|
|
|
Use the titlePrefix to describe the nature of the view contents, for
|
|
|
|
example "Messages".
|
|
|
|
|
|
|
|
Use the title to inform the user what is currently in the view,
|
|
|
|
for example the name of a related file, a command or similar.
|
|
|
|
|
|
|
|
To add widgets, just create them with this as the parent.
|
|
|
|
|
|
|
|
@author Anders Lund <anders@alweb.dk>
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
|
|
class DockViewBase : public TQVBox {
|
|
|
|
TQ_OBJECT
|
|
|
|
public:
|
|
|
|
/**
|
|
|
|
Create a KateDockViewBase.
|
|
|
|
*/
|
|
|
|
DockViewBase( TQWidget *parent=0, const char *name=0 );
|
|
|
|
|
|
|
|
/**
|
|
|
|
Create a KateDockViewBase with the title prefix @p prefix
|
|
|
|
and the title @p title.
|
|
|
|
*/
|
|
|
|
DockViewBase( const TQString &prefix, const TQString &title, TQWidget *parent=0, const char *name=0 );
|
|
|
|
|
|
|
|
~DockViewBase();
|
|
|
|
|
|
|
|
/**
|
|
|
|
Set the title prefix to @p prefix.
|
|
|
|
*/
|
|
|
|
void setTitlePrefix( const TQString &prefix );
|
|
|
|
|
|
|
|
/**
|
|
|
|
@return The title prefix.
|
|
|
|
*/
|
|
|
|
TQString titlePrefix() const;
|
|
|
|
|
|
|
|
/**
|
|
|
|
Set the title to @p title
|
|
|
|
*/
|
|
|
|
void setTitle( const TQString &title );
|
|
|
|
|
|
|
|
/**
|
|
|
|
Convenience method, sets both the prefix and title
|
|
|
|
*/
|
|
|
|
void setTitle( const TQString &prefix, const TQString &title );
|
|
|
|
|
|
|
|
/**
|
|
|
|
@return the title of the KateDockViewBase
|
|
|
|
*/
|
|
|
|
TQString title() const;
|
|
|
|
|
|
|
|
private:
|
|
|
|
/** Private initialization */
|
|
|
|
void init( const TQString &, const TQString &);
|
|
|
|
class DockViewBasePrivate *d;
|
|
|
|
};
|
|
|
|
|
|
|
|
}
|
|
|
|
|
|
|
|
#endif // _KATE_DOCKVIEW_BASE_H_
|