SophiaFramework UNIVERSE 5.3 |
#include <SFBAppHistory.h.hpp>
class SFBAppHistory : public SFBQuery;
SFMTYPEDEFWRAPPER(SFBAppHistory)
BREW 2.0 | BREW 2.1 | BREW 3.1 | BREW 4.0 |
---|---|---|---|
X | X | O | O |
Public Functions | |
---|---|
SFCError |
Back( Void )
Move the SFBAppHistory to the previous history entry in the history list/
|
SFCError |
Current(
SInt32Ptr idx
)
Find out where in the history list this instance of SFBAppHistory points.
|
SFCError |
Forward( Void )
Move the SFBAppHistory to the next history entry in the history list.
|
SFCError |
GetArgs(
ACharPtr dest
, SInt32Ptr size
)
Retrieve the startup argument string for the history entry.
|
SFCError |
GetArgs(
SFXAnsiStringPtr dest
)
Retrieve the startup argument string for the history entry.
|
SFCError |
GetClass(
AEECLSID* clsid
)
Retrieve the AEECLSID of the app history entry the SFBAppHistory is pointed to.
|
AEECLSID |
GetClass( Void )
Retrieve the AEECLSID of the app history entry the SFBAppHistory is pointed to.
|
SFCError |
GetData(
ACharConstPtr name
, VoidPtr buf
, SInt32Ptr size
)
Retrieve history context sensitive data associated with the specified input name stored in previous calls to SFBAppHistory::SetData.
|
SFCError |
GetData(
SFXAnsiStringConstRef name
, SFXBufferPtr buf
)
Retrieve history context sensitive data associated with the specified input name stored in previous calls to SFBAppHistory::SetData.
|
SFCError |
GetReason(
UInt32Ptr reason
)
Get the start-reason associated with this history entry.
|
SFCError |
GetResumeData(
VoidPtr buf
, SInt32Ptr size
)
A macro call to SFBAppHistory::GetData with no name (NULL) associated with the data.
|
SFCError |
GetResumeData(
SFXBufferPtr buf
)
A macro call to SFBAppHistory::GetData with no name (NULL) associated with the data.
|
SFCError |
Insert(
AEECLSID clsid
, ACharConstPtr args
)
Insert a new history entry immediately "Back" of the current entry.
|
SFCError |
Insert(
AEECLSID clsid
, SFXAnsiStringConstRef args
)
Insert a new history entry immediately "Back" of the current entry.
|
SFCError |
Move(
SInt32 idx
)
Move a history entry to a new position.
|
static SFBAppHistorySmp |
NewInstance(
SFCErrorPtr exception = null
)
Create a new SFBAppHistory instance.
|
static SFBAppHistorySmp |
NewInstance(
AEECLSID id
, SFCErrorPtr exception = null
)
Create a new SFBAppHistory instance.
|
SFCError |
Remove( Void )
Remove the current entry from the app history list.
|
SFCError |
SetData(
ACharConstPtr name
, VoidPtr buf
, SInt32 size
)
Store history context sensitive data associated with the input name.
|
SFCError |
SetData(
SFXAnsiStringConstRef name
, SFXBufferPtr buf
)
Store history context sensitive data associated with the input name.
|
SFCError |
SetReason(
UInt32 reason
)
Set the start-reason associated with this history entry.
|
SFCError |
SetResumeData(
VoidPtr buf
, SInt32 size
)
A macro call to ,SFBAppHistory::SetData with no name (null) associated with the data.
|
SFCError |
SetResumeData(
SFXBufferPtr buf
)
A macro call to ,SFBAppHistory::SetData with no name (null) associated with the data.
|
SFCError |
Top( Void )
Resets the SFBAppHistory to point to the top-visible entry.
|
SFCError |
QueryInterface(
AEECLSID clsid
, VoidHandle handle
)
(inherits from SFBQuery)
Ask an object for another API contract from the object in question.
|
SFCError |
QueryInterface(
AEECLSID clsid
, SFBBaseSmpPtr handle
)
(inherits from SFBQuery)
Ask an object for another API contract from the object in question.
|
SFBBaseSmp |
QueryInterface(
AEECLSID clsid
)
(inherits from SFBQuery)
Ask an object for another API contract from the object in question.
|
Void |
Self(
AEECLSID clsidReq
, SFBQuerySmpPtr clone
, AEECLSID clsidImp
)
(inherits from SFBQuery)
Helper macro for those implementing an object with a single interface.
|
SFBQuerySmp |
Self(
AEECLSID clsidReq
, AEECLSID clsidImp
)
(inherits from SFBQuery)
Helper macro for those implementing an object with a single interface.
|
Protected Functions | |
---|---|
static SFBBaseSmp |
FactoryByCreate(
AEECLSID id
, SFCErrorPtr exception = null
)
(inherits from SFBBase)
Create the instance for the specified ClassID's interface.
|
static SFBBaseSmp |
FactoryByQuery(
SFBQuerySmpConstRef query
, AEECLSID id
, SFCErrorPtr exception = null
)
(inherits from SFBBase)
Create the instance for the specified ClassID's interface using the SFBQuery instance.
|
[ public ] SFCError Back(Void);
[ public ] SFCError Current( SInt32Ptr idx // filled with the distance from the top-visible app, if the entry has been unlinked, pnIdx is set to -1 );
[ public ] SFCError Forward(Void);
[ public ] SFCError GetArgs( ACharPtr dest // buffer to fill SInt32Ptr size // on input, pointer to integer of size in bytes of the buffer, on output, size of pBuffer necessary to hold the arguments );
[ public ] SFCError GetArgs( SFXAnsiStringPtr dest // buffer to fill );
[ public ] SFCError GetClass( AEECLSID* clsid // pointer to an AEECLSID to be filled with the current entry's class id );
[ public ] AEECLSID GetClass(Void);
[ public ] SFCError GetData( ACharConstPtr name // name associated with the data VoidPtr buf // buffer to fill SInt32Ptr size // on input, pointer to integer of size in bytes of the buffer, on output, size of pBuffer necessary to hold the resume data );
[ public ] SFCError GetData( SFXAnsiStringConstRef name // name associated with the data SFXBufferPtr buf // buffer to fill );
Calling this function with null for the buf will fill size with the size of the buffer.
[ public ] SFCError GetResumeData( VoidPtr buf // buffer to fill SInt32Ptr size // on input, pointer to integer of size in bytes of the buffer, on output, size of pBuffer necessary to hold the resume data );
[ public ] SFCError GetResumeData( SFXBufferPtr buf // buffer to fill );
BREW API IAppHistory_GetResumeData | SFBAppHistory::GetData |
[ public ] SFCError Insert( AEECLSID clsid //AEECLSID of the requested application ACharConstPtr args // pointer to startup arguments );
[ public ] SFCError Insert( AEECLSID clsid // AEECLSID of the requested application SFXAnsiStringConstRef args // pointer to startup arguments );
To insert an entry, the caller must either be an instance of cls or have PL_SYSTEM.
BREW API IAppHistory_Move | SFBAppHistory::Insert | SFBAppHistory::Remove | SFBAppHistory::Current
[ public, static ] SFBAppHistorySmp NewInstance( SFCErrorPtr exception = null // Error );
[ public, static ] SFBAppHistorySmp NewInstance( AEECLSID id // Class ID SFCErrorPtr exception = null // Error );
[ public ] SFCError Remove(Void);
[ public ] SFCError SetData( ACharConstPtr name // name associated with the data VoidPtr buf // buffer to copy SInt32 size // size in bytes of the data );
[ public ] SFCError SetData( SFXAnsiStringConstRef name // name associated with the data SFXBufferPtr buf // buffer to copy );
[ public ] SFCError SetResumeData( VoidPtr buf // buffer to copy SInt32 size // size in bytes of the data );
[ public ] SFCError SetResumeData( SFXBufferPtr buf // buffer to copy );
BREW API IAppHistory_SetResumeData | SFBAppHistory::SetData |
[ public ] SFCError Top(Void);
Copyright(c) 2002 - 2024 Sophia Cradle Incorporated All Rights Reserved. |