From: Paul Wisbey Date: Fri, 20 Mar 2015 13:45:06 +0000 (+0000) Subject: Removed old programming guide sections X-Git-Tag: dali_1.0.38~11^2~41 X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=commitdiff_plain;h=9dc0a8037eb3a78fa907767e9b6de1690ba28271 Removed old programming guide sections Change-Id: Ie8db0c65ca884a7fb210013b555bc6b520322d69 --- diff --git a/docs/content/main-page.h b/docs/content/main-page.h index f742f01..e40f89c 100644 --- a/docs/content/main-page.h +++ b/docs/content/main-page.h @@ -14,7 +14,7 @@ * - \link hello-world Hello World - explained \endlink * * \section Actors Actors - * - \link image-text-mesh-actor Image, Text and Mesh actors \endlink + * - \link image-mesh-actor Image and Mesh actors \endlink * - \link event-system Event Handling \endlink * - \link custom-actor Custom Actor \endlink * @@ -32,10 +32,7 @@ * * \section UIControls UI Controls * - \link item-view Item View \endlink - * - \link text-view Text View \endlink - * - \link text-input Text Input \endlink * - \link scroll-view Scroll View \endlink - * - \link markup-processor Markup Processor \endlink * - \link size-negotiation Size Negotiation \endlink * - \link type-registration Type Registration \endlink * - \link properties Properties \endlink diff --git a/docs/content/programming-guide/image-text-mesh-actor.h b/docs/content/programming-guide/image-mesh-actor.h similarity index 66% rename from docs/content/programming-guide/image-text-mesh-actor.h rename to docs/content/programming-guide/image-mesh-actor.h index 014c95e..c579101 100644 --- a/docs/content/programming-guide/image-text-mesh-actor.h +++ b/docs/content/programming-guide/image-mesh-actor.h @@ -1,12 +1,11 @@ -/*! \page image-text-mesh-actor Image, Text and Mesh actors +/*! \page image-mesh-actor Image and Mesh actors * * *

Overview

- * The Dali::ImageActor, Dali::TextActor, Dali::MeshActor are inherited from Dali::Actor and provide means to display resources like Images, Text and Geometries (Triangle meshes) on the stage. + * The Dali::ImageActor & Dali::MeshActor are inherited from Dali::Actor and provide means to display resources like Images and Geometries (Triangle meshes) on the stage. * All the Dali::Actor methods can be called on them.
* * - ImageActor: An actor for displaying Images. It allows the developer to display a Dali::Image object on the stage.
- * - TextActor: An actor for displaying text.
* - MeshActor: An actor for displaying one or more mesh geometries. It may have children, which may be plain actors or other mesh actors.
* *

Image Actor

@@ -107,80 +106,6 @@ * @endcode * * - * - * - * - *

Text Actor

- * - * - *

Displaying Text

- * The text displayed by the text actor is initialised/set on construction, which can be changed later. - * - * @code - * Dali::TextActor myTextActor = Dali::TextActor::New("Hi"); - * std::string str("Hello"); - * if (myTextActor.GetText() != str) - * { - * myTextActor.SetText(str); - * } - * @endcode - * - * - *

Fonts

- * It's possible to specify a font for the text displayed by the text actor. - * @code - * Dali::Font freeSerif = Dali::Font::New("FreeSerif", 8); - * myTextActor.SetFont(freeSerif); - * @endcode - * - * - *

Ellipsis

- * It is possible to display an ellipsis in the TextActor when the text is truncated. - * @code - * std::string str("..."); - * if (myTextActor.GetEllipsis() != str) - * { - * myTextActor.SetEllipsis(str); - * } - * @endcode - * - *

Style

- * - * By calling the Dali::TextActor::SetTextStyle or by passing a Dali::TextStyle to the constructor, it's possible to define styling parameters such as color, font, size, outline, glow, shadow, italics or bold. - * @code - * TextStyle style; - * style.SetItalic( true ); - * - * myTextActor.SetTextStyle( style ); - * @endcode - * - * @see Dali::TextActor::SetTextStyle() - * - * It is possible to specify the text fit style for the text actor. The developer can specify whether the ellipsis should appear on the left, centre, or at the end - * @code - * // default : NONE - * myTextActor.SetTextFitStyle(TextUtilities::EllipsizeRight); - * @endcode - * - *

Loading state

- * It is possible to get the font loading status for the text and do processing accordingly. - * @code - * // observe text loading and do some processing when it's done - * if( Dali::ResourceLoadingSucceeded == myTextActor.GetLoadingState() ) - * { - * // text already loaded, Do the processing here - * OnTextFontLoaded(); - * } - * else - * { - * // text not yet loaded, Connect to the SignalTextAvailable signal and Do the processing when it occurs - * myTextActor.SignalTextAvailable().Connect(this, &MyClass::OnTextFontLoaded); - * } - * @endcode - * - * - * - * *

Mesh Actor

* *

Construction

diff --git a/docs/content/programming-guide/markup-processor.h b/docs/content/programming-guide/markup-processor.h deleted file mode 100644 index bd8ba9a..0000000 --- a/docs/content/programming-guide/markup-processor.h +++ /dev/null @@ -1,184 +0,0 @@ -/*! \page markup-processor Markup processor - * - *

Overview

- * - * Dali::Toolkit::MarkupProcessor functions provide mechanisms to build and modify a Dali::Toolkit::MarkupProcessor::StyledTextArray used to store text with style. - * - *

Build a styled text array from a markup string

- * - * Dali::Toolkit::MarkupProcessor::GetStyledTextArray() could be used to convert an html-ish markup string into a styled text array. This string uses html-ish tags to - * define the text's style as follows: - * - * - * - * See also \ref color, \ref special_characters and \ref example for more details. - * - *

Get a markup string from a styled text array

- * - * Dali::Toolkit::MarkupProcessor::GetMarkupString() could be used to convert a styled text array into an html-ish markup string. - * - *

Modify a styled text array

- * - * Different functions are provided to modify whole or part of a styled text array with a given style. A mask could be used to modify only some properties of the style. - * - * @see Dali::Toolkit::MarkupProcessor::SetTextStyle( StyledTextArray& styledTextArray, const TextStyle& style, TextStyle::Mask mask ) - * @see Dali::Toolkit::MarkupProcessor::SetTextStyle( const Text& text, StyledTextArray& styledTextArray, const TextStyle& style, TextStyle::Mask mask ) - * @see Dali::Toolkit::MarkupProcessor::SetTextStyleToRange( StyledTextArray& styledTextArray, const TextStyle& style, TextStyle::Mask mask, std::size_t begin, std::size_t end ) - * - *

Appendix

- * \section color Color - * - * Different options could be used to define a color: - * - * - * - * \section special_characters Special characters - * - * \< and \> characters are used to build the html-ish tags. To type them is needed to add a back slash character in front of them. - * @note in c and c++ the back slash is represented with a double back slash '\\\\'. - * - * i.e. text.SetText("a \\< b \\< c"); - * \image html text-view/AlessBlessC.png - * - * It transform any pair CR+LF new line characters into a single LF new line character. - * - * \section fonts Font Style, Weight and Smooth - * - * This appendix shows the differences and relations between the font style, the font weight, the smoothness and the italics. - * - * When a font is loaded, Dali uses different mechanisms to modify the render of glyphs.

- * i.e \Hello World\ produces the "Hello World" bellow. - * \image html text-view/FontAppendix01.png - * By adding the \ \ \ tags to the markup string or using the Dali::TextStyle::SetItalics(), Dali::TextStyle::SetWeight() or Dali::TextStyle::SetSmoothEdge() methods, - * Dali modifies how glyphs of the same font are rendered.

- * i.e \\Hello World\\ - * \image html text-view/FontAppendix02.png - * i.e \\Hello World\\ - * \image html text-view/FontAppendix03.png - * - * The smooth parameter can be used to adjust the thickness of the rendered glyphs.

- * i.e
\\Hello World\\\

- * \Hello World\\

- * \\Hello World\\\

- * \\Hello World\\\

- * \\Hello World\\ - * - * \image html text-view/FontAppendix04.png - * - * All "Hello World" above have been rendered using the same font, saving some memory. Alternatively, the platform can provide fonts with different styles.
- * - * i.e. Samsung platform provides among others:
- * Samsung Sans:style=Light
- * Samsung Sans:style=Regular
- * Samsung Sans:style=Medium
- * - * \Hello World\\

- * \Hello World\\

- * \Hello World\ - * \image html text-view/FontAppendix05.png - * - * The three "Hello World" above have been rendered with three different fonts.
- * - * The fc-list command can be executed on the platform command line to check with fonts and which styles are supported. - * - * \section example Example - * - * \code - * const std::string text( "" - * "Italics: 기울임 꼴
" - * "Underline: 밑줄
" - * "Bold: 두꺼운
" - * "Font FreeSerif
" - * "Shadow: 그림자
" - * "Glow: 빛나다
" - * "Outline: 윤곽선
" - * "Smooth: 부드럽게
" - * "" ); - * - * Toolkit::MarkupProcessor::StyledTextArray styledText; - * Toolkit::MarkupProcessor::GetStyledTextArray( text, styledText, true ); - * - * Toolkit::TextView textView = Toolkit::TextView::New( styledText ); - * textView.SetParentOrigin( ParentOrigin::CENTER ); - * - * Stage::GetCurrent().Add( textView ); - * \endcode - * - * \image html text-view/text-view.png - * Text generated with the example above. - */ diff --git a/docs/content/programming-guide/text-input.h b/docs/content/programming-guide/text-input.h deleted file mode 100644 index cc24e46..0000000 --- a/docs/content/programming-guide/text-input.h +++ /dev/null @@ -1,92 +0,0 @@ -/*! \page text-input Text Input - * - TextInput is a Dali::Actor which allows the input of text from an on-screen virtual keyboard or attached hardware keyboard. - - -

Basic Text Input Set-up

- - The below code creates a new TextInput - - @code - Dali::Toolkit::TextInput myTextInput; - myTextInput = Dali::Toolkit::TextInput::New(); - @endcode - - The following code sets the size and adds it to the stage - @code - myTextInput.SetParentOrigin(ParentOrigin::CENTER); - myTextInput.SetSize(stageWidth*0.25f, stageWidth*0.5f); - Stage::GetCurrent().Add(myTextInput); - @endcode - - For a TextInput to receive input from the keyboard it must be in edit mode. - - To enter edit mode the below call can be made. If the virtual on-screen keyboard is supported then it will be displayed. - Internally TextInput will set focus to this TextInput and key events will be sent to it. - - @code myTextInput.SetEditable(true);@endcode - - After this call the TextInput will receive any key press. If you have more than one TextInput the focus will change between them when the edit mode is - initiated on any Text Input. - - To automatically start edit mode when the TextInput is "tapped" you can call the following: - - @code myTextInput.SetEditOnTouch()@endcode - - You will then need to end edit mode by making the call below or swiping away the keyboard (Virtual On-screen Keyboard) - @code myTextInput.SetEditable(false);@endcode - - The call will hide the virtual keyboard if previously shown by Text Input. - - Then the input string as plain text can be retrieved using - @code Dali::Toolkit::TextInput::GetText()@endcode - -

Text Selection

- - The SetTextSelectable API when set to true enables text to be highlighted, once highlighted the text style can be changed, - the text can be cut, or copied, overwritten with new text or deleted. - - The user does a Long-Press on the text to get the option of text selection. - - @code Dali::Toolkit::TextInput::SetTextSelectable( true ) @endcode - -

Text Styling

- - In conjunction with TextView and the Markup processor, TextInput enables text to be styled. - - There are 3 ways to effect the text styling. - - SetActiveStyle, new input text is set to the Red glow style - @code - TextStyle style; - style.SetGlow ( true, Dali::Color::RED ); - myTextInput.SetActiveStyle( style, MarkupProcessor::GLOW ); - @endcode - - ApplyStyle, selected/highlighted text now has the Red glow style - @code - TextStyle style; - style.SetGlow ( true, Dali::Color::RED ); - myTextInput.ApplyStyle( style, MarkupProcessor::GLOW ); - @endcode - - ApplyStyleToAll, all text now has the Red glow style - @code - TextStyle style; - style.SetGlow ( true, Dali::Color::RED ); - myTextInput.ApplyStyleToAll( style, MarkupProcessor::GLOW ); - @endcode - - Then the input string with Mark-up defining the style can be retrieved using - @code Dali::Toolkit::TextInput::GetMarkupText()@endcode - This would be usefull if you wish to save the styled text the user has input so it can be re-displayed another time. - - Signals are emitted when style changes. - - See Dali::Toolkit::TextInput::StyleMask for available styling options. - - - - - */ - diff --git a/docs/content/programming-guide/text-view.h b/docs/content/programming-guide/text-view.h deleted file mode 100644 index b64b895..0000000 --- a/docs/content/programming-guide/text-view.h +++ /dev/null @@ -1,447 +0,0 @@ -/*! \page text-view Text View - * - * \section overview Overview - * - * The Dali::Toolkit::TextView class is a UI Dali::Toolkit::Control designed to extend the capabilities of the basic Dali::TextActor. - * It provides support for multi-line wrapping, multi-language font detection, text alignment, scrolling and styling. - * - * Dali::Toolkit::TextView also provides text layout information which could be used in other UI Dali::Toolkit::Control classes or other applications. - * - * \section multiline Multi-line wrapping - * - * Different multi-line and exceed policies could be set to layout the given text. - * - * Both multi-line and exceed policies work together. - * Dali::Toolkit::TextView::MultilinePolicy policies define how to wrap a line if it doesn't fit inside the boundary's width - * whereas Dali::Toolkit::TextView::ExceedPolicy policies define what to do if the wrapped text is bigger than the text view's boundary. - * - * i.e. \e SplitByWord could be used as 'multi-line policy' to wrap a line if it's too long. If one of the words is longer than the text-view's width, \e Split could be - * used as 'width exceed policy' to split a word in different lines. If the text is too long and exceeds the text-view's height, \e EllipsizedEnd could be - * used as 'height exceed policy' to render only the text which fits inside the boundaries of the text-view. - * - * @see more \ref examples. - * - * \subsection multiline_policies Multi-line policies - * - *
    - *
  • Split by new line character. - * Text will be wrapped when an end of line \\n or \
     is found. - * - *
  • Split by word. - * Text will be wrapped when an end of line \\n or \
     is found or if the text doesn't fit in the text view width. - * In that case, some words will be moved to a new line. - * - *
  • Split by character. - * Text will be wrapped when an end of line \\n or \
     is found or if the text doesn't fit in the text view width. - * In that case, words which don't fit will be wrapped in two and the remaining text moved to a new line. - *
- * Dali::Toolkit::TextView::SplitByNewLineChar is set by default. - * - * \subsection exceed_policies Exceed policies - * - *
    - *
  • Original size. - * Text will be displayed with its original size. - * - *
  • Fade. - * Text will be faded out. - * - *
  • Split. - * Text will be wrapped and moved to a new line. - * - *
  • Shrink to fit. - * Text will be shrunk to fit in the text view's boundary. - * - *
  • Ellipsize at the end. - * Text will be truncated to fit in the text view's boundary and the ellipsize text will be added. ( '...' by default). - *
- * Dali::Toolkit::TextView::Original is set by default. - * - * @see Dali::Toolkit::TextView::SetMultilinePolicy - * @see Dali::Toolkit::TextView::SetWidthExceedPolicy - * @see Dali::Toolkit::TextView::SetHeightExceedPolicy - * @see Dali::Toolkit::TextView::SetFadeBoundary - * @see Dali::Toolkit::TextView::SetEllipsizeText - * - * @note Multiple combinations are possible but not all of them are already implemented. - * @see \ref exceed_policies_combinations table to check which combinations are implemented - * - * \section scroll Scroll - * - * Text could be scrolled if it exceeds the boundaries of the text-view. - * - * @see Dali::Toolkit::TextView::SetScrollEnabled - * @see Dali::Toolkit::TextView::SetScrollPosition - * - * \section line_height_spacing Line height spacing - * - * The default space between lines could be modified by setting an offset with Dali::Toolkit::TextView::SetLineHeightOffset(). - * - *

Font support and multi-language detection

- * - * Dali::Toolit::TextView uses the font specified in the styled text array to display the given text. - * - * See \link markup-processor Markup Processor \endlink for more details on how to create styling markup strings and styled text arrays. - * - * To support multi-language texts, text-view does the following actions per character: - *
    - *
  • Check if there is a font defined in the styled text array. - *
  • If there isn't, try to use the default platform font. - *
  • Check if the character is supported by the font. - *
  • If isn't, find the most suitable font for the character. - *
- * - * \section text_alignment Text alignment and justification - * - * Dali::Toolkit::TextView provides a method to align the whole text inside the text view's boundary as well as a method to justify each line - * inside the text. - * - * The Dali::Toolkit::Alignment::Type is used to align the whole text in the text view's area. - * A text could be horizontally aligned (left, center, right) and/or vertically aligned (top, center, bottom). - * Dali::Toolkit::Alignment::HorizontalCenter | Dali::Toolkit::Alignment::VerticalCenter is set by default. - * - * The Dali::Toolkit::TextView::LineJustification is used to justify each line inside the text (left, center, right, justified). - * Dali::Toolkit::TextView::Left is set by default. - * - * @see Dali::Toolkit::TextView::SetTextAlignment @see Dali::Toolkit::TextView::SetLineJustification - * - * \section text_styling Text styling - * - * Dali::Toolkit::TextView supports all text styling features provided by Dali::TextActor (font type, color, size, outline, etc). - * - * Different techniques are provided to set or modify the text view's style: - * - *
    - *
  • By setting a Dali::Toolkit::MarkupProcessor::StyledTextArray with the Dali::Toolkit::TextView::SetText(const MarkupProcessor::StyledTextArray& text) method. - *
  • By setting a new Dali::TextStyle to the current text with the Dali::Toolkit::TextView::SetStyleToCurrentText() method. - *
  • By setting an html-ish markup string which contains both text and style with the Dali::Toolkit::TextView::SetText(const std::string& text) method. - @note By default the style markup processor is disabled. @see Dali::Toolkit::TextView::SetMarkupProcessingEnabled to enable the markup processing. - *
- * - * See \link markup-processor Markup Processor \endlink for more details on how to create styling markup strings and styled text arrays. - * - * \section retrieve Retrieve text layout information - * - * The Dali::Toolkit::TextView::GetTextLayoutInfo() retrieves how the input text has been laid out. - * - * For each character it retrieves its size and position, visibility, etc. @see Dali::Toolkit::TextView::CharacterLayoutInfo. - * - * For each laid-out line it retrieves the index of the first character of the line, size, etc. @see Dali::Toolkit::TextView::LineLayoutInfo. - * - * \section appendix Appendix - * \subsection examples Examples - * - * The following examples show how to use TextView. The grey square is an actor which has been added just to show the size of the text-view. - * - * Creation of a text view actor with all its parameters by default. - * \code - * Toolkit::TextView textView = Toolkit::TextView::New( "Hello world!" ); - * textView.SetParentOrigin( ParentOrigin::CENTER ); - * - * Stage::GetCurrent().Add( textView ); - * \endcode - * - * This example wraps the text in lines only when a \\n character is found. The size of the text-view will be automatically resized to fit the whole text inside. - * \code - * const std::string text( "" - * "Lorem ipsum dolor sit amet, consectetur adipisicing elit,\n" - * "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." - * "" ); - * - * Toolkit::TextView textView = Toolkit::TextView::New( "" ); - * textView.SetMarkupProcessingEnabled( true ); - * textView.SetText( text ); - * textView.SetParentOrigin( ParentOrigin::CENTER ); - * - * textView.SetMultilinePolicy( Toolkit::TextView::SplitByNewLineChar ); - * textView.SetWidthExceedPolicy( Toolkit::TextView::Original ); - * textView.SetHeightExceedPolicy( Toolkit::TextView::Original ); - * textView.SetLineJustification( Toolkit::TextView::Center ); - * - * Stage::GetCurrent().Add( textView ); - * \endcode - * \image html text-view/text-view-example-01.png - * - * This example wraps the lines by the next word when it exceeds the width of the text-view. The height exceed policy is set to \e Original so it may exceed the height of the text-view. - * - * \code - * const std::string text( "" - * "Lorem ipsum dolor sit amet, consectetur adipisicing elit, " - * "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." - * "" ); - * - * Toolkit::TextView textView = Toolkit::TextView::New( "" ); - * textView.SetMarkupProcessingEnabled( true ); - * textView.SetText( text ); - * textView.SetParentOrigin( ParentOrigin::CENTER ); - * textView.SetSize( 300.f, 125.f ); - * - * textView.SetMultilinePolicy( Toolkit::TextView::SplitByWord ); - * textView.SetWidthExceedPolicy( Toolkit::TextView::Original ); - * textView.SetHeightExceedPolicy( Toolkit::TextView::Original ); - * textView.SetLineJustification( Toolkit::TextView::Center ); - * - * Stage::GetCurrent().Add( textView ); - * \endcode - * \image html text-view/text-view-example-02.png - * - * This example wraps the lines by the next word when it exceeds the width of the text-view. If a word is bigger than the text-view's width, it splits the word. If the text exceeds the height of the text-view, the text is ellipsized. - * - * \code - * const std::string text( "" - * "Loremipsumdolorsitametconsectetur adipisicing elit,\n" - * "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." - * "" ); - * const std::string ellipsizeText( "..." ); - * - * Toolkit::TextView textView = Toolkit::TextView::New( "" ); - * textView.SetMarkupProcessingEnabled( true ); - * textView.SetText( text ); - * textView.SetEllipsizeText( ellipsizeText ); - * textView.SetParentOrigin( ParentOrigin::CENTER ); - * textView.SetSize( 300.f, 125.f ); - * - * textView.SetMultilinePolicy( Toolkit::TextView::SplitByWord ); - * textView.SetWidthExceedPolicy( Toolkit::TextView::Split ); - * textView.SetHeightExceedPolicy( Toolkit::TextView::EllipsizeEnd ); - * textView.SetLineJustification( Toolkit::TextView::Center ); - * - * Stage::GetCurrent().Add( textView ); - * \endcode - * \image html text-view/text-view-example-03.png - * - * This example is similar to the one above but the ellipsized text has been set to "" so nothing is shown. - * - * \code - * const std::string text( "" - * "Loremipsumdolorsitametconsecteturadipisicingelit" - * "seddoeiusmodtemporincididuntutlaboreetdoloremagnaaliqua." - * "" ); - * const std::string ellipsizeText( "" ); - * - * Toolkit::TextView textView = Toolkit::TextView::New( "" ); - * textView.SetMarkupProcessingEnabled( true ); - * textView.SetText( text ); - * textView.SetEllipsizeText( ellipsizeText ); - * textView.SetParentOrigin( ParentOrigin::CENTER ); - * textView.SetSize( 300.f, 125.f ); - * - * textView.SetMultilinePolicy( Toolkit::TextView::SplitByWord ); - * textView.SetWidthExceedPolicy( Toolkit::TextView::Split ); - * textView.SetHeightExceedPolicy( Toolkit::TextView::EllipsizeEnd ); - * textView.SetLineJustification( Toolkit::TextView::Center ); - * - * Stage::GetCurrent().Add( textView ); - * \endcode - * \image html text-view/text-view-example-04.png - * - * This example shows how to fade the text out when it exceeds the boundaries of the text-view. - * - * \code - * const std::string text( "" - * "Lorem ipsum dolor sit amet,\n" - * "consectetur adipisicing elit,\n" - * "sed do eiusmod tempor incididunt\n" - * "ut labore et dolore magna aliqua." - * "" ); - * - * Toolkit::TextView textView = Toolkit::TextView::New(); - * textView.SetMarkupProcessingEnabled( true ); - * textView.SetText( text ); - * textView.SetParentOrigin( ParentOrigin::CENTER ); - * textView.SetSize( 300.f, 100.f ); - * - * Toolkit::TextView::FadeBoundary fadeBoundary( PixelSize( 10 ), PixelSize( 10 ), PixelSize( 10 ), PixelSize( 10 ) ); - * textView.SetFadeBoundary( fadeBoundary ); - * - * textView.SetMultilinePolicy( Toolkit::TextView::SplitByNewLineChar ); - * textView.SetWidthExceedPolicy( Toolkit::TextView::Fade ); - * textView.SetHeightExceedPolicy( Toolkit::TextView::Fade ); - * textView.SetLineJustification( Toolkit::TextView::Center ); - * - * Stage::GetCurrent().Add( textView ); - * \endcode - * \image html text-view/text-view-example-05.png - * - * This example enables the scroll feature. The screen-shots show three different images of the same text in different scroll positions. - * - * \code - * const std::string text( "" - * "Lorem ipsum dolor sit amet, consectetur adipisicing elit,\n" - * "sed do eiusmod tempor incididunt ut labore et dolore magna aliqua." - * "" ); - * - * Toolkit::TextView textView = Toolkit::TextView::New(); - * textView.SetMarkupProcessingEnabled( true ); - * textView.SetText( text ); - * textView.SetParentOrigin( ParentOrigin::CENTER ); - * textView.SetSize( 300.f, 60.f ); - * - * textView.SetMultilinePolicy( Toolkit::TextView::SplitByNewLineChar ); - * textView.SetWidthExceedPolicy( Toolkit::TextView::Original ); - * textView.SetHeightExceedPolicy( Toolkit::TextView::Original ); - * textView.SetLineJustification( Toolkit::TextView::Center ); - * - * textView.SetScrollEnabled( true ); - * - * Stage::GetCurrent().Add( textView ); - * \endcode - * \image html text-view/text-view-example-06.png - * \image html text-view/text-view-example-07.png - * \image html text-view/text-view-example-08.png - * - * See \link markup-processor Markup Processor \endlink \ref example for more styling markup string examples. - * - * \subsection exceed_policies_combinations Implemented exceed policies combinations - * - * The following tables show which exceed policies are implemented for each multi-line policy. Each column has one width exceed policy (Original, Fade, Split, ShrinkToFit and EllipsizeEnd), - * each row has one height exceed policy (Original, Fade, ShrinkToFit and EllipsizeEnd). - * - * @note The Split value is not valid for the height exceed policy. - * - * \htmlonly - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
SplitByNewLineChar
Width exceed policies
OriginalFadeSplitShrinkToFitEllipsizeEnd
Height
exceed
policies		Original✓✓✓✓✓
Fade✓✓✓✗✗
ShrinkToFit✗✗✗✓✗
EllipsizeEnd✗✗✓✗✓
- * \endhtmlonly - * - * \n - * - * \htmlonly - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
SplitByWord
Width exceed policies
OriginalFadeSplitShrinkToFitEllipsizeEnd
Height
exceed
policies		Original✓✓✓✓✓
Fade✓✓✓✗✗
ShrinkToFit✗✗✗✓✗
EllipsizeEnd✗✗✓✗✓
- * \endhtmlonly - * - * \n - * - * \htmlonly - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - * - *
SplitByChar
Width exceed policies
OriginalFadeSplitShrinkToFitEllipsizeEnd
Height
exceed
policies		Original✓✓✗✗✗
Fade✓✓✗✗✗
ShrinkToFit✗✗✗✗✗
EllipsizeEnd✗✗✗✗✗
- * \endhtmlonly - */ -