* You should have received a copy of the GNU General Public License *
* along with this program; if not, write to the *
* Free Software Foundation, Inc., *
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA *
***************************************************************************/
-#ifndef _DOLPHIN_MAINWINDOW_H_
-#define _DOLPHIN_MAINWINDOW_H_
+#ifndef DOLPHIN_MAINWINDOW_H
+#define DOLPHIN_MAINWINDOW_H
-#ifdef HAVE_CONFIG_H
-#include <config.h>
-#endif
+#include "dolphinview.h"
+#include "sidebarpage.h"
+
+#include <config-nepomuk.h>
-#include <kapplication.h>
-#include <kmainwindow.h>
-#include <q3valuelist.h>
-#include <q3ptrlist.h>
-#include <qstring.h>
-//Added by qt3to4:
-#include <QCloseEvent>
+#include <kfileitemdelegate.h>
+#include <konq_fileundomanager.h>
#include <ksortablelist.h>
-#include <kvbox.h>
+#include <kxmlguiwindow.h>
-#include "dolphinview.h"
-#include "undomanager.h"
+#include <QtCore/QList>
-class KPrinter;
+class DolphinViewActionHandler;
+class DolphinApplication;
+class DolphinViewContainer;
+class KNewMenu;
class KUrl;
-class QLineEdit;
-class KFileIconView;
-class KHBox;
-class Q3IconViewItem;
class QSplitter;
-class KAction;
-class UrlNavigator;
-class Sidebar;
-class DolphinApplication;
/**
* @short Main window for Dolphin.
*
* Handles the menus, toolbars and Dolphin views.
- *
- * @author Peter Penz <peter.penz@gmx.at>
-*/
-class DolphinMainWindow: public KMainWindow
+ */
+class DolphinMainWindow: public KXmlGuiWindow
{
Q_OBJECT
+ Q_CLASSINFO("D-Bus Interface", "org.kde.dolphin.MainWindow")
+ Q_PROPERTY(int id READ getId SCRIPTABLE true)
friend class DolphinApplication;
+
public:
virtual ~DolphinMainWindow();
- /**
- * Activates the given view, which means that
- * all menu actions are applied to this view. When
- * having a split view setup the nonactive view
- * is usually shown in darker colors.
- */
- void setActiveView(DolphinView* view);
-
/**
- * Returns the currently active view. See
- * DolphinMainWindow::setActiveView() for more details.
+ * Returns the currently active view.
+ * All menu actions are applied to this view. When
+ * having a split view setup, the nonactive view
+ * is usually shown in darker colors.
*/
- DolphinView* activeView() const { return m_activeView; }
+ DolphinViewContainer* activeViewContainer() const;
/**
- * Handles the dropping of Urls to the given
- * destination. A context menu with the options
- * 'Move Here', 'Copy Here', 'Link Here' and
- * 'Cancel' is offered to the user.
- * @param urls List of Urls which have been
- * dropped.
- * @param destination Destination Url, where the
- * list or Urls should be moved,
- * copied or linked to.
+ * Returns true, if the main window contains two instances
+ * of a view container. The active view constainer can be
+ * accessed by DolphinMainWindow::activeViewContainer().
*/
- void dropUrls(const KUrl::List& urls,
- const KUrl& destination);
+ bool isSplit() const;
/**
- * Returns 'true', if the clipboard contains data
- * which has been cutted by the Cut action (Ctrl + X).
+ * If the main window contains two instances of a view container
+ * (DolphinMainWindow::isSplit() returns true), then the
+ * two views get toggled (the right view is on the left, the left
+ * view on the right).
*/
- bool clipboardContainsCutData() const { return m_clipboardContainsCutData; }
+ void toggleViews();
- /**
- * Returns the list of actions which are part of the file group
- * of the 'Create New...' sub menu. Usually the list contains actions
- * for creating folders, text files, HTML files etc.
- */
- const Q3PtrList<KAction>& fileGroupActions() const { return m_fileGroupActions; }
- //const QPtrList<KAction>& linkGroupActions() const { return m_linkGroupActions; }
- //const QPtrList<KAction>& linkToDeviceActions() const { return m_linkToDeviceActions; }
+ /** Renames the item represented by \a oldUrl to \a newUrl. */
+ void rename(const KUrl& oldUrl, const KUrl& newUrl);
/**
- * Refreshs the views of the main window by recreating them dependent from
+ * Refreshes the views of the main window by recreating them dependent from
* the given Dolphin settings.
*/
void refreshViews();
-signals:
/**
- * Is send if the active view has been changed in
- * the split view mode.
+ * Returns the 'Create New...' sub menu which also can be shared
+ * with other menus (e. g. a context menu).
*/
- void activeViewChanged();
+ KNewMenu* newMenu() const;
/**
- * Is send if the selection of the currently active view has
- * been changed.
+ * Returns the 'Show Menubar' action which can be shared with
+ * other menus (e. g. a context menu).
*/
- void selectionChanged();
+ KAction* showMenuBarAction() const;
public slots:
/**
- * Updates the state of the 'Back' and 'Forward' menu
- * actions corresponding the the current history.
+ * Handles the dropping of URLs to the given
+ * destination. This is only called by the TreeViewSidebarPage.
*/
- void slotHistoryChanged();
+ void dropUrls(const KUrl::List& urls,
+ const KUrl& destination);
/**
- * Updates the caption of the main window and the state
- * of all menu actions which depend from a changed Url.
+ * Returns the main window ID used through DBus.
*/
- void slotUrlChanged(const KUrl& url);
+ int getId() const;
/**
- * Go to the given Url.
+ * Inform all affected dolphin components (sidebars, views) of an URL
+ * change.
*/
- void slotUrlChangeRequest(const KUrl& url);
-
- /** Updates the state of all 'View' menu actions. */
- void slotViewModeChanged();
-
- /** Updates the state of the 'Show hidden files' menu action. */
- void slotShowHiddenFilesChanged();
-
- /** Updates the state of the 'Show filter bar' menu action. */
- void slotShowFilterBarChanged();
+ void changeUrl(const KUrl& url);
- /** Updates the state of the 'Sort by' actions. */
- void slotSortingChanged(DolphinView::Sorting sorting);
-
- /** Updates the state of the 'Sort Ascending/Descending' action. */
- void slotSortOrderChanged(Qt::SortOrder order);
-
- /** Updates the state of the 'Edit' menu actions. */
- void slotSelectionChanged();
+ /**
+ * Inform all affected dolphin components that a selection change is
+ * requested.
+ */
+ void changeSelection(const KFileItemList& selection);
- /** Executes Redo operation */
- void slotRedo();
+ /** Stores all settings and quits Dolphin. */
+ void quit();
- /** @see slotUndo() */
- void slotUndo();
+signals:
+ /**
+ * Is send if the active view has been changed in
+ * the split view mode.
+ */
+ void activeViewChanged();
-protected:
- /** @see QMainWindow::closeEvent */
- virtual void closeEvent(QCloseEvent* event);
+ /**
+ * Is sent if the selection of the currently active view has
+ * been changed.
+ */
+ void selectionChanged(const KFileItemList& selection);
/**
- * This method is called when it is time for the app to save its
- * properties for session management purposes.
+ * Is sent if the url of the currently active view has
+ * been changed.
*/
- void saveProperties(KConfig*);
+ void urlChanged(const KUrl& url);
/**
- * This method is called when this app is restored. The KConfig
- * object points to the session management config file that was saved
- * with @ref saveProperties
+ * Is emitted if information of an item is requested to be shown e. g. in the sidebar.
+ * If item is null, no item information request is pending.
*/
- void readProperties(KConfig*);
+ void requestItemInfo(const KFileItem& item);
-private slots:
- /** Opens an input dialog for creating a new folder. */
- void createFolder();
+protected:
+ /** @see QMainWindow::closeEvent() */
+ virtual void closeEvent(QCloseEvent* event);
- /** Creates a file with the MIME type given by the sender. */
- void createFile();
+ /** @see KMainWindow::saveProperties() */
+ virtual void saveProperties(KConfigGroup& group);
- /** Renames the selected item of the active view. */
- void rename();
+ /** @see KMainWindow::readProperties() */
+ virtual void readProperties(const KConfigGroup& group);
- /** Moves the selected items of the active view to the trash. */
- void moveToTrash();
+private slots:
+ void clearStatusBar();
- /** Deletes the selected items of the active view. */
- void deleteItems();
+ /** Updates the 'Create New...' sub menu. */
+ void updateNewMenu();
/**
* Opens the properties window for the selected items of the
- * active view. The properties windows shows informations
+ * active view. The properties windows shows information
* like name, size and permissions.
*/
void properties();
- /** Stores all settings and quits Dolphin. */
- void quit();
-
/**
- * Shows the error information of the job \a job
+ * Shows the error information from the places model
* in the status bar.
*/
- void slotHandleJobError(KJob* job);
-
- /**
- * Indicates in the status bar that the delete operation
- * of the job \a job has been finished.
- */
- void slotDeleteFileFinished(KJob* job);
+ void slotHandlePlacesError(const QString &message);
/**
* Updates the state of the 'Undo' menu action dependent
/** Sets the text of the 'Undo' menu action to \a text. */
void slotUndoTextChanged(const QString& text);
- /**
- * Updates the state of the 'Redo' menu action dependent
- * from the parameter \a available.
- */
- void slotRedoAvailable(bool available);
-
- /** Sets the text of the 'Redo' menu action to \a text. */
- void slotRedoTextChanged(const QString& text);
+ /** Performs the current undo operation. */
+ void undo();
/**
* Copies all selected items to the clipboard and marks
*/
void invertSelection();
- /** The current active view is switched to the icons mode. */
- void setIconsView();
-
- /** The current active view is switched to the details mode. */
- void setDetailsView();
-
- /** The current active view is switched to the previews mode. */
- void setPreviewsView();
+ /** The current active view is switched to a new view mode. */
+ void setViewMode(QAction *);
/** The sorting of the current view should be done by the name. */
void sortByName();
/** The sorting of the current view should be done by the date. */
void sortByDate();
- /** Switches between an ascending and descending sorting order. */
- void toggleSortOrder();
+ /** The sorting of the current view should be done by the permissions. */
+ void sortByPermissions();
+
+ /** The sorting of the current view should be done by the owner. */
+ void sortByOwner();
+
+ /** The sorting of the current view should be done by the group. */
+ void sortByGroup();
+
+ /** The sorting of the current view should be done by the type. */
+ void sortByType();
+
+ /** The sorting of the current view should be done by the rating. */
+ void sortByRating();
+
+ /** The sorting of the current view should be done by tags. */
+ void sortByTags();
/**
* Switches between one and two views:
void stopLoading();
/**
- * Switches between showing and hiding of hidden marked files dependent
- * from the current state of the 'Show Hidden Files' menu toggle action.
- */
- void showHiddenFiles();
-
- /**
- * Switches between showing and hiding of the filter bar dependent
- * from the current state of the 'Show Filter Bar' menu toggle action.
+ * Toggles between showing and hiding of the filter bar
*/
- void showFilterBar();
-
- /** Increases the size of the current set view mode. */
- void zoomIn();
-
- /** Decreases the size of the current set view mode. */
- void zoomOut();
+ void toggleFilterBarVisibility(bool show);
/**
- * Toggles between edit and brose mode of the navigation bar.
+ * Toggles between edit and browse mode of the navigation bar.
*/
void toggleEditLocation();
*/
void adjustViewProperties();
- /** Goes back on step of the Url history. */
+ /** Goes back on step of the URL history. */
void goBack();
- /** Goes forward one step of the Url history. */
+ /** Goes forward one step of the URL history. */
void goForward();
- /** Goes up one hierarchy of the current Url. */
+ /** Goes up one hierarchy of the current URL. */
void goUp();
- /** Goes to the home Url. */
+ /** Goes to the home URL. */
void goHome();
- /** Opens a terminal for the current shown directory. */
- void openTerminal();
-
/** Opens KFind for the current shown directory. */
void findFile();
/** Opens Kompare for 2 selected files. */
void compareFiles();
+ /**
+ * Hides the menu bar if it is visible, makes the menu bar
+ * visible if it is hidden.
+ */
+ void toggleShowMenuBar();
+
/** Opens the settings dialog for Dolphin. */
void editSettings();
+ /** Updates the state of all 'View' menu actions. */
+ void slotViewModeChanged();
+
+ /** Updates the state of the 'Sort by' actions. */
+ void slotSortingChanged(DolphinView::Sorting sorting);
+
+ /** Updates the state of the 'Show Full Location' action. */
+ void slotEditableStateChanged(bool editable);
+
/**
- * Adds the undo operation given by \a job
- * to the UndoManager.
+ * Updates the state of the 'Edit' menu actions and emits
+ * the signal selectionChanged().
*/
- void addUndoOperation(KJob* job);
-
+ void slotSelectionChanged(const KFileItemList& selection);
- void toggleSidebar();
+ /** Emits the signal requestItemInfo(). */
+ void slotRequestItemInfo(const KFileItem&);
/**
- * Stores the current sidebar width and closes
- * the sidebar.
+ * Updates the state of the 'Back' and 'Forward' menu
+ * actions corresponding the the current history.
*/
- void closeSidebar();
+ void slotHistoryChanged();
+
+ /** Updates the state of the 'Show filter bar' menu action. */
+ void updateFilterBarAction(bool show);
+
+ /** Open a new main window. */
+ void openNewMainWindow();
+
+ /** Toggles the active view if two views are shown within the main window. */
+ void toggleActiveView();
+
+ /** Called when the view is doing a file operation, like renaming, copying, moving etc. */
+ void slotDoingOperation(KonqFileUndoManager::CommandType type);
private:
- DolphinMainWindow();
+ DolphinMainWindow(int id);
void init();
- void loadSettings();
- void setupAccel();
+ /**
+ * Activates the given view, which means that
+ * all menu actions are applied to this view. When
+ * having a split view setup, the nonactive view
+ * is usually shown in darker colors.
+ */
+ void setActiveViewContainer(DolphinViewContainer* view);
+
void setupActions();
- void setupCreateNewMenuActions();
+ void setupDockWidgets();
void updateHistory();
void updateEditActions();
void updateViewActions();
void updateGoActions();
- void updateViewProperties(const KUrl::List& urls);
- void copyUrls(const KUrl::List& source, const KUrl& dest);
- void moveUrls(const KUrl::List& source, const KUrl& dest);
- void addPendingUndoJob(KIO::Job* job,
- DolphinCommand::Type commandType,
- const KUrl::List& source,
- const KUrl& dest);
- void clearStatusBar();
- void openSidebar();
- QSplitter* m_splitter;
- Sidebar* m_sidebar;
- DolphinView* m_activeView;
+ /**
+ * Connects the signals from the created DolphinView with
+ * the index \a viewIndex with the corresponding slots of
+ * the DolphinMainWindow. This method must be invoked each
+ * time a DolphinView has been created.
+ */
+ void connectViewSignals(int viewIndex);
/**
- * DolphinMainWindowsupports only one or two views, which
- * are handled internally as primary and secondary view.
+ * Updates the text of the split action:
+ * If two views are shown, the text is set to "Split",
+ * otherwise the text is set to "Join". The icon
+ * is updated to match with the text and the currently active view.
+ */
+ void updateSplitAction();
+
+private:
+ /**
+ * DolphinMainWindow supports up to two views beside each other.
*/
enum ViewIndex
{
- PrimaryIdx = 0,
- SecondaryIdx = 1
+ PrimaryView = 0, ///< View shown on the left side of the main window.
+ SecondaryView = 1 ///< View shown on the left side of the main window.
};
- DolphinView* m_view[SecondaryIdx + 1];
-
- /// If set to true, the clipboard contains data which should be cutted after pasting.
- bool m_clipboardContainsCutData;
/**
- * Asynchronous operations like 'Move' and 'Copy' may only be added as undo
- * operation after they have been finished successfully. When an asynchronous
- * operation is started, it is added to a pending undo jobs list in the meantime.
- * As soon as the job has been finished, the operation is added to the undo mangager.
- * @see UndoManager
- * @see DolphinMainWindow::addPendingUndoJob
- * @see DolphinMainWindow::addUndoOperation
+ * Implements a custom error handling for the undo manager. This
+ * assures that all errors are shown in the status bar of Dolphin
+ * instead as modal error dialog with an OK button.
*/
- struct UndoInfo
+ class UndoUiInterface : public KonqFileUndoManager::UiInterface
{
- int id;
- DolphinCommand command;
- };
- Q3ValueList<UndoInfo> m_pendingUndoJobs;
+ public:
+ UndoUiInterface(DolphinMainWindow* mainWin);
+ virtual ~UndoUiInterface();
+ virtual void jobError(KIO::Job* job);
- /** Contains meta information for creating files. */
- struct CreateFileEntry
- {
- QString name;
- QString filePath;
- QString templatePath;
- QString icon;
- QString comment;
+ private:
+ DolphinMainWindow* m_mainWin;
};
- Q3PtrList<KAction> m_fileGroupActions;
- KSortableList<CreateFileEntry,QString> m_createFileTemplates;
+ KNewMenu* m_newMenu;
+ KAction* m_showMenuBar;
+ QSplitter* m_splitter;
+ DolphinViewContainer* m_activeViewContainer;
+ int m_id;
+
+ DolphinViewContainer* m_viewContainer[SecondaryView + 1];
+
+ DolphinViewActionHandler* m_actionHandler;
- // TODO: not used yet. See documentation of DolphinMainWindow::linkGroupActions()
- // and DolphinMainWindow::linkToDeviceActions() in for details.
- //QPtrList<KAction> m_linkGroupActions;
- //QPtrList<KAction> m_linkToDeviceActions;
+ /// remember pending undo operations until they are finished
+ QList<KonqFileUndoManager::CommandType> m_undoCommandTypes;
};
-#endif // _DOLPHIN_H_
+inline DolphinViewContainer* DolphinMainWindow::activeViewContainer() const
+{
+ return m_activeViewContainer;
+}
+
+inline bool DolphinMainWindow::isSplit() const
+{
+ return m_viewContainer[SecondaryView] != 0;
+}
+
+inline KNewMenu* DolphinMainWindow::newMenu() const
+{
+ return m_newMenu;
+}
+
+inline KAction* DolphinMainWindow::showMenuBarAction() const
+{
+ return m_showMenuBar;
+}
+
+inline int DolphinMainWindow::getId() const
+{
+ return m_id;
+}
+
+#endif // DOLPHIN_MAINWINDOW_H
projects / dolphin.git / blobdiff