kexi

Kexi::ActionCategories Class Reference

#include <kexiactioncategories.h>

Public Member Functions

void addAction (const char *name, int categories, KexiPart::ObjectTypes supportedObjectType1=(KexiPart::ObjectTypes) 0, KexiPart::ObjectTypes supportedObjectType2=(KexiPart::ObjectTypes) 0, KexiPart::ObjectTypes supportedObjectType3=(KexiPart::ObjectTypes) 0, KexiPart::ObjectTypes supportedObjectType4=(KexiPart::ObjectTypes) 0, KexiPart::ObjectTypes supportedObjectType5=(KexiPart::ObjectTypes) 0, KexiPart::ObjectTypes supportedObjectType6=(KexiPart::ObjectTypes) 0, KexiPart::ObjectTypes supportedObjectType7=(KexiPart::ObjectTypes) 0, KexiPart::ObjectTypes supportedObjectType8=(KexiPart::ObjectTypes) 0)
void addGlobalAction (const char *name)
void addPartItemAction (const char *name)
void addWindowAction (const char *name, KexiPart::ObjectTypes supportedObjectType1=(KexiPart::ObjectTypes) 0, KexiPart::ObjectTypes supportedObjectType2=(KexiPart::ObjectTypes) 0, KexiPart::ObjectTypes supportedObjectType3=(KexiPart::ObjectTypes) 0, KexiPart::ObjectTypes supportedObjectType4=(KexiPart::ObjectTypes) 0, KexiPart::ObjectTypes supportedObjectType5=(KexiPart::ObjectTypes) 0, KexiPart::ObjectTypes supportedObjectType6=(KexiPart::ObjectTypes) 0, KexiPart::ObjectTypes supportedObjectType7=(KexiPart::ObjectTypes) 0, KexiPart::ObjectTypes supportedObjectType8=(KexiPart::ObjectTypes) 0)
void setAllObjectTypesSupported (const char *name, bool set)
int actionCategories (const char *name) const
bool actionSupportsObjectType (const char *name, KexiPart::ObjectTypes objectType) const

Protected Attributes

Private * d

Detailed Description

A set of functions used to declare action categories.

Note: we do not declare actions used in design/text view modes, because the categories are used in the data view, for now in the 'assign action to a push button' function.

Definition at line 43 of file kexiactioncategories.h.

Constructor & Destructor Documentation

◆ ActionCategories()

ActionCategories::ActionCategories ( )

Definition at line 76 of file kexiactioncategories.cpp.

◆ ~ActionCategories()

ActionCategories::~ActionCategories ( )

Definition at line 81 of file kexiactioncategories.cpp.

Member Function Documentation

◆ actionCategories()

int ActionCategories::actionCategories ( const char * name) const
Returns
categories for action name (a combination of ActionCategory enum values). If there is no such actions declared at all, -1 is returned.

Definition at line 137 of file kexiactioncategories.cpp.

◆ actionSupportsObjectType()

bool ActionCategories::actionSupportsObjectType ( const char * name,
KexiPart::ObjectTypes objectType ) const
Returns
true if action name supports objectType. Only works for actions of WindowAction category.

Definition at line 143 of file kexiactioncategories.cpp.

◆ addAction()

void ActionCategories::addAction ( const char * name,
int categories,
KexiPart::ObjectTypes supportedObjectType1 = (KexiPart::ObjectTypes)0,
KexiPart::ObjectTypes supportedObjectType2 = (KexiPart::ObjectTypes)0,
KexiPart::ObjectTypes supportedObjectType3 = (KexiPart::ObjectTypes)0,
KexiPart::ObjectTypes supportedObjectType4 = (KexiPart::ObjectTypes)0,
KexiPart::ObjectTypes supportedObjectType5 = (KexiPart::ObjectTypes)0,
KexiPart::ObjectTypes supportedObjectType6 = (KexiPart::ObjectTypes)0,
KexiPart::ObjectTypes supportedObjectType7 = (KexiPart::ObjectTypes)0,
KexiPart::ObjectTypes supportedObjectType8 = (KexiPart::ObjectTypes)0 )

Declares action name for categories category (a combination of ActionCategory enum values). The categories is merged with the previous declaration (if any). supportedObjectTypes can be specified for ActionCategory::WindowAction to declare what object types the action allows, it is a combination of KexiPart::ObjectTypes enum values.

Definition at line 86 of file kexiactioncategories.cpp.

◆ addGlobalAction()

void Kexi::ActionCategories::addGlobalAction ( const char * name)
inline

Definition at line 63 of file kexiactioncategories.h.

◆ addPartItemAction()

void Kexi::ActionCategories::addPartItemAction ( const char * name)
inline

Convenience function for adding action of category "part item", uses addAction().

Definition at line 67 of file kexiactioncategories.h.

◆ addWindowAction()

void Kexi::ActionCategories::addWindowAction ( const char * name,
KexiPart::ObjectTypes supportedObjectType1 = (KexiPart::ObjectTypes)0,
KexiPart::ObjectTypes supportedObjectType2 = (KexiPart::ObjectTypes)0,
KexiPart::ObjectTypes supportedObjectType3 = (KexiPart::ObjectTypes)0,
KexiPart::ObjectTypes supportedObjectType4 = (KexiPart::ObjectTypes)0,
KexiPart::ObjectTypes supportedObjectType5 = (KexiPart::ObjectTypes)0,
KexiPart::ObjectTypes supportedObjectType6 = (KexiPart::ObjectTypes)0,
KexiPart::ObjectTypes supportedObjectType7 = (KexiPart::ObjectTypes)0,
KexiPart::ObjectTypes supportedObjectType8 = (KexiPart::ObjectTypes)0 )
inline

Convenience function for adding action of category "window", uses addAction(). supportedObjectTypes is a combination of KexiPart::ObjectTypes enum values describing object types supported by the action.

Definition at line 73 of file kexiactioncategories.h.

◆ setAllObjectTypesSupported()

void ActionCategories::setAllObjectTypesSupported ( const char * name,
bool set )

If set is true, action with name name will support any possible object type that can be checked by actionSupportsObjectType(). Makes sense for action of category Kexi::WindowActionCategory.

Definition at line 128 of file kexiactioncategories.cpp.

Member Data Documentation

◆ d

Private* Kexi::ActionCategories::d
protected

Definition at line 100 of file kexiactioncategories.h.


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