summaryrefslogtreecommitdiffstats
path: root/tdeui/kjanuswidget.h
diff options
context:
space:
mode:
authorTimothy Pearson <[email protected]>2011-11-06 15:56:40 -0600
committerTimothy Pearson <[email protected]>2011-11-06 15:56:40 -0600
commite16866e072f94410321d70daedbcb855ea878cac (patch)
treeee3f52eabde7da1a0e6ca845fb9c2813cf1558cf /tdeui/kjanuswidget.h
parenta58c20c1a7593631a1b50213c805507ebc16adaf (diff)
downloadtdelibs-e16866e072f94410321d70daedbcb855ea878cac.tar.gz
tdelibs-e16866e072f94410321d70daedbcb855ea878cac.zip
Actually move the kde files that were renamed in the last commit
Diffstat (limited to 'tdeui/kjanuswidget.h')
-rw-r--r--tdeui/kjanuswidget.h615
1 files changed, 615 insertions, 0 deletions
diff --git a/tdeui/kjanuswidget.h b/tdeui/kjanuswidget.h
new file mode 100644
index 000000000..fc3eb2f27
--- /dev/null
+++ b/tdeui/kjanuswidget.h
@@ -0,0 +1,615 @@
+/* This file is part of the KDE Libraries
+ * Copyright (C) 1999-2000 Espen Sand ([email protected])
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Library General Public
+ * License as published by the Free Software Foundation; either
+ * version 2 of the License, or (at your option) any later version.
+ *
+ * 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 _KJANUS_WIDGET_H_
+#define _KJANUS_WIDGET_H_
+
+#include <tqptrlist.h>
+#include <tqpixmap.h>
+#include <tqsplitter.h>
+
+#include <klistbox.h>
+#include <tqstringlist.h>
+#include <tqmap.h>
+
+class KListView;
+
+class TQGrid;
+class TQHBox;
+class TQLabel;
+class TQTabWidget;
+class TQVBox;
+class TQWidgetStack;
+class KSeparator;
+class TQListViewItem;
+class KGuiItem;
+
+/**
+ * @short Easy to use widget with many layouts
+ *
+ * Provides a number of ready to use layouts (faces). It is used
+ * as an internal widget in KDialogBase, but can also used as a
+ * widget of its own.
+ *
+ * This class provides KJanusWidget::TreeList, KJanusWidget::IconList,
+ * KJanusWidget::Tabbed, KJanusWidget::Plain and KJanusWidget::Swallow layouts.
+ *
+ * For all modes it is important that you specify the TQWidget::tqminimumSize()
+ * on the page, plain widget or the swallowed widget. If you use a QLayout
+ * on the page, plain widget or the swallowed widget this will be taken care
+ * of automatically. The size is used when the KJanusWidget determines its
+ * own minimum size. You get the minimum size by using the
+ * tqminimumSizeHint() or tqsizeHint() methods.
+ *
+ * Pages that have been added in TreeList, IconList or Tabbed mode can be
+ * removed by simply deleting the page. However, it would be preferable to use
+ * the TQObject::deleteLater() function on the page as the main event loop
+ * may have optimized UI update events of the page by scheduling them for later.
+ *
+ * @author Espen Sand ([email protected])
+ */
+class KDEUI_EXPORT KJanusWidget : public TQWidget
+{
+ Q_OBJECT
+
+ private:
+ class IconListBox : public KListBox
+ {
+ friend class KJanusWidget;
+
+ public:
+ IconListBox( TQWidget *parent=0, const char *name=0, WFlags f=0 );
+ void updateMinimumHeight();
+ void updateWidth();
+ void invalidateHeight();
+ void invalidateWidth();
+ void setShowAll( bool showAll );
+
+ protected:
+ void slotOnItem( TQListBoxItem *item );
+ virtual void leaveEvent( TQEvent * );
+
+ private:
+ bool mShowAll;
+ bool mHeightValid;
+ bool mWidthValid;
+ TQListBoxItem *mOldItem;
+ };
+
+ public:
+ enum Face
+ {
+ /**
+ * The TreeList face provides a list in the left area and pages in the
+ * right. The area are separated by a movable splitter. The style is somewhat
+ * similar to the layout in the Control Center. A page is raised by
+ * selecting the corresponding tree list item.
+ */
+ TreeList = 0,
+ /** The Tabbed face is a common tabbed widget. The procedure for creating a
+ * page is similar for creating a TreeList. This has the advantage that if
+ * your widget contain too many pages it is trivial to convert it into a
+ * TreeList. Just change the face in the KJanusWidget constructor to
+ * KJanusWidget::TreeList and you have a tree list layout instead.
+ */
+ Tabbed,
+ /**
+ * The Plain face provides an empty widget (TQFrame) where you can place your
+ * widgets. The KJanusWidget makes no assumptions regarding the contents so
+ * you are free to add whatever you want.
+ */
+ Plain,
+ /**
+ * The Swallow face is provided in order to simplify the usage of existing
+ * widgets and to allow changing the visible widget. You specify the widget
+ * to be displayed by setSwallowedWidget(). Your widget will be
+ * reparented inside the widget. You can specify a Null (0) widget. A empty
+ * space is then displayed.
+ */
+ Swallow,
+ /**
+ * The IconList face provides an icon list in the left area and pages in the
+ * right. For each entry the Icon is on top with the text below. The style
+ * is somewhat similar to the layout of the Eudora configuation dialog box.
+ * A page is raised by selecting the corresponding icon list item. The
+ * preferred icon size is 32x32 pixels.
+ */
+ IconList
+ };
+
+ public:
+
+ /**
+ * Constructor where you specify the face.
+ *
+ * @param parent Parent of the widget.
+ * @param name Widget name.
+ * @param face The kind of dialog, Use TreeList, Tabbed, Plain or
+ * Swallow.
+ */
+ KJanusWidget( TQWidget *parent=0, const char *name=0, int face=Plain );
+
+ /**
+ * Destructor.
+ */
+ ~KJanusWidget();
+
+ /**
+ * Raises the page which was added by addPage().
+ *
+ * @param index The index of the page you want to raise.
+ */
+ virtual bool showPage( int index );
+
+ /**
+ * Returns the index of the page that are currently displayed.
+ *
+ * @return The index or -1 if the face is not Tabbed, TreeList or
+ * IconList.
+ */
+ virtual int activePageIndex() const;
+
+ /**
+ * Use this to verify
+ * that no memory allocation failed.
+ *
+ * @return true if the widget was properly created.
+ */
+ virtual bool isValid() const;
+
+ /**
+ * Returns the face type.
+ *
+ * @return The face type.
+ */
+ virtual int face() const;
+
+ /**
+ * Returns the minimum size that must be made available for the widget
+ * so that UIs can be displayed properly
+ *
+ * @return The minimum size.
+ */
+ virtual TQSize tqminimumSizeHint() const;
+
+ /**
+ * Returns the recommended size for the widget in order to be displayed
+ * properly.
+ *
+ * @return The recommended size.
+ */
+ virtual TQSize tqsizeHint() const;
+
+ /**
+ * Returns the empty widget that is available in Plain mode.
+ *
+ * @return The widget or 0 if the face in not Plain.
+ */
+ virtual TQFrame *plainPage();
+
+ /**
+ * Add a new page when the class is used in TreeList, IconList or Tabbed
+ * mode. The returned widget is empty and you must add your widgets
+ * as children to this widget. In most cases you must create a layout
+ * manager and associate it with this widget as well.
+ *
+ * Deleting the returned frame will cause the listitem or tab to be
+ * removed (you can re-add a page with the same name later.
+ *
+ * @param item String used in the list or Tab item.
+ * @param header A longer string used in TreeList and IconList mode to
+ * describe the contents of a page. If empty, the item string
+ * will be used instead.
+ * @param pixmap Used in IconList mode or in TreeList mode. You should
+ * prefer a pixmap with size 32x32 pixels.
+ *
+ * @return The empty page or 0 if the face is not TreeList, IconList or
+ * Tabbed.
+ */
+ virtual TQFrame *addPage(const TQString &item,const TQString &header=TQString::null,
+ const TQPixmap &pixmap=TQPixmap() );
+
+ /**
+ * This is like addPage just above, with the difference that the first
+ * element is a list of strings. These strings are used to form a path
+ * of folders down to the given page. The initial elements are names
+ * for the folders, while the last element is the name of the page.
+ * Note: This does yet only work for the TreeList face. Later this may
+ * be added for the IconList face too. In other faces than the
+ * TreeList, all the strings except the last one is ignored.
+ * Deleting the returned frame will cause the listitem or tab to be
+ * removed (you can re-add a page with the same name later.
+ *
+ * Deleting the returned frame will cause the listitem or tab to be
+ * removed (you can re-add a page with the same name later.
+ **/
+ virtual TQFrame *addPage(const TQStringList &items, const TQString &header=TQString::null,
+ const TQPixmap &pixmap=TQPixmap() );
+
+ /**
+ * Add a new page when the class is used in TreeList, IconList or Tabbed
+ * mode. The returned widget is empty and you must add your widgets
+ * as children to this widget. The returned widget is a QVBox
+ * so it contains a TQVBoxLayout layout that lines up the child widgets
+ * are vertically.
+ *
+ * Deleting the returned frame will cause the listitem or tab to be
+ * removed (you can re-add a page with the same name later.
+ *
+ * @param item String used in the list or Tab item.
+ * @param header A longer string used in TreeList and IconList mode to
+ * describe the contents of a page. If empty, the item string
+ * will be used instead.
+ * @param pixmap Used in IconList mode or in TreeList mode. You should
+ * prefer a pixmap with size 32x32 pixels.
+ *
+ * @return The empty page or 0 if the face is not TreeList, IconList or
+ * Tabbed. */
+ virtual TQVBox *addVBoxPage( const TQString &item,
+ const TQString &header=TQString::null,
+ const TQPixmap &pixmap=TQPixmap() );
+
+ /**
+ * This is like addVBoxPage just above, with the difference that the first
+ * element is a list of strings. These strings are used to form a path
+ * of folders down to the given page. The initial elements are names
+ * for the folders, while the last element is the name of the page.
+ * Note: This does yet only work for the TreeList face. Later this may
+ * be added for the IconList face too. In other faces than the
+ * TreeList, all the strings except the last one is ignored.
+ *
+ * Deleting the returned frame will cause the listitem or tab to be
+ * removed (you can re-add a page with the same name later.
+ **/
+ virtual TQVBox *addVBoxPage( const TQStringList &items,
+ const TQString &header=TQString::null,
+ const TQPixmap &pixmap=TQPixmap() );
+
+ /**
+ * Add a new page when the class is used in TreeList, IconList or Tabbed
+ * mode. The returned widget is empty and you must add your widgets
+ * as children to this widget. The returned widget is a QHBox
+ * so it contains a TQHBoxLayout layout that lines up the child widgets
+ * are horizontally.
+ *
+ * Deleting the returned frame will cause the listitem or tab to be
+ * removed (you can re-add a page with the same name later.
+ *
+ * @param itemName String used in the list or Tab item.
+ * @param header A longer string used in TreeList and IconList mode to
+ * describe the contents of a page. If empty, the item string
+ * will be used instead.
+ * @param pixmap Used in IconList mode or in TreeList mode. You should
+ * prefer a pixmap with size 32x32 pixels.
+ *
+ * @return The empty page or 0 if the face is not TreeList, IconList or
+ * Tabbed.
+ */
+ virtual TQHBox *addHBoxPage( const TQString &itemName,
+ const TQString &header=TQString::null,
+ const TQPixmap &pixmap=TQPixmap() );
+
+ /**
+ * This is like addHBoxPage just above, with the difference that the first
+ * element is a list of strings. These strings are used to form a path
+ * of folders down to the given page. The initial elements are names
+ * for the folders, while the last element is the name of the page.
+ * Note: This does yet only work for the TreeList face. Later this may
+ * be added for the IconList face too. In other faces than the
+ * TreeList, all the strings except the last one is ignored.
+ *
+ * Deleting the returned frame will cause the listitem or tab to be
+ * removed (you can re-add a page with the same name later.
+ **/
+ virtual TQHBox *addHBoxPage( const TQStringList &items,
+ const TQString &header=TQString::null,
+ const TQPixmap &pixmap=TQPixmap() );
+
+ /**
+ * Add a new page when the class is used in either TreeList or Tabbed
+ * mode. The returned widget is empty and you must add your widgets
+ * as children to this widget. The returned widget is a QGrid
+ * so it contains a TQGridLayout layout that places up the child widgets
+ * in a grid.
+ *
+ * Deleting the returned frame will cause the listitem or tab to be
+ * removed (you can re-add a page with the same name later.
+ *
+ * @param n Specifies the number of columns if 'dir' is TQGrid::Horizontal
+ * or the number of rows if 'dir' is TQGrid::Vertical.
+ * @param dir Can be TQGrid::Horizontal or TQGrid::Vertical.
+ * @param itemName String used in the list or Tab item.
+ * @param header A longer string used in TreeList and IconList mode to
+ * describe the contents of a page. If empty, the item string
+ * will be used instead.
+ * @param pixmap Used in IconList mode or in TreeList mode. You should
+ * prefer a pixmap with size 32x32 pixels.
+ *
+ * @return The empty page or 0 if the face is not TreeList, IconList or
+ * Tabbed.
+ */
+ virtual TQGrid *addGridPage( int n, Orientation dir,
+ const TQString &itemName,
+ const TQString &header=TQString::null,
+ const TQPixmap &pixmap=TQPixmap() );
+
+ /**
+ * This is like addGridPage just above, with the difference that the first
+ * element is a list of strings. These strings are used to form a path
+ * of folders down to the given page. The initial elements are names
+ * for the folders, while the last element is the name of the page.
+ * Note: This does yet only work for the TreeList face. Later this may
+ * be added for the IconList face too. In other faces than the
+ * TreeList, all the strings except the last one is ignored.
+ *
+ * Deleting the returned frame will cause the listitem or tab to be
+ * removed (you can re-add a page with the same name later.
+ **/
+ virtual TQGrid *addGridPage( int n, Orientation dir,
+ const TQStringList &items,
+ const TQString &header=TQString::null,
+ const TQPixmap &pixmap=TQPixmap() );
+
+ /**
+ * @short Removes a page created with addPage, addVBoxPage,
+ * addHBoxPage or addGridPage. If the page has already
+ * been deleted or has already been removed, nothing happens. The widget
+ * itself is not deleted.
+ *
+ * @param page The widget returned by addPage , addVBoxPage ,
+ * addHBoxPage or addGridPage .
+ */
+ void removePage( TQWidget *page );
+
+
+ /**
+ * Returns the index of a page created with addPage ,
+ * addVBoxPage , addHBoxPage or addGridPage .
+ * You can can compare this index with the value returned from
+ * activePageIndex if you need to do some page specific actions
+ * in your code.
+ *
+ * The returned index will never change so you can safely use this
+ * function once and save the value.
+ *
+ * @param widget The widget returned by addPage , addVBoxPage ,
+ * addHBoxPage or addGridPage .
+ *
+ * @return The index or -1 if the face is not Tabbed, TreeList or
+ * IconList
+ */
+ virtual int pageIndex( TQWidget *widget ) const;
+
+ /**
+ * Defines the widget to be swallowed.
+ *
+ * This method can be used several
+ * times. Only the latest defined widget will be shown.
+ *
+ * @param widget The widget to be swallowed. If 0, then an empty rectangle
+ * is displayed.
+ */
+ virtual bool setSwallowedWidget( TQWidget *widget );
+
+ /**
+ * This function has only effect in TreeList mode.
+ *
+ * Defines how the tree list is resized when the widget is resized
+ * horizontally. By default the tree list keeps its width when the
+ * widget becomes wider.
+ *
+ * @param state The resize mode. If false (default) the TreeList keeps
+ * its current width when the widget becomes wider.
+ */
+ virtual void setTreeListAutoResize( bool state );
+
+ /**
+ * This function has only effect in TreeList mode.
+ *
+ * This tells the widgets whether the icons given in the addPage,
+ * addVBoxPage, addHBoxPage, or addGridPage methods should
+ * be shown in the TreeList.
+ *
+ * Note: This method must be called before calling any of the methods
+ * which add icons to the page.
+ *
+ * @param state If true the icons are shown.
+ **/
+ virtual void setShowIconsInTreeList(bool state);
+
+ /**
+ * This function has only effect in TreeList mode.
+ *
+ * This tells the widgets whether the root should be decorated.
+ * For details see TQListView::setRootIsDecorated
+ *
+ * @param state Root will be decorated if true.
+ **/
+ virtual void setRootIsDecorated( bool state );
+
+ /**
+ * This function has only effect in TreeList mode.
+ *
+ * This tells the TreeList to unfold the whole tree so that all entries
+ * are visible.
+ *
+ * If the list is empty when you call this method newly created entries
+ * will not automatically be opened. If the @p persist flag is set opened
+ * entries cannot be closed again, though.
+ *
+ * @param persist If true the tree always stays unfolded.
+ * @since 3.2
+ */
+ /*virtual*/ void unfoldTreeList( bool persist = false ); //### KDE4 BIC add virtual
+
+ /**
+ * Add a widget at the bottom of the TreeList/IconList.
+ *
+ * @param widget The widget to be added. It will be reparented into the
+ * KJanusWidget, therefor it will be deleted with the
+ * KJanusWidget, too. To be on the save side just don't keep
+ * the pointer to this widget.
+ */
+ /*virtual*/ void addWidgetBelowList( TQWidget * widget ); // ### KDE4
+
+ /**
+ * Add a button at the bottom of the TreeList/IconList.
+ *
+ * @param text The text on the PushButton.
+ * @param recv The object that is to receive the signal when the button
+ * is clicked.
+ * @param slot The slot to connect to the clicked signal of the button.
+ *
+ * @since 3.2
+ */
+ /*virtual*/ void addButtonBelowList( const TQString & text, TQObject * recv,
+ const char * slot ); //### KDE4
+
+ /**
+ * The same as the above function, but with a KGuiItem providing the text
+ * and icon for the button at the bottom of the TreeList/IconList.
+ *
+ * @param guiitem The text and icon on the PushButton.
+ * @param recv The object that is to receive the signal when the button
+ * is clicked.
+ * @param slot The slot to connect to the clicked signal of the button.
+ *
+ * @since 3.2
+ */
+ /*virtual*/ void addButtonBelowList( const KGuiItem & guiitem, TQObject *
+ recv, const char * slot ); //### KDE4
+
+ /**
+ * This function has only effect in IconList mode.
+ *
+ * Defines how the icon list widget is displayed. By default it is
+ * the widgets in the pages that decide the minimum height
+ * of the toplevel widget. A vertical scrollbar can be used in
+ * the icon list area.
+ *
+ * @param state The visibility mode. If true, the minimum height is
+ * adjusted so that every icon in the list is visible at the
+ * same time. The vertical scrollbar will never be visible.
+ */
+ virtual void setIconListAllVisible( bool state );
+
+ /**
+ * Sets the icon used in TreeList Mode for the given path.
+ * @param path The path for which this icon should be shown.
+ * @param pixmap The icon used.
+ **/
+ virtual void setFolderIcon(const TQStringList &path, const TQPixmap &pixmap);
+ /**
+ * Returns the title string associated with a page index in TreeList or IconList mode.
+ * @param index The index of the page or null if there is no such page.
+ * @see pageIndex()
+ * @since 3.2
+ */
+ /*virtual*/ TQString pageTitle(int index) const;
+ /**
+ * Returns the page widget associated with a page index or null if there is
+ * no such page.
+ * @param index The index of the page.
+ * @see pageIndex()
+ * @since 3.2
+ */
+ /*virtual*/ TQWidget *pageWidget(int index) const;
+
+ signals:
+ /**
+ * This signal is emitted whenever the current page changes.
+ * @param page the new page.
+ * @since 3.4
+ */
+ void aboutToShowPage(TQWidget *page);
+
+ public slots:
+ /**
+ * Give the keyboard input focus to the widget.
+ */
+ virtual void setFocus();
+
+ protected:
+ /**
+ * Reimplemented to handle the splitter width when the the face
+ * is TreeList
+ */
+ virtual void showEvent( TQShowEvent * );
+
+ /**
+ * This function is used internally when in IconList mode. If you
+ * reimplement this class a make your own event filter, make sure to
+ * call this function from your filter.
+ *
+ * @param o Object that has received an event.
+ * @param e The event.
+ */
+ virtual bool eventFilter( TQObject *o, TQEvent *e );
+
+ private slots:
+ bool slotShowPage();
+ void slotFontChanged();
+
+ void slotOnItem(TQListBoxItem *item);
+ void slotItemClicked(TQListViewItem *it);
+ void pageGone(TQObject *obj); // signal from the added page's "destroyed" signal
+ void slotReopen(TQListViewItem *item);
+
+ protected:
+ bool showPage( TQWidget *w );
+ void addPageWidget( TQFrame *page, const TQStringList &items,
+ const TQString &header, const TQPixmap &pixmap );
+ void InsertTreeListItem(const TQStringList &items, const TQPixmap &pixmap, TQFrame *page);
+ TQWidget *FindParent();
+
+ private:
+ bool mValid;
+
+ // Obsolete members. Remove in KDE 4.
+ TQPtrList<TQWidget> *mPageList;
+ TQStringList *mTitleList;
+
+ int mFace;
+ KListView *mTreeList;
+ IconListBox *mIconList;
+ TQWidgetStack *mPageStack;
+ TQLabel *mTitleLabel;
+ TQTabWidget *mTabControl;
+ TQFrame *mPlainPage;
+ TQWidget *mSwallowPage;
+ TQWidget *mActivePageWidget;
+ KSeparator *mTitleSep;
+ TQSplitter::ResizeMode mTreeListResizeMode;
+ bool mShowIconsInTreeList;
+ TQMap<TQListViewItem *, TQWidget *> mTreeListToPageStack;
+ TQMap<TQListBoxItem *, TQWidget *> mIconListToPageStack;
+ TQMap<TQString, TQPixmap> mFolderIconMap;
+ TQMap<TQString, TQStringList> mChildrenNames;
+ TQMap<TQString, TQWidget *> mChildPages;
+
+ public:
+ class IconListItem;
+ protected:
+ virtual void virtual_hook( int id, void* data );
+ private:
+ class KJanusWidgetPrivate;
+ KJanusWidgetPrivate *d;
+};
+
+#endif