/usr/include/Wt/WAbstractItemDelegate is in libwt-dev 3.1.10-1ubuntu2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 | // This may look like C code, but it's really -*- C++ -*-
/*
* Copyright (C) 2009 Emweb bvba, Kessel-Lo, Belgium.
*
* See the LICENSE file for terms of use.
*/
#ifndef WABSTRACTITEMDELEGATE_H_
#define WABSTRACTITEMDELEGATE_H_
#include <Wt/WObject>
#include <Wt/WFlags>
#include <Wt/WSignal>
#include <Wt/WValidator>
#include <boost/any.hpp>
namespace Wt {
/*! \brief Enumeration that specifies an option for rendering a view item.
*
* \sa WAbstractItemDelegate::update()
*/
enum ViewItemRenderFlag {
RenderSelected = 0x1, //!< %Render as selected
RenderEditing = 0x2, //!< %Render in editing mode
RenderFocused = 0x4, //!< %Render (the editor) focused
RenderInvalid = 0x8 //!< %Render as invalid
};
W_DECLARE_OPERATORS_FOR_FLAGS(ViewItemRenderFlag)
class WAbstractItemModel;
class WWidget;
class WModelIndex;
/*! \class WAbstractItemDelegate Wt/WAbstractItemDelegate Wt/WAbstractItemDelegate
* \brief Abstract delegate class for rendering an item in an item view.
*
* Rendering of an item in a WAbstractItemView is delegated to an
* implementation of this delegate class. The default implementation
* used by Wt's item views is WItemDelegate. To provide specialized
* rendering support, you can reimplement this class (or specialize
* WItemDelegate).
*
* As a delegate is used for rendering multiple items, the class should
* not keep state about one specific item.
*
* A delegate may provide editing support by instantiating an editor
* when update() is called with the Wt::RenderEditing flag. In that
* case, you will also need to implement editState() and
* setEditState() to support virtual scrolling and setModelData() to
* save the edited value to the model. For an example, see the
* WItemDelegate.
*
* \sa WAbstractItemView::setItemDelegateForColumn()
*
* \ingroup modelview
*/
class WT_API WAbstractItemDelegate : public WObject
{
public:
/*! \brief Constructor.
*/
WAbstractItemDelegate(WObject *parent = 0);
/*! \brief Destructor.
*/
virtual ~WAbstractItemDelegate();
/*! \brief Creates or updates a widget that renders an item.
*
* The item is specified by its model \p index, which also
* indicates the model. If an existing widget already renders the
* item, but needs to be updated, it is passed as the \p widget
* parameter. You may decide to create a new widget, in which case
* you are responsible to delete the previous \p widget if it is
* not reused.
*
* When \p widget is \c 0, a new widget needs to be created.
*
* The returned widget should be a widget that responds properly to
* be given a height, width and style class. In practice, that means
* it cannot have a border or margin, and thus cannot be a
* WFormWidget since those widgets typically have built-in borders
* and margins. If you want to return a form widget (for editing the item),
* you should wrap it in a container widget.
*
* The \p flags parameter indicates options for rendering the
* item.
*/
virtual WWidget *update(WWidget *widget, const WModelIndex& index,
WFlags<ViewItemRenderFlag> flags) = 0;
/*! \brief Updates the model index of a widget.
*
* This method is invoked by the view when due to row/column insertions or
* removals, the index has shifted.
*
* You should reimplement this method only if you are storing the
* model index in the \p widget, to update the stored model index.
*
* The default implementation does nothing.
*/
virtual void updateModelIndex(WWidget *widget, const WModelIndex& index);
/*! \brief Returns the current edit state.
*
* Because a View may support virtual scrolling in combination with
* editing, it may happen that the view decides to delete the editor
* widget while the user is editing. To allow to reconstruct the editor
* in its original state, the View will therefore ask for the editor
* to serialize its state in a boost::any.
*
* When the view decides to close an editor and save its value back
* to the model, he will first call editState() and then
* setModelData().
*
* The default implementation assumes a read-only delegate, and
* returns a boost::any().
*
* \sa setEditState(), setModelData()
*/
virtual boost::any editState(WWidget *widget) const;
/*! \brief Sets the editor data from the editor state.
*
* When the View scrolls back into view an item that was being edited,
* he will use setEditState() to allow the editor to restore its current
* editor state.
*
* The default implementation assumes a read-only delegate and does
* nothing.
*
* \sa editState()
*/
virtual void setEditState(WWidget *widget, const boost::any& value) const;
/*! \brief Returns whether the edited value is valid.
*
* The default implementation does nothing and returns Valid.
*
* \sa WValidator::validate()
*/
virtual WValidator::State validate(const WModelIndex& index,
const boost::any& editState) const;
/*! \brief Saves the edited data to the model.
*
* The View will use this method to save the edited value to the model.
* The \p editState is first fetched from the editor using editState().
*
* The default implementation assumes a read-only delegate does
* nothing.
*/
virtual void setModelData(const boost::any& editState,
WAbstractItemModel *model,
const WModelIndex& index) const;
/*! \brief %Signal which indicates that an editor needs to be closed.
*
* The delegate should emit this signal when it decides for itself
* that it should be closed (e.g. because the user confirmed the
* edited value or cancelled the editing). The View will then rerender
* the item if needed.
*
* The second boolean argument passed to the signal is a flag which
* indicates whether the editor feels that the value should be saved or
* cancelled.
*
* \sa WAbstractItemView::closeEditor()
*/
Signal<WWidget *, bool>& closeEditor() { return closeEditor_; }
/*! \brief %Signal which indicates that an editor needs to be closed.
*
* \sa closeEditor()
*/
const Signal<WWidget *, bool>& closeEditor() const { return closeEditor_; }
private:
Signal<WWidget *, bool> closeEditor_;
};
}
#endif // WABSTRACTITEMDELEGATE_H_
|