KSambaShare

#include <KSambaShare>

Inheritance diagram for KSambaShare:

Signals

void changed ()
 

Public Member Functions

bool areGuestsAllowed () const
 
KSambaShareData getShareByName (const QString &name) const
 
QList< KSambaShareDatagetSharesByPath (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
 
QString smbConfPath () const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
bool blockSignals (bool block)
 
const QObjectListchildren () 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 ()
 
void dumpObjectInfo () const const
 
void dumpObjectTree ()
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_DISABLE_COPY (Class)
 
 Q_DISABLE_COPY_MOVE (Class)
 
 Q_DISABLE_MOVE (Class)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 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
 
qFindChild (const QObject *obj, const QString &name)
 
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
 
QList< T > qFindChildren (const QObject *obj, const QString &name)
 
qobject_cast (QObject *object)
 
qobject_cast (const QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
 
QThreadthread () const const
 

Static Public Member Functions

static KSambaShareinstance ()
 
- 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 *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
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, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Public Attributes inherited from QObject
typedef QObjectList
 
- 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
 
QObjectsender () 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

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

Definition at line 559 of file ksambashare.cpp.

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
namethe 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 541 of file ksambashare.cpp.

QList< KSambaShareData > KSambaShare::getSharesByPath ( const QString path) const

Returns a list of KSambaShareData matching the path.

Parameters
paththe 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 547 of file ksambashare.cpp.

KSambaShare * KSambaShare::instance ( )
static
Returns
the one and only instance of KSambaShare.

Definition at line 573 of file ksambashare.cpp.

bool KSambaShare::isDirectoryShared ( const QString path) const

Whether or not the given path is shared by Samba.

Parameters
paththe path to check if it is shared by Samba.
Returns
whether the given path is shared by Samba.

Definition at line 517 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
namethe share name.
Returns
whether the given name is already being used or not.
Since
4.7

Definition at line 523 of file ksambashare.cpp.

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

Definition at line 553 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 535 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 529 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:
Since 4.6, the conf file is no longer used

Definition at line 510 of file ksambashare.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Tue Jan 26 2021 23:00:46 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.