PopupActionProvider Class Reference

#include <popupactionprovider.h>

Inheritance diagram for PopupActionProvider:

Public Member Functions
virtual	~PopupActionProvider ()
virtual bool	executeAction (int menu, int &id, const std::vector< ObjectHolder * > &os, NormalModePopupObjects &popup, KigPart &doc, KigWidget &w, NormalMode &m)=0
virtual void	fillUpMenu (NormalModePopupObjects &popup, int menu, int &nextfree)=0

Detailed Description

This class is an abstract class.

Its role is to fill up the NormalModePopupObjects with useful actions..

Definition at line 35 of file popupactionprovider.h.

Constructor & Destructor Documentation

virtual PopupActionProvider::~PopupActionProvider ( )

inlinevirtual

Definition at line 38 of file popupactionprovider.h.

Member Function Documentation

virtual bool PopupActionProvider::executeAction ( int  menu, int &  id, const std::vector< ObjectHolder * > &  os, NormalModePopupObjects &  popup, KigPart &  doc, KigWidget &  w, NormalMode &  m  )

pure virtual

try to execute the id'th action you added to menu menu in popup popup ( first is 0 ).

Return true if this action does indeed belong to you ( is not greater than the number of actions you added ). Else return false, and subtract the number of actions you added from id. This requires you to keep a record of how much actions you added ( unless it's a fixed number, of course ).

Implemented in ObjectConstructorActionsProvider, PropertiesActionsProvider, BuiltinDocumentActionsProvider, ObjectTypeActionsProvider, BuiltinObjectActionsProvider, and NameObjectActionsProvider.

virtual void PopupActionProvider::fillUpMenu ( NormalModePopupObjects &  popup, int  menu, int &  nextfree  )

pure virtual

add all your entries to menu menu in popup popup.

Set nextfree to the next free index..

Implemented in ObjectConstructorActionsProvider, PropertiesActionsProvider, BuiltinDocumentActionsProvider, ObjectTypeActionsProvider, BuiltinObjectActionsProvider, and NameObjectActionsProvider.

---

The documentation for this class was generated from the following file:

• popupactionprovider.h