You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdeutils/kregexpeditor/KMultiFormListBox/tdemultiformlistboxfactory.h

71 lines
2.7 KiB

/*
* Copyright (c) 2002-2003 Jesper K. Pedersen <blackie@kde.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License version 2 as published by the Free Software Foundation.
*
* 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.
**/
// -------------------------------- includes ------------------------------
#ifndef __tdemultiformlistboxfactory
#define __tdemultiformlistboxfactory
#include <tqobject.h>
#include "kwidgetstreamer.h"
class KMultiFormListBoxEntry;
//-------------------------------------------------------------------------
/**
Factory use to generate elements for the @ref KMultiFormListBox widget.
To use an @ref KMultiFormListBox, one must inherit from the class KMultiFormListBoxFactory
and override the method @ref create. This method must return an empty
element for the KMultiFormListBox (that is an @ref KMultiFormListBoxEntry or a subclass of
it).
If you dislike the default separator between each of the elements or
simply do not want a separator in the KMultiFormListBox, then you may override
the method @ref separator.
**/
class KMultiFormListBoxFactory : public KWidgetStreamer
{
public:
virtual ~KMultiFormListBoxFactory() {}
/**
This method must be overridden in subclasses and must return an
``empty'' instance of the @ref KMultiFormListBoxEntry class, or perhaps rather
a subclass of this class. This instance will be owned by the caller of
this function.
@param parent A pointer to the parent of this KMultiFormListBoxEntry widget
returned.
@return A fresh @ref KMultiFormListBoxEntry to be used in an instance of the
@ref KMultiFormListBox class.
**/
virtual KMultiFormListBoxEntry *create(TQWidget *parent) = 0;
/**
This method is used to get a separator between the elements in an @ref
KMultiFormListBox. The widget returned from this method will be owned by the
caller.
@param parent A pointer to the parent of the TQWidget returned.
@return A widget which must be used as a separator between the @ref
KMultiFormListBoxEntry elements in an @ref KMultiFormListBox.
**/
virtual TQWidget *separator(TQWidget *parent);
};
#endif /* tdemultiformlistbox */