Public Types | Public Member Functions | Protected Attributes | Friends | List of all members
KFormDesigner::WidgetInfo Class Reference

#include <widgetfactory.h>

Inheritance diagram for KFormDesigner::WidgetInfo:
KexiDataAwareWidgetInfo

Public Types

typedef TQPtrList< WidgetInfo > List
 
typedef TQAsciiDict< WidgetInfo > Dict
 

Public Member Functions

 WidgetInfo (WidgetFactory *f)
 
 WidgetInfo (WidgetFactory *f, const char *parentFactoryName, const char *inheritedClassName=0)
 
TQString pixmap () const
 
TQCString className () const
 
TQString namePrefix () const
 
TQString name () const
 
TQString description () const
 
TQString includeFileName () const
 
TQValueList< TQCString > alternateClassNames () const
 
TQString savingName () const
 
WidgetFactory * factory () const
 
void setPixmap (const TQString &p)
 
void setClassName (const TQCString &s)
 
void setName (const TQString &n)
 
void setNamePrefix (const TQString &n)
 
void setDescription (const TQString &desc)
 
void setIncludeFileName (const TQString &name)
 
void addAlternateClassName (const TQCString &alternateName, bool override=false)
 
bool isOverriddenClassName (const TQCString &alternateName) const
 
void setSavingName (const TQString &saveName)
 
void setAutoSyncForProperty (const char *propertyName, tristate flag)
 
tristate autoSyncForProperty (const char *propertyName) const
 
TQCString parentFactoryName () const
 
WidgetInfo * inheritedClass () const
 
void setCustomTypeForProperty (const char *propertyName, int type)
 
int customTypeForProperty (const char *propertyName) const
 

Protected Attributes

TQCString m_parentFactoryName
 
TQCString m_inheritedClassName
 
WidgetInfo * m_inheritedClass
 

Friends

class WidgetLibrary
 

Detailed Description

This class holds properties of widget classes provided by a factory.

Definition at line 65 of file widgetfactory.h.

Member Typedef Documentation

◆ Dict

typedef TQAsciiDict<WidgetInfo> KFormDesigner::WidgetInfo::Dict

Definition at line 69 of file widgetfactory.h.

◆ List

typedef TQPtrList<WidgetInfo> KFormDesigner::WidgetInfo::List

Definition at line 68 of file widgetfactory.h.

Constructor & Destructor Documentation

◆ WidgetInfo() [1/2]

WidgetInfo::WidgetInfo ( WidgetFactory *  f)

Definition at line 58 of file widgetfactory.cpp.

◆ WidgetInfo() [2/2]

WidgetInfo::WidgetInfo ( WidgetFactory *  f,
const char *  parentFactoryName,
const char *  inheritedClassName = 0 
)

Definition at line 67 of file widgetfactory.cpp.

◆ ~WidgetInfo()

WidgetInfo::~WidgetInfo ( )
virtual

Definition at line 80 of file widgetfactory.cpp.

Member Function Documentation

◆ addAlternateClassName()

void WidgetInfo::addAlternateClassName ( const TQCString &  alternateName,
bool  override = false 
)

Sets alternate names for this class. If this name is found when loading a .ui file, the className() will be used instead. It allows to support both KDE and TQt versions of widget, without duplicating code. As a rule, className() should always return a class name which is inherited from alternate class. For example TDEListView class has alternate TQListView class.

override parameter overrides class name of a widget, even if it was implemented in other factory. By default it's set to false, what means that no other class is overridden by this widget class if there is already a class implementing it (no matter in which factory). By forced overriding existing class with other - custom, user will be able to see more or less properties and experience different behaviour. For example, in Kexi application, KLineEdit class contains additional "datasource" property for binding to database sources.

Definition at line 87 of file widgetfactory.cpp.

◆ alternateClassNames()

TQValueList< TQCString > KFormDesigner::WidgetInfo::alternateClassNames ( ) const
inline

Definition at line 92 of file widgetfactory.h.

◆ autoSyncForProperty()

tristate WidgetInfo::autoSyncForProperty ( const char *  propertyName) const
Returns
autoSync override value (true or false) for propertyName. If cancelled value is returned, there is no overriding (the default).

Definition at line 122 of file widgetfactory.cpp.

◆ className()

TQCString KFormDesigner::WidgetInfo::className ( ) const
inline
Returns
the class name of a widget e.g. 'TQLineEdit'

Definition at line 81 of file widgetfactory.h.

◆ customTypeForProperty()

int WidgetInfo::customTypeForProperty ( const char *  propertyName) const
Returns
custom type for property propertyName. If no specific custom type has been assigned, KoProperty::Auto is returned.
See also
setCustomTypeForProperty()

Definition at line 140 of file widgetfactory.cpp.

◆ description()

TQString KFormDesigner::WidgetInfo::description ( ) const
inline

Definition at line 90 of file widgetfactory.h.

