Caret.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------+
|
|   Supplied under applicable software license agreement.
|
|   Copyright (c) 2018 Bentley Systems, Incorporated. All rights reserved.
|
+---------------------------------------------------------------------------------------*/
#pragma once

#include "TextAPICommon.h"

BEGIN_BENTLEY_DGNPLATFORM_NAMESPACE



//=======================================================================================
//
//  @remark Required library : DgnPlatform<ApiNumber>.lib  i.e. DgnPlatform5.lib
// @bsiclass                                                     Bentley Systems
//=======================================================================================
CLRPUBLIC struct Caret : public RefCountedBase
    {
private:
    virtual void MakeClassAbstract() = 0;
public:

    public: DGNPLATFORM_EXPORT CaretPtr Clone () const;
    
    public: DGNPLATFORM_EXPORT bool IsAt (CaretCR) const;
    
    public: DGNPLATFORM_EXPORT bool IsBefore (CaretCR) const;
    
    public: DGNPLATFORM_EXPORT bool IsBeforeOrAt (CaretCR) const;
    
    public: DGNPLATFORM_EXPORT bool IsAfter (CaretCR) const;
    
    public: DGNPLATFORM_EXPORT bool IsAfterOrAt (CaretCR) const;
    
    public: DGNPLATFORM_EXPORT bool IsAtBeginning () const;
    
    public: DGNPLATFORM_EXPORT bool IsAtEnd () const;
    
    public: DGNPLATFORM_EXPORT ParagraphCP GetCurrentParagraphCP () const;
    
    public: DGNPLATFORM_EXPORT RunCP GetCurrentRunCP () const;
    
    public: DGNPLATFORM_EXPORT bool         IsInField() const;

    public: DGNPLATFORM_EXPORT TextFieldPtr GetCurrentField() const;

    public: DGNPLATFORM_EXPORT WChar GetPreviousCharacter () const;
    
    public: DGNPLATFORM_EXPORT WChar GetNextCharacter () const;

    public: DGNPLATFORM_EXPORT BentleyStatus MoveToNextParagraph ();
    
    public: DGNPLATFORM_EXPORT BentleyStatus MoveToNextRun ();
    
    public: DGNPLATFORM_EXPORT BentleyStatus MoveToNextField ();

    public: DGNPLATFORM_EXPORT BentleyStatus MoveToNextRunInParagraph ();
    
    public: DGNPLATFORM_EXPORT BentleyStatus MoveToNextCharacter ();
    
    public: DGNPLATFORM_EXPORT BentleyStatus MoveToPreviousParagraph ();
    
    public: DGNPLATFORM_EXPORT BentleyStatus MoveToPreviousRun ();
    
    public: DGNPLATFORM_EXPORT BentleyStatus MoveToPreviousRunInParagraph ();

    public: DGNPLATFORM_EXPORT BentleyStatus MoveToPreviousCharacter ();
    
    public: DGNPLATFORM_EXPORT ParagraphIterator CreateParagraphBegin () const;
    
    public: DGNPLATFORM_EXPORT ParagraphIterator CreateParagraphEnd () const;
    
    public: DGNPLATFORM_EXPORT RunIterator CreateRunBegin () const;
    
    public: DGNPLATFORM_EXPORT RunIterator CreateRunEnd () const;
    
    }; // Caret


END_BENTLEY_DGNPLATFORM_NAMESPACE