Kexi API Documentation (2.0 alpha)
Overview Class Hierarchy Classes Classes (annotated) Members Source Files
Kexi::ActionCategories

Kexi::ActionCategories Class Reference

#include <kexiactioncategories.h>

Inheritance diagram for Kexi::ActionCategories:

KShared 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)
 Convenience function for adding action of category "part item", uses addAction().
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

Constructor & Destructor Documentation

ActionCategories::ActionCategories (   ) 
 

Definition at line 76 of file kexiactioncategories.cpp.

Referenced by Kexi::actionCategories().

ActionCategories::~ActionCategories (   ) 
 

Definition at line 81 of file kexiactioncategories.cpp.

References d.

Member Function Documentation

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.

References d.

Referenced by KActionsListViewBase::init().

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.

References d.

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.

References d.

Referenced by KexiMainWindowImpl::initActions().

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

Definition at line 63 of file kexiactioncategories.h.

References Kexi::GlobalActionCategory.

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.

References Kexi::PartItemActionCategory.

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.

References Kexi::WindowActionCategory.

Referenced by KexiMainWindowImpl::initActions().

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.

References d, and kexiwarn.

Referenced by KexiMainWindowImpl::initActions().

Member Data Documentation

Private* Kexi::ActionCategories::d [protected]
 

Definition at line 99 of file kexiactioncategories.h.

Referenced by actionCategories(), actionSupportsObjectType(), addAction(), setAllObjectTypesSupported(), and ~ActionCategories().

The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for Kexi 2.0 alpha.
Documentation copyright © 2002-2007 the Kexi Team.
Generated on Tue Apr 1 20:50:37 2008 by doxygen 1.4.2 written by Dimitri van Heesch, © 1997-2003