kexi

Kexi::ActionCategories Class Reference

#include <kexiactioncategories.h>

List of all members.


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.


Public Member Functions

 ActionCategories ()
 ~ActionCategories ()
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

Member Function Documentation

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.

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.

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.

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.

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.

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.


The documentation for this class was generated from the following files:
KDE Home | KDE Accessibility Home | Description of Access Keys