Public Types | Public Member Functions | Protected Member Functions | List of all members
ifile::CSystemLocationComp Class Reference

Provider of system pathes. More...

#include <CSystemLocationComp.h>

Inheritance diagram for ifile::CSystemLocationComp:
icomp::CComponentBase ifile::IFileNameParam icomp::IComponent iser::ISerializable istd::IPolymorphic istd::IChangeable istd::IPolymorphic

Public Types

enum  SpecialLocations {
  SL_WORKING_DIRECTORY = 100, SL_EXECUTABLE_DIRECTORY = 101, SL_EXECUTABLE_FILE = 102, SL_EXECUTABLE_CONTENT = 103,
  SL_SHARED_COMPANY_DIRECTORY = 104, SL_SHARED_APPDATA_DIRECTORY = 105
}
 
typedef icomp::CComponentBase BaseClass
 
- Public Types inherited from ifile::IFileNameParam
enum  PathType { PT_UNKNOWN, PT_FILE, PT_DIRECTORY, PT_URL }
 
- Public Types inherited from istd::IChangeable
enum  ChangeFlags {
  CF_ACF_INTERNAL = 0, CF_ALL_DATA, CF_ANY, CF_DESTROYING,
  CF_DELEGATED, CF_NO_UNDO
}
 Data model change notification flags. More...
 
enum  SupportedOperations {
  SO_NONE = 0, SO_OBSERVE = 1 << 0, SO_COPY = 1 << 1, SO_CLONE = 1 << 2,
  SO_COMPARE = 1 << 3, SO_RESET = 1 << 4
}
 Flags for supported operations. More...
 
enum  CompatibilityMode { CM_STRICT, CM_WITHOUT_REFS, CM_WITH_REFS, CM_CONVERT }
 Control how relationship betweeen objects are interpreted. More...
 

Public Member Functions

virtual int GetPathType () const
 Get intended type of the path. More...
 
virtual const QString & GetPath () const
 Get path. More...
 
virtual void SetPath (const QString &path)
 Set path. More...
 
virtual bool Serialize (iser::IArchive &archive)
 Load or store state of this object as a archive stream. More...
 
- Public Member Functions inherited from icomp::CComponentBase
 CComponentBase ()
 Create component and assign it to specific context. More...
 
virtual const ICompositeComponentGetParentComponent (bool ownerOnly=false) const
 Get parent of this component. More...
 
virtual void * GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
 Get access to specified component interface. More...
 
virtual const IComponentContextGetComponentContext () const
 Get access to component context describing all application-specified component information loaded from components registry. More...
 
virtual void SetComponentContext (const icomp::IComponentContext *contextPtr, const ICompositeComponent *parentPtr, bool isParentOwner)
 Set component context of this component. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 
- Public Member Functions inherited from iser::ISerializable
virtual quint32 GetMinimalVersion (int versionId) const
 Get minimal needed version to correct storing of this data. More...
 
- Public Member Functions inherited from istd::IChangeable
virtual int GetSupportedOperations () const
 Get set of flags for supported operations. More...
 
virtual bool CopyFrom (const IChangeable &object, CompatibilityMode mode=CM_WITHOUT_REFS)
 Copy this object from another one. More...
 
virtual bool IsEqual (const IChangeable &object) const
 Compare this object with another object. More...
 
virtual IChangeableCloneMe (CompatibilityMode mode=CM_WITHOUT_REFS) const
 Make a copy of this object. More...
 
virtual bool ResetData (CompatibilityMode mode=CM_WITHOUT_REFS)
 Reset data to its default state. More...
 
virtual void BeginChanges (const ChangeSet &changeSet)
 Starts the change transaction. More...
 
virtual void EndChanges (const ChangeSet &changeSet)
 Ends the change transaction. More...
 
virtual void BeginChangeGroup (const ChangeSet &changeSet)
 Starts group of changes. More...
 
virtual void EndChangeGroup (const ChangeSet &changeSet)
 Ends group of changes. More...
 

Protected Member Functions

virtual void OnComponentCreated ()
 
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active. More...
 
virtual void OnComponentDestroyed ()
 
virtual const
icomp::IRealComponentStaticInfo
GetComponentStaticInfo () const =0
 Get access to static info of this component. More...
 
- Protected Member Functions inherited from istd::IChangeable
virtual void OnBeginChanges ()
 Callback function for begin change event. More...
 
virtual void OnEndChanges (const ChangeSet &changeSet)
 Callback function for end change event. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from istd::IChangeable
static const ChangeSetGetNoChanges ()
 Get empty set of changes. More...
 
static const ChangeSetGetAnyChange ()
 Get anonymous change set. More...
 
static const ChangeSetGetAllChanges ()
 Get anonymous change set. More...
 
static const ChangeSetGetDelegatedChanges ()
 Get delegated change set. More...
 
- Static Protected Member Functions inherited from icomp::CComponentBase
static const
icomp::IRealComponentStaticInfo
InitStaticInfo (IComponent *componentPtr)
 
static QByteArray GetComponentId (const icomp::IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())
 

Detailed Description

Provider of system pathes.

Definition at line 20 of file CSystemLocationComp.h.

Member Typedef Documentation

Definition at line 25 of file CSystemLocationComp.h.

Member Enumeration Documentation

Enumerator
SL_WORKING_DIRECTORY 

Working directory of the application.

SL_EXECUTABLE_DIRECTORY 

Path to the directory where the executable file is located.

SL_EXECUTABLE_FILE 

Path to the exectuable file.

SL_EXECUTABLE_CONTENT 

Directory for the application's content.

Normally the same as SL_EXECUTABLE_DIRECTORY, but for Mac OS this is SL_EXECUTABLE_DIRECTORY/Content folder of the application bundle

SL_SHARED_COMPANY_DIRECTORY 

User- and application-independent company data folder.

Under Windows $(CompanyName))

SL_SHARED_APPDATA_DIRECTORY 

User-independent application's data folder.

Under Windows $(CompanyName)[]$(ApplicationName))

Definition at line 27 of file CSystemLocationComp.h.

Member Function Documentation

virtual const QString& ifile::CSystemLocationComp::GetPath ( ) const
virtual

Get path.

Implements ifile::IFileNameParam.

virtual int ifile::CSystemLocationComp::GetPathType ( ) const
virtual

Get intended type of the path.

See Also
PathType

Implements ifile::IFileNameParam.

virtual void ifile::CSystemLocationComp::OnComponentCreated ( )
protectedvirtual

Reimplemented from icomp::CComponentBase.

virtual bool ifile::CSystemLocationComp::Serialize ( iser::IArchive archive)
virtual

Load or store state of this object as a archive stream.

Type of operation is depending on archive type.

See Also
iser::IArchive

Implements iser::ISerializable.

virtual void ifile::CSystemLocationComp::SetPath ( const QString &  path)
virtual

Set path.

Implements ifile::IFileNameParam.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy