src/hbwidgets/editors/hbabstractedit.cpp
changeset 30 80e4d18b72f5
parent 28 b7da29130b0e
equal deleted inserted replaced
28:b7da29130b0e 30:80e4d18b72f5
    91 
    91 
    92     \li Editor content:  Both rich text and plain text are supported in HbAbstractEdit. Depending on the actual 
    92     \li Editor content:  Both rich text and plain text are supported in HbAbstractEdit. Depending on the actual 
    93     editor widget only one or the other type might be supported. Plain text content is set with 
    93     editor widget only one or the other type might be supported. Plain text content is set with 
    94     method \ref setPlainText. Method \ref toPlainText returns the content converted to plain text. 
    94     method \ref setPlainText. Method \ref toPlainText returns the content converted to plain text. 
    95 
    95 
    96     \li Focus control: Editor is responsble for controlling the input panel visibility. In some situations special editor may need to also handle this, but in general it is always handled by HbAbstractEdit. 
    96     \li Focus control: Editor is responsble for controlling the input panel visibility. In some situations special editor may need to also handle this,
    97     Input panel is closed when editor loses focus.
    97     but in general it is always handled by HbAbstractEdit. Input panel is closed when editor loses focus.
       
    98     However when setting the editor focus programmatically with setFocus() it is the responsibility of client to control the visibility of input panel.
    98 
    99 
    99     \li Cursor control: A convenience method \ref moveCursor can also be used to move the cursor.
   100     \li Cursor control: A convenience method \ref moveCursor can also be used to move the cursor.
   100 
   101 
   101     \li Scrolling: When e.g. the size of the content exceeds the size of editor, method \ref setScrollable
   102     \li Scrolling: When e.g. the size of the content exceeds the size of editor, method \ref setScrollable
   102     can be used to make the editor scrollable. Method isScrollable tells whether the editor is scrollable or not. 
   103     can be used to make the editor scrollable. Method isScrollable tells whether the editor is scrollable or not. 
   105     \li Input validation: The validator for restricting the content input is set with method \ref setValidator. Only \ref HbValidator
   106     \li Input validation: The validator for restricting the content input is set with method \ref setValidator. Only \ref HbValidator
   106     based validators can be used.
   107     based validators can be used.
   107 
   108 
   108     \section composition Widget composition
   109     \section composition Widget composition
   109 
   110 
   110     Editor widget consists of these sub-items visible in the picture. 
   111     The size of the canvas is always same as the size of the document, and the width of the scroll area is same as the width of the document.
   111     In this example editor shows only one visible line of the content.
       
   112 
       
   113     \image html editor_composition.jpg
       
   114 
       
   115     The size of the canvas is always same as the size of the document, and the width of the scroll area 
       
   116     is same as the width of the document. The editor margins are defined in the CSS.
       
   117 
       
   118 */
   112 */
   119 
   113 
   120 /*!
   114 /*!
   121     \fn void HbAbstractEdit::contentsChanged()
   115     \fn void HbAbstractEdit::contentsChanged()
   122 
   116