tdebase/klipper/popupproxy.h

// -*- Mode: C++; c-basic-offset: 4; indent-tabs-mode: nil; tab-width: 8; -*-
/* This file is part of the KDE project
   Copyright (C) 2004  Esben Mose Hansen <kde@mosehansen.dk>

   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This program 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
    General Public License for more details.

   You should have received a copy of the GNU General Public License
   along with this program; see the file COPYING.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/
#ifndef _POPUPPROXY_H_
#define _POPUPPROXY_H_

#include <tqptrlist.h>
#include <tqobject.h>
#include <tqstring.h>
#include <tqregexp.h>

#include <kpopupmenu.h>
#include <history.h>

class HistoryItem;
class KlipperPopup;

/**
 * Proxy helper for the "more" menu item
 *
 */
class PopupProxy : public QObject
{
    Q_OBJECT

public:
    /**
     * Inserts up to itemsPerMenu into parent from parent->youngest(),
     * and spills any remaining items into a more menu.
     */
    PopupProxy( KlipperPopup* parent, const char* name, int menu_height, int menu_width );

    KlipperPopup* parent();

    /**
     * Called when rebuilding the menu
     * Deletes any More menus.. and start (re)inserting into the toplevel menu.
     * @param index Items are inserted at index.
     * @param filter If non-empty, only insert items that match filter as a regex
     * @return number of items inserted.
     */
    int buildParent( int index, const TQRegExp& filter = TQRegExp() );

public slots:
    void slotAboutToShow();
    void slotHistoryChanged();
private:
    /**
     * Insert up to m_itemsPerMenu items from spill and a new
     * more-menu if neccessary.
     * @param index Items are inserted at index
     * @return number of items inserted.
     */
    int insertFromSpill( int index = 0 );

    /**
     * Insert item into proxy_for_menu at index,
     * subtracting the items height from remainingHeight
     */
    void tryInsertItem( HistoryItem const * const item, int& remainingHeight, const int index );

    /**
     * Delete all "More..." menus current created.
     */
    void deleteMoreMenus();

private:
    KPopupMenu* proxy_for_menu;
    History::iterator spillPointer;
    TQRegExp m_filter;
    int m_menu_height;
    int m_menu_width;
    int nextItemNumber;

};

#endif