◆ factory()

WidgetFactory * KFormDesigner::WidgetInfo::factory ( ) const
inline

Definition at line 94 of file widgetfactory.h.

◆ includeFileName()

TQString KFormDesigner::WidgetInfo::includeFileName ( ) const
inline

Definition at line 91 of file widgetfactory.h.

◆ inheritedClass()

WidgetInfo * KFormDesigner::WidgetInfo::inheritedClass ( ) const
inline

Definition at line 151 of file widgetfactory.h.

◆ isOverriddenClassName()

bool WidgetInfo::isOverriddenClassName ( const TQCString &  alternateName) const
Returns
true is a class alternateName is defined as alternate name with 'override' flag set to true, using addAlternateClassName(). If this flag is set to false (the default) or there's no such alternate class name defined.

Definition at line 101 of file widgetfactory.cpp.

◆ name()

TQString KFormDesigner::WidgetInfo::name ( ) const
inline
Returns
the real name e.g. 'Line Edit', showed eg in ObjectTreeView

Definition at line 88 of file widgetfactory.h.

◆ namePrefix()

TQString KFormDesigner::WidgetInfo::namePrefix ( ) const
inline
Returns
the name used to name widget, that will appear eg in scripts (must not contain spaces nor non-latin1 characters)

Definition at line 85 of file widgetfactory.h.

◆ parentFactoryName()

TQCString KFormDesigner::WidgetInfo::parentFactoryName ( ) const
inline

Definition at line 149 of file widgetfactory.h.

◆ pixmap()

TQString KFormDesigner::WidgetInfo::pixmap ( ) const
inline
Returns
a pixmap associated with the widget

Definition at line 78 of file widgetfactory.h.

◆ savingName()

TQString KFormDesigner::WidgetInfo::savingName ( ) const
inline

Definition at line 93 of file widgetfactory.h.

◆ setAutoSyncForProperty()

void WidgetInfo::setAutoSyncForProperty ( const char *  propertyName,
tristate  flag 
)

Sets autoSync flag for property propertyName. This allows to override autoSync flag for certain widget's property, because e.g. KoProperty::Editor can have autoSync flag set to false or true, but not all properties have to comply with that. flag equal to cancelled value means there is no overriding (the default).

Definition at line 106 of file widgetfactory.cpp.

◆ setClassName()

void KFormDesigner::WidgetInfo::setClassName ( const TQCString &  s)
inline

Definition at line 97 of file widgetfactory.h.

◆ setCustomTypeForProperty()

void WidgetInfo::setCustomTypeForProperty ( const char *  propertyName,
int  type 
)

Sets custom type type for property propertyName. This allows to override default type, especially when custom property and custom property editor item has to be used.

Definition at line 130 of file widgetfactory.cpp.

◆ setDescription()

void KFormDesigner::WidgetInfo::setDescription ( const TQString &  desc)
inline

Definition at line 100 of file widgetfactory.h.

◆ setIncludeFileName()

void KFormDesigner::WidgetInfo::setIncludeFileName ( const TQString &  name)
inline

Sets the C++ include file corresponding to this class, that uic will need to add when creating the file. You don't have to set this for TQt std widgets.

Definition at line 104 of file widgetfactory.h.

◆ setName()

void KFormDesigner::WidgetInfo::setName ( const TQString &  n)
inline

Definition at line 98 of file widgetfactory.h.

◆ setNamePrefix()

void KFormDesigner::WidgetInfo::setNamePrefix ( const TQString &  n)
inline

Definition at line 99 of file widgetfactory.h.

◆ setPixmap()

void KFormDesigner::WidgetInfo::setPixmap ( const TQString &  p)
inline

Definition at line 96 of file widgetfactory.h.

◆ setSavingName()

void KFormDesigner::WidgetInfo::setSavingName ( const TQString &  saveName)
inline

Sets the name that will be written in the .ui file when saving. This name must be one of alternate names (or loading will be impossible).

On form data saving to XML .ui format, saveName is used instead, so .ui format is not broken and still usable with other software as TQt Designer. Custom properties are saved as well with 'stdset' attribute set to 0.

Definition at line 136 of file widgetfactory.h.

Friends And Related Symbol Documentation

◆ WidgetLibrary

friend class WidgetLibrary
friend

Definition at line 181 of file widgetfactory.h.

Member Data Documentation

◆ m_inheritedClass

WidgetInfo* KFormDesigner::WidgetInfo::m_inheritedClass
protected

Definition at line 165 of file widgetfactory.h.

◆ m_inheritedClassName

TQCString KFormDesigner::WidgetInfo::m_inheritedClassName
protected

Used for inheriting widgets between factories.

Definition at line 164 of file widgetfactory.h.

◆ m_parentFactoryName

TQCString KFormDesigner::WidgetInfo::m_parentFactoryName
protected

Definition at line 164 of file widgetfactory.h.

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