office-gobmx/include/svx/fmgridcl.hxx

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef INCLUDED_SVX_FMGRIDCL_HXX
#define INCLUDED_SVX_FMGRIDCL_HXX

#include <svx/gridctrl.hxx>
#include <vcl/transfer.hxx>
#include <svx/svxdllapi.h>
#include <memory>

namespace com::sun::star::beans { class XPropertySet; }
namespace com::sun::star::container { class XIndexContainer; }
namespace com::sun::star::container { class XNameAccess; }
namespace weld { class Menu; }

// FmGridHeader

struct FmGridHeaderData;
class SAL_WARN_UNUSED UNLESS_MERGELIBS_MORE(SVXCORE_DLLPUBLIC) FmGridHeader
            :public ::svt::EditBrowserHeader
            ,public DropTargetHelper
{
public:
    FmGridHeader( BrowseBox* pParent, WinBits nWinBits = WB_STDHEADERBAR | WB_DRAG );
    virtual ~FmGridHeader() override;
    virtual void dispose() override;

    // trigger context menu execution
    void    triggerColumnContextMenu( const ::Point& _rPreferredPos );

protected:
    virtual void Command( const CommandEvent& rCEvt ) override;
    virtual void RequestHelp( const HelpEvent& rHEvt ) override;
    virtual void Select() override;

    /** the value returned by GetItemPos is meaningless for the grid model if there are hidden columns,
        so use GetModelColumnPos instead
    */
    sal_uInt16 GetModelColumnPos(sal_uInt16 nId) const;

    /** This is called before executing a context menu for a column. rMenu contains the initial entries
        handled by this base class' method (which always has to be called).
        Derived classes may alter the menu in any way and handle any additional entries in
        PostExecuteColumnContextMenu.
        All disabled entries will be removed before executing the menu, so be careful with separators
        near entries you probably wish to disable ...
    */
    virtual void    PreExecuteColumnContextMenu(sal_uInt16 nColId, weld::Menu& rMenu,
                                                weld::Menu& rInsertMenu, weld::Menu& rChangeMenu,
                                                weld::Menu& rShowMenu);
    /** After executing the context menu for a column this method is called.
    */
    virtual void    PostExecuteColumnContextMenu(sal_uInt16 nColId, const weld::Menu& rMenu, const OUString& rExecutionResult);

    // DropTargetHelper
    virtual sal_Int8    AcceptDrop( const AcceptDropEvent& rEvt ) override;
    virtual sal_Int8    ExecuteDrop( const ExecuteDropEvent& rEvt ) override;

    /** selects the column at the selection supplier.
        @param  nColumnId
            The column id.
    */
    void notifyColumnSelect(sal_uInt16 nColumnId);
private:
    DECL_DLLPRIVATE_LINK( OnAsyncExecuteDrop, void*, void );

    std::unique_ptr<FmGridHeaderData>       m_pImpl;
};


// FmGridControl

class FmXGridPeer;
class SAL_WARN_UNUSED UNLESS_MERGELIBS_MORE(SVXCORE_DLLPUBLIC) FmGridControl : public DbGridControl

{
    friend class FmGridHeader;
    friend class FmXGridPeer;

    FmXGridPeer*        m_pPeer;
    sal_Int32           m_nCurrentSelectedColumn;   // this is the column model (not the view) position...
    sal_uInt16          m_nMarkedColumnId;
    bool                m_bSelecting;
    bool                m_bInColumnMove : 1;

public:
    FmGridControl(
        const css::uno::Reference< css::uno::XComponentContext >&,
        vcl::Window* pParent,
        FmXGridPeer* _pPeer,
        WinBits nBits);

    // Window
    virtual void KeyInput( const KeyEvent& rKEvt ) override;

    // css::beans::XPropertyChangeListener
    void propertyChange(const css::beans::PropertyChangeEvent& evt);

    // css::form::XPositioningListener
    void positioned();

    // XBound
    bool commit();

    // css::form::XInsertListener
    void inserted();

    void markColumn(sal_uInt16 nId);
    bool isColumnMarked(sal_uInt16 nId) const;

    sal_Int32   GetSelectedColumn() const { return m_nCurrentSelectedColumn;}

    /** return the name of the specified object.
        @param  eObjType
            The type to ask for
        @param  _nPosition
            The position of a tablecell (index position), header bar  column/row cell
        @return
            The name of the specified object.
    */
    virtual OUString GetAccessibleObjectName( AccessibleBrowseBoxObjType eObjType,sal_Int32 _nPosition = -1) const override;

    /** return the description of the specified object.
        @param  eObjType
            The type to ask for
        @param  _nPosition
            The position of a tablecell (index position), header bar  column/row cell
        @return
            The description of the specified object.
    */
    virtual OUString GetAccessibleObjectDescription( AccessibleBrowseBoxObjType eObjType,sal_Int32 _nPosition = -1) const override;

protected:
    virtual void Command(const CommandEvent& rEvt) override;

    virtual VclPtr<BrowserHeader> imp_CreateHeaderBar(BrowseBox* pParent) override;
    virtual tools::Long QueryMinimumRowHeight() override;
    virtual void RowHeightChanged() override;
    virtual void ColumnResized(sal_uInt16 nId) override;
    virtual void ColumnMoved(sal_uInt16 nId) override;
    virtual void DeleteSelectedRows() override;
    virtual void SetDesignMode(bool bMode) override;
    virtual void CellModified() override;
    virtual void HideColumn(sal_uInt16 nId) override;
    virtual void ShowColumn(sal_uInt16 nId) override;

    bool    IsInColumnMove() const {return m_bInColumnMove;}

    virtual void BeginCursorAction() override;
    virtual void EndCursorAction() override;
    virtual void Select() override;

    // Initialize columns
    // a.) only by column description
    void InitColumnsByModels(const css::uno::Reference< css::container::XIndexContainer >& xColumns);
    // b.) during alivemode by database fields
    virtual void InitColumnsByFields(const css::uno::Reference< css::container::XIndexAccess >& xFields) override;

            // some kind of impl version (for one single column) of our version of InitColumnsByFields
            static void InitColumnByField(
                    DbGridColumn* _pColumn,
                    const css::uno::Reference< css::beans::XPropertySet >& _rxColumnModel,
                    const css::uno::Reference< css::container::XNameAccess >& _rxFieldsByNames,
                    const css::uno::Reference< css::container::XIndexAccess >& _rxFieldsByIndex
                );

    FmXGridPeer* GetPeer() const {return m_pPeer;}

    css::uno::Sequence< css::uno::Any>
            getSelectionBookmarks();
    bool selectBookmarks(const css::uno::Sequence< css::uno::Any>& _rBookmarks);

    /** returns if a column is selected
        @param  _pColumn
            The column to compare with.
        @return
            <TRUE/> if the column is selected, otherwise <FALSE/>
    */
    bool isColumnSelected(DbGridColumn const * _pColumn) const;
};

#endif // INCLUDED_SVX_FMGRIDCL_HXX

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */