org.kde.koala

Class KCModuleInfo

public class KCModuleInfo extends Object implements QtSupport

A class that provides information about a KCModule KCModuleInfo provides various technical information, such as icon, library etc. about a KCModule.n

Author: Daniel Molkentin

UNKNOWN: Any values set with the set functions is not written back with KCModuleInfo it only reads value from the desktop file. A class that provides information about a KCModule

Constructor Summary
protected KCModuleInfo(Class dummy)
KCModuleInfo(String desktopFile)
Constructs a KCModuleInfo.
KCModuleInfo(KCModuleInfo rhs)
Same as above but takes a KCModuleInfo as argument.
KCModuleInfo()
Same as above but creates an empty KCModuleInfo.
Method Summary
Stringcomment()
voiddispose()
Delete the wrapped C++ instance ahead of finalize()
StringdocPath()
StringfactoryName()
Returns the module's factory name, if it's set.
StringfileName()
protected voidfinalize()
Deletes the wrapped C++ instance
Stringhandle()
Stringicon()
booleanisDisposed()
Has the wrapped C++ instance been deleted?
ArrayListkeywords()
Stringlibrary()
protected voidloadAll()
Reads the service entries specific for KCModule from the desktop file.
StringmoduleName()
booleanneedsRootPrivileges()
booleanneedsTest()
booleanop_equals(KCModuleInfo rhs)
Equal operator
booleanop_not_equals(KCModuleInfo rhs)
protected voidsetComment(String comment)
Sets the object's name.
protected voidsetDocPath(String p)
Sets the object's documentation path
protected voidsetHandle(String handle)
Sets the factory name
protected voidsetIcon(String icon)
Sets the object's icon.
protected voidsetKeywords(String[] keyword)
Sets the object's keywords.
protected voidsetLibrary(String lib)
Set the object's library
protected voidsetName(String name)
Sets the object's name.
protected voidsetNeedsRootPrivileges(boolean needsRootPrivileges)
Toggles whether the represented module needs root privileges.
protected voidsetNeedsTest(boolean val)
Sets if the module should be tested for loading.
protected voidsetWeight(int weight)
Sets the object's weight property which determines in what order modules will be displayed.
intweight()

Constructor Detail

KCModuleInfo

protected KCModuleInfo(Class dummy)

KCModuleInfo

public KCModuleInfo(String desktopFile)
Constructs a KCModuleInfo.

Parameters: desktopFile the desktop file representing the module, or the name of the module.

UNKNOWN: a KCModuleInfo object will have to be manually deleted, it is not done automatically for you. Constructs a KCModuleInfo.

KCModuleInfo

public KCModuleInfo(KCModuleInfo rhs)
Same as above but takes a KCModuleInfo as argument.

Parameters: rhs specifies the module

UNKNOWN: Same as above but takes a KCModuleInfo as argument.

KCModuleInfo

public KCModuleInfo()
Same as above but creates an empty KCModuleInfo. You should not normally call this.

UNKNOWN: Same as above but creates an empty KCModuleInfo.

Method Detail

comment

public String comment()

Returns: the module's (translated) comment field

UNKNOWN:

dispose

public void dispose()
Delete the wrapped C++ instance ahead of finalize()

docPath

public String docPath()

Returns: the path of the module's documentation

UNKNOWN:

factoryName

public String factoryName()
Returns the module's factory name, if it's set. If not, the library name is returned.

Returns: the module's factory name

UNKNOWN: Returns the module's factory name, if it's set.

fileName

public String fileName()

Returns: the filename of the .desktop file that describes the KCM

UNKNOWN:

finalize

protected void finalize()
Deletes the wrapped C++ instance

handle

public String handle()

Returns: a handle (usually the contents of the FactoryName field)

UNKNOWN:

icon

public String icon()

Returns: the module's icon name

UNKNOWN:

isDisposed

public boolean isDisposed()
Has the wrapped C++ instance been deleted?

keywords

public ArrayList keywords()

Returns: the keywords associated with this KCM.

UNKNOWN:

library

public String library()

Returns: the library name

UNKNOWN:

loadAll

protected void loadAll()
Reads the service entries specific for KCModule from the desktop file. The usual desktop entries are read in init.

UNKNOWN: Reads the service entries specific for KCModule from the desktop file.

moduleName

public String moduleName()

Returns: the module\'s (translated) name

UNKNOWN:

needsRootPrivileges

public boolean needsRootPrivileges()

Returns: whether the module might require root permissions

UNKNOWN:

needsTest

public boolean needsTest()

Returns: true if the module should be conditionally loaded.

UNKNOWN:

op_equals

public boolean op_equals(KCModuleInfo rhs)
Equal operator

Returns: true if rhs equals itself

UNKNOWN: Equal operator

op_not_equals

public boolean op_not_equals(KCModuleInfo rhs)

Returns: true if rhs is not equal itself

UNKNOWN:

setComment

protected void setComment(String comment)
Sets the object's name.

Parameters: comment the new comment

UNKNOWN: Sets the object's name.

setDocPath

protected void setDocPath(String p)
Sets the object's documentation path

Parameters: p the new documentation path

UNKNOWN: Sets the object's documentation path

setHandle

protected void setHandle(String handle)
Sets the factory name

Parameters: handle The new factory name

UNKNOWN: Sets the factory name

setIcon

protected void setIcon(String icon)
Sets the object's icon.

Parameters: icon the name of the new icon

UNKNOWN: Sets the object's icon.

setKeywords

protected void setKeywords(String[] keyword)
Sets the object's keywords.

Parameters: keyword the new keywords

UNKNOWN: Sets the object's keywords.

setLibrary

protected void setLibrary(String lib)
Set the object's library

Parameters: lib the name of the new library without any extensions or prefixs.

UNKNOWN: Set the object's library

setName

protected void setName(String name)
Sets the object's name.

Parameters: name the new name

UNKNOWN: Sets the object's name.

setNeedsRootPrivileges

protected void setNeedsRootPrivileges(boolean needsRootPrivileges)
Toggles whether the represented module needs root privileges. Use with caution.

Parameters: needsRootPrivileges if module needs root privilges

UNKNOWN: Toggles whether the represented module needs root privileges.

setNeedsTest

protected void setNeedsTest(boolean val)
Sets if the module should be tested for loading.

Parameters: val the value to set

UNKNOWN: Sets if the module should be tested for loading.

setWeight

protected void setWeight(int weight)
Sets the object's weight property which determines in what order modules will be displayed. Default is 100.

Parameters: weight the new weight

UNKNOWN: Sets the object's weight property which determines in what order modules will be displayed.

weight

public int weight()

Returns: the weight of the module which determines the order of the pages in the KCMultiDialog. It's set by the X-KDE-Weight field.

UNKNOWN: