KSambaShare Class Reference

#include <ksambashare.h>

Inheritance diagram for KSambaShare:

List of all members.

Signals
void	changed ()
Public Member Functions
virtual	~KSambaShare ()
KSambaShareData	getShareByName (const QString &name) const
QList< KSambaShareData >	getSharesByPath (const QString &path) const
bool	isDirectoryShared (const QString &path) const
bool	isShareNameAvailable (const QString &name) const
QStringList	sharedDirectories () const
QStringList	shareNames () const
QString	smbConfPath () const
Static Public Member Functions
static KSambaShare *	instance ()

---

Detailed Description

This class lists Samba user shares and monitors them for addition, update and removal.

Singleton class, call instance() to get an instance.

---

Constructor & Destructor Documentation

KSambaShare::~KSambaShare

(

)

[virtual]

Definition at line 447 of file ksambashare.cpp.

---

Member Function Documentation

void KSambaShare::changed

(

)

[signal]

Emitted when a share is updated, added or removed.

KSambaShareData KSambaShare::getShareByName

(

const QString &

name

)

const

Returns the KSambaShareData object of the share name.

Parameters:

name	the share name.

Returns:

the KSambaShareData object that matches the name.

an empty KSambaShareData object if there isn't match for the name.

Since:

4.7

Definition at line 486 of file ksambashare.cpp.

QList< KSambaShareData > KSambaShare::getSharesByPath

(

const QString &

path

)

const

Returns a list of KSambaShareData matching the path.

Parameters:

path	the path that wants to get KSambaShareData object.

Returns:

the QList of KSambaShareData objects that matches the path.

an empty QList if there aren't matches for the given path.

Since:

4.7

Definition at line 492 of file ksambashare.cpp.

KSambaShare * KSambaShare::instance

(

)

[static]

Returns:

the one and only instance of KSambaShare.

Definition at line 498 of file ksambashare.cpp.

bool KSambaShare::isDirectoryShared

(

const QString &

path

)

const

Whether or not the given path is shared by Samba.

Parameters:

path	the path to check if it is shared by Samba.

Returns:

whether the given path is shared by Samba.

Definition at line 462 of file ksambashare.cpp.

bool KSambaShare::isShareNameAvailable

(

const QString &

name

)

const

Tests that a share name is valid and does not conflict with system users names or shares.

Parameters:

name	the share name.

Returns:

whether the given name is already being used or not.

Since:

4.7

Definition at line 468 of file ksambashare.cpp.

QStringList KSambaShare::sharedDirectories

(

)

const

Returns a list of all directories shared by local users in Samba.

The resulting list is not sorted.

Returns:

a list of all directories shared by Samba.

Definition at line 480 of file ksambashare.cpp.

QStringList KSambaShare::shareNames

(

)

const

Returns the list of available shares.

Returns:

a QStringList containing the user shares names.

an empty list if there aren't user shared directories.

Since:

4.7

Definition at line 474 of file ksambashare.cpp.

QString KSambaShare::smbConfPath

(

)

const

Returns the path to the used smb.conf file or empty string if no file was found.

Returns:

the path to the smb.conf file

Deprecated:

Definition at line 456 of file ksambashare.cpp.

---

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

• ksambashare.h
• ksambashare.cpp