kexiformscrollview.h

/* This file is part of the KDE project
   Copyright (C) 2004 Cedric Pasteur <cedric.pasteur@free.fr>
   Copyright (C) 2004-2006 Jaroslaw Staniek <js@iidea.pl>
 
   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 KEXIFORMSCROLLVIEW_H
#define KEXIFORMSCROLLVIEW_H
 
#include "kexidataprovider.h"
#include "kexiformeventhandler.h"
#include "widgets/kexidbform.h"
#include <widget/kexiscrollview.h>
#include <widget/utils/kexirecordnavigator.h>
#include <widget/utils/kexisharedactionclient.h>
#include <widget/tableview/kexidataawareobjectiface.h>


class KEXIFORMUTILS_EXPORT KexiFormScrollView : 
    public KexiScrollView,
    public KexiRecordNavigatorHandler,
    public KexiSharedActionClient,
    public KexiDataAwareObjectInterface,
    public KexiFormDataProvider,
    public KexiFormEventHandler
{
    TQ_OBJECT
  
    KEXI_DATAAWAREOBJECTINTERFACE
 
    public:
        KexiFormScrollView(TQWidget *parent, bool preview);
        virtual ~KexiFormScrollView();
 
        void setForm(KFormDesigner::Form *form) { m_form = form; }

        virtual bool columnEditable(int col);

        virtual int columns() const;

        virtual KexiTableViewColumn* column(int col);

        virtual int fieldNumberForColumn(int col) {
            KexiFormDataItemInterface *item = dynamic_cast<KexiFormDataItemInterface*>(
                dbFormWidget()->orderedDataAwareWidgets()->at( col ));
            if (!item)
                return -1;
            KexiFormDataItemInterfaceToIntMap::ConstIterator it(m_fieldNumbersForDataItems.find( item ));
            return it!=m_fieldNumbersForDataItems.constEnd() ? (int)it.data() : -1;
        }

        void beforeSwitchView();

        virtual int lastVisibleRow() const;

        virtual TQScrollBar* verticalScrollBar() const { return KexiScrollView::verticalScrollBar(); }
 
    public slots:
        virtual void show();
 
        //virtual void setFocus();

        virtual int rowsPerPage() const;

        virtual void ensureCellVisible(int row, int col/*=-1*/);
 
        virtual void moveToRecordRequested(uint r);
        virtual void moveToLastRecordRequested();
        virtual void moveToPreviousRecordRequested();
        virtual void moveToNextRecordRequested();
        virtual void moveToFirstRecordRequested();
        virtual void addNewRecordRequested() { KexiDataAwareObjectInterface::addNewRecordRequested(); }

        virtual bool cancelEditor();
 
    public slots:
        virtual void refreshContentsSize();

        virtual void vScrollBarValueChanged(int v) { KexiDataAwareObjectInterface::vScrollBarValueChanged(v); }

        virtual void vScrollBarSliderReleased() { KexiDataAwareObjectInterface::vScrollBarSliderReleased(); }

        virtual void scrollBarTipTimeout() { KexiDataAwareObjectInterface::scrollBarTipTimeout(); }
 
    signals:
        virtual void itemChanged(KexiTableItem *, int row, int col);
        virtual void itemChanged(KexiTableItem *, int row, int col, TQVariant oldValue);
        virtual void itemDeleteRequest(KexiTableItem *, int row, int col);
        virtual void currentItemDeleteRequest();
        virtual void newItemAppendedForAfterDeletingInSpreadSheetMode(); 
        virtual void dataRefreshed();
        virtual void dataSet( KexiTableViewData *data );
        virtual void itemSelected(KexiTableItem *);
        virtual void cellSelected(int col, int row);
        virtual void sortedColumnChanged(int col);
        virtual void rowEditStarted(int row);
        virtual void rowEditTerminated(int row);
        virtual void reloadActions();
 
    protected slots:
        void slotResizingStarted();

        virtual void slotRowRepaintRequested(KexiTableItem& item);

        virtual void slotAboutToDeleteRow(KexiTableItem& item, KexiDB::ResultInfo* result, bool repaint)
        { KexiDataAwareObjectInterface::slotAboutToDeleteRow(item, result, repaint); }

        virtual void slotRowDeleted() { KexiDataAwareObjectInterface::slotRowDeleted(); }

        virtual void slotRowInserted(KexiTableItem *item, bool repaint);

        virtual void slotRowInserted(KexiTableItem *item, uint row, bool repaint);
 
        virtual void slotRowsDeleted( const TQValueList<int> & );
 
        virtual void slotDataDestroying() { KexiDataAwareObjectInterface::slotDataDestroying(); }

        virtual void reloadData() { KexiDataAwareObjectInterface::reloadData(); }

        virtual void copySelection();

        virtual void cutSelection();

        virtual void paste();
 
    protected:
        virtual void clearColumnsInternal(bool repaint);

        virtual void addHeaderColumn(const TQString& caption, const TQString& description, 
            const TQIconSet& icon, int width);

        virtual int currentLocalSortingOrder() const;

        virtual int currentLocalSortColumn() const;

        virtual void setLocalSortingOrder(int col, int order);

        void sortColumnInternal(int col, int order = 0);

        virtual void updateGUIAfterSorting();

        virtual void createEditor(int row, int col, const TQString& addText = TQString(), 
            bool removeOld = false);

        virtual KexiDataItemInterface *editor( int col, bool ignoreMissingEditor = false );

        virtual void editorShowFocus( int row, int col );

        virtual void updateCell(int row, int col);

        virtual void updateCurrentCell();

        virtual void updateRow(int row);

        virtual void updateWidgetContents();

        virtual void updateWidgetContentsSize();

        virtual void updateWidgetScrollBars();
 
        KexiDBForm* dbFormWidget() const;

        virtual void valueChanged(KexiDataItemInterface* item);

        virtual bool cursorAtNewRow() const;

        inline virtual void selectCellInternal();

        virtual void initDataContents();

        virtual void updateAfterCancelRowEdit();

        virtual void updateAfterAcceptRowEdit();

        void handleDataWidgetAction(const TQString& actionName);

        bool shouldDisplayDefaultValueForItem(KexiFormDataItemInterface* itemIface) const;
 
        //virtual bool focusNextPrevChild( bool next );
 
        KFormDesigner::Form *m_form;
        int m_currentLocalSortColumn, m_localSortingOrder;
        KexiTableItem *m_previousItem;
};
 
#endif