KSambaShare
#include <KSambaShare>
Signals | |
void | changed () |
Public Member Functions | |
bool | areGuestsAllowed () const |
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 |
QString | lastSystemErrorString () const |
QStringList | sharedDirectories () const |
QStringList | shareNames () const |
Public Member Functions inherited from QObject | |
QObject (QObject *parent) | |
QBindable< QString > | bindableObjectName () |
bool | blockSignals (bool block) |
const QObjectList & | children () const const |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const |
void | deleteLater () |
void | destroyed (QObject *obj) |
bool | disconnect (const char *signal, const QObject *receiver, const char *method) const const |
bool | disconnect (const QObject *receiver, const char *method) const const |
void | dumpObjectInfo () const const |
void | dumpObjectTree () const const |
QList< QByteArray > | dynamicPropertyNames () const const |
virtual bool | event (QEvent *e) |
virtual bool | eventFilter (QObject *watched, QEvent *event) |
T | findChild (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const |
QList< T > | findChildren (const QString &name, Qt::FindChildOptions options) const const |
QList< T > | findChildren (Qt::FindChildOptions options) const const |
bool | inherits (const char *className) const const |
void | installEventFilter (QObject *filterObj) |
bool | isQuickItemType () const const |
bool | isWidgetType () const const |
bool | isWindowType () const const |
void | killTimer (int id) |
virtual const QMetaObject * | metaObject () const const |
void | moveToThread (QThread *targetThread) |
QString | objectName () const const |
void | objectNameChanged (const QString &objectName) |
QObject * | parent () const const |
QVariant | property (const char *name) const const |
Q_CLASSINFO (Name, Value) | |
Q_EMIT Q_EMIT | |
Q_ENUM (...) | |
Q_ENUM_NS (...) | |
Q_ENUMS (...) | |
Q_FLAG (...) | |
Q_FLAG_NS (...) | |
Q_FLAGS (...) | |
Q_GADGET Q_GADGET | |
Q_GADGET_EXPORT (EXPORT_MACRO) | |
Q_INTERFACES (...) | |
Q_INVOKABLE Q_INVOKABLE | |
Q_MOC_INCLUDE Q_MOC_INCLUDE | |
Q_NAMESPACE Q_NAMESPACE | |
Q_NAMESPACE_EXPORT (EXPORT_MACRO) | |
Q_OBJECT Q_OBJECT | |
Q_PROPERTY (...) | |
Q_REVISION Q_REVISION | |
Q_SET_OBJECT_NAME (Object) | |
Q_SIGNAL Q_SIGNAL | |
Q_SIGNALS Q_SIGNALS | |
Q_SLOT Q_SLOT | |
Q_SLOTS Q_SLOTS | |
T | qobject_cast (const QObject *object) |
T | qobject_cast (QObject *object) |
QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT | |
void | removeEventFilter (QObject *obj) |
void | setObjectName (const QString &name) |
void | setObjectName (QAnyStringView name) |
void | setParent (QObject *parent) |
bool | setProperty (const char *name, const QVariant &value) |
bool | setProperty (const char *name, QVariant &&value) |
bool | signalsBlocked () const const |
int | startTimer (int interval, Qt::TimerType timerType) |
int | startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType) |
QThread * | thread () const const |
Static Public Member Functions | |
static KSambaShare * | instance () |
Static Public Member Functions inherited from QObject | |
QMetaObject::Connection | connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type) |
QMetaObject::Connection | connect (const QObject *sender, PointerToMemberFunction signal, Functor functor) |
bool | disconnect (const QMetaObject::Connection &connection) |
bool | disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method) |
bool | disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method) |
bool | disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method) |
QString | tr (const char *sourceText, const char *disambiguation, int n) |
Additional Inherited Members | |
Public Types inherited from QObject | |
typedef | QObjectList |
Properties inherited from QObject | |
objectName | |
Protected Member Functions inherited from QObject | |
virtual void | childEvent (QChildEvent *event) |
virtual void | connectNotify (const QMetaMethod &signal) |
virtual void | customEvent (QEvent *event) |
virtual void | disconnectNotify (const QMetaMethod &signal) |
bool | isSignalConnected (const QMetaMethod &signal) const const |
int | receivers (const char *signal) const const |
QObject * | sender () const const |
int | senderSignalIndex () const const |
virtual void | timerEvent (QTimerEvent *event) |
Detailed Description
This class lists Samba user shares and monitors them for addition, update and removal.
Singleton class, call instance() to get an instance.
Definition at line 25 of file ksambashare.h.
Member Function Documentation
◆ areGuestsAllowed()
bool KSambaShare::areGuestsAllowed | ( | ) | const |
Check whether usershares may enable guests.
System-level configuration may disable usershare guests and prevent saving KSambaShareData with UserGuestPermission set.
- Returns
true
when usershares may allow guest access
- Since
- 5.74
◆ changed
|
signal |
Emitted when a share is updated, added or removed.
◆ getShareByName()
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.
◆ getSharesByPath()
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.
◆ instance()
|
static |
- Returns
- the one and only instance of KSambaShare.
◆ isDirectoryShared()
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.
◆ isShareNameAvailable()
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.
◆ lastSystemErrorString()
QString KSambaShare::lastSystemErrorString | ( | ) | const |
Used to obtain UserShareSystemError error strings.
This is usually the verbatim stderr of internal helper commands and may contain newlines. Do not use this to obtain error strings for other error types!
- Returns
- QString containing the most relevant last stderr
- Since
- 5.74
◆ sharedDirectories()
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.
◆ shareNames()
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.
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 16:58:45 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.