CWsGraphic Class Reference

#include <w32std.h>

class CWsGraphic : public CBase

Inherits from

  • CWsGraphic
    Public Member Functions
    ~CWsGraphic()
    IMPORT_C voidDestroy()
    IMPORT_C const TWsGraphicId &Id()
    IMPORT_C TBoolIsActive()
    Protected Member Functions
    CWsGraphic()
    IMPORT_C voidBaseConstructL(TUid, TUid, const TDesC8 &)
    IMPORT_C voidBaseConstructL(TUid, const TDesC8 &)
    IMPORT_C voidBaseConstructL(const TWsGraphicId &, TUid, const TDesC8 &)
    IMPORT_C TIntFlush()
    IMPORT_C voidSendMessage(const TDesC8 &)
    IMPORT_C TIntSendSynchronMessage(const TDesC8 &)
    IMPORT_C RWsSession &Session()
    IMPORT_C voidSetGraphicExtension(MWsObjectProvider *)
    virtual IMPORT_C TIntShare(TSecureId)
    virtual IMPORT_C TIntShareGlobally()
    virtual IMPORT_C TIntUnShare(TSecureId)
    virtual IMPORT_C TIntUnShareGlobally()
    Inherited Functions
    CBase::CBase()
    CBase::Delete(CBase *)
    CBase::Extension_(TUint,TAny *&,TAny *)
    CBase::operator new(TUint)
    CBase::operator new(TUint,TAny *)
    CBase::operator new(TUint,TLeave)
    CBase::operator new(TUint,TLeave,TUint)
    CBase::operator new(TUint,TUint)
    CBase::~CBase()

    Detailed Description

    Client representation of a window-server-side piece of artwork owned by this Client

    Constructor & Destructor Documentation

    CWsGraphic ( )

    IMPORT_CCWsGraphic()[protected]

    Default Constructor.

    ~CWsGraphic ( )

    IMPORT_C~CWsGraphic()

    Destructor.

    Member Function Documentation

    BaseConstructL ( TUid, TUid, const TDesC8 & )

    IMPORT_C voidBaseConstructL(TUidaUid,
    TUidaType,
    const TDesC8 &aData
    )[protected]
    Constructs a piece of non-transient graphic artwork.
    capability
    ProtServ
    ParameterDescription
    aUidGraphic artwork UID.
    aTypeGraphic artwork type.
    aDataUser specific data.

    BaseConstructL ( TUid, const TDesC8 & )

    IMPORT_C voidBaseConstructL(TUidaType,
    const TDesC8 &aData
    )[protected]

    Constructs a piece of transient graphic artwork.

    ParameterDescription
    aTypeGraphic artwork type.
    aDataUser specific data.

    BaseConstructL ( const TWsGraphicId &, TUid, const TDesC8 & )

    IMPORT_C voidBaseConstructL(const TWsGraphicId &aReplace,
    TUidaType,
    const TDesC8 &aData
    )[protected]

    Atomically replace the artwork that already exists with this artwork. If failure to properly construct the replacement artwork occurs, the replacee artwork will remain

    ParameterDescription
    aReplaceGraphic artwork which will be replaced.
    aTypeNew graphic artwork type.
    aDataUser specific data.

    Destroy ( )

    IMPORT_C voidDestroy()

    Destroys the corresponding CWsGraphicDrawer instance on the server

    Flush ( )

    IMPORT_C TIntFlush()const [protected]

    Flushes window server command buffer

    Returns: One of system-wide error codes.

    Id ( )

    IMPORT_C const TWsGraphicId &Id()const

    Returns graphic artwork Id.

    Returns: Graphic artwork Id. KNullWsGraphicId if graphic artwork is not active.

    IsActive ( )

    IMPORT_C TBoolIsActive()const

    Checks whether a peer of this graphic artwork has been fully constructed on the server.

    Returns: ETrue if this graphic artwork has a peer CWsGraphic on the server.

    SendMessage ( const TDesC8 & )

    IMPORT_C voidSendMessage(const TDesC8 &aData)const [protected]

    Sends message to this graphic artwork peer on the server.

    ParameterDescription
    aDataUser specific data.

    SendSynchronMessage ( const TDesC8 & )

    IMPORT_C TIntSendSynchronMessage(const TDesC8 &aData)const [protected]

    Session ( )

    IMPORT_C RWsSession &Session()[protected]

    SetGraphicExtension ( MWsObjectProvider * )

    IMPORT_C voidSetGraphicExtension(MWsObjectProvider *aExt)[protected]

    Share ( TSecureId )

    IMPORT_C TIntShare(TSecureIdaClientId)[protected, virtual]

    Explicitly shares this graphic artwork with client sessions with the specified Secure ID.

    ParameterDescription
    aClientIdthe Secure ID of the client sessions to share with.

    Returns: KErrNone If the graphic artwork was shared, else one of the system-wide error codes.

    ShareGlobally ( )

    IMPORT_C TIntShareGlobally()[protected, virtual]

    Shares the graphic artwork with all the client sessions. Sharing globally trumps explicit shares.

    Returns: KErrNone if the graphic is globally shared, else one of the system-wide error codes.

    UnShare ( TSecureId )

    IMPORT_C TIntUnShare(TSecureIdaClientId)[protected, virtual]

    Stops this graphic artwork from being shared with all client sessions with the specific Secure ID. ShareGlobally() trumps explicit sharing.

    ParameterDescription
    aClientIdthe Secure ID of the client sessions to not share with

    Returns: KErrNone if the graphic artwork is no longer shared, KErrNotFound if the graphic was not shared anyway, else one of the system-wide error codes

    UnShareGlobally ( )

    IMPORT_C TIntUnShareGlobally()[protected, virtual]

    Prevents this graphic artwork from being shared with all the client sessions. A graphic artwork that isn't shared explicitly is only available to clients it has been explicitly shared with using Share().

    Returns: KErrNone if the graphic is not globally shared, else one of the system-wide error codes.

    © Nokia 2011.