view release on metacpan or  search on metacpan

GENERATED/Win32/GUI/RichEdit.pod  view on Meta::CPAN

=head1 NAME

Win32::GUI::RichEdit - Create and manipulate Richedit controls.

=head1 DESCRIPTION

Most of the methods and events that apply to a L<Textfield|Win32::GUI::Textfield>
also apply to Win32::GUI::RichEdit.

Note that in order for most events to be triggered you must call the
SetEventMask() method, to set the events that you want to be triggered.
See L<SetEventMask()|Win32::GUI::RichEdit/SetEventMask>.

By default Win32::GUI::RichEdit uses Rich Edit 1.0.

=for comment $Id: per_package_method_section.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $

=head1 METHODS

L<Common methods|Win32::GUI::Reference::Methods> apply to most windows, controls and resources.

=for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $

=head2 new

B<new(PARENT, %OPTIONS)>

Creates a new RichEdit object;
can also be called as PARENT->AddRichEdit(%OPTIONS).
See L<new Win32::GUI::Textfield()|Win32::GUI::Textfield/new> for B<%OPTIONS>

See also the L<common options|Win32::GUI::Reference::Options>.

=for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $

=head2 AutoURLDetect

B<AutoURLDetect([FLAG=TRUE])>

Set automatic detection of URLs mode.

=for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $

=head2 BackColor

B<BackColor([COLOR])>

See L<SetBkgndColor()|Win32::GUI::RichEdit/SetBkgndColor>

=for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $

=head2 CanPaste

B<CanPaste([FORMAT=CF_TEXT])>

Determine if RichEdit can paste a specified clipboard format.

=for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $

=head2 CanRedo

B<CanRedo()>

Determine whether there are any actions in redo queue

=for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $

=head2 CharFromPos

B<CharFromPos(X, Y)>

Returns a two elements array identifying the character nearest to the
position specified by X and Y.
The array contains the zero-based index of the character and its line
index.

=for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $

=head2 DisplayBand

B<DisplayBand(LEFT, TOP, RIGHT, BOTTOM)>

Displays a portion of a RichEdit's contents, as previously formatted for a device using the EM_FORMATRANGE message.

=for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $

=head2 FindText

B<FindText(STRING, START, END, [FLAG})>

Search a string text.

=for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $

=head2 FindWordBreak

B<FindWordBreak(START, [FLAG=WB_NEXTBREAK] )>

[TBD]

=for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $

=head2 GetAutoURLDetect

B<GetAutoURLDetect()>

[TBD]

=for comment $Id: per_package_method.tpl,v 1.3 2006/03/16 21:11:13 robertemay Exp $

=head2 GetCharFormat

B<GetCharFormat([FLAG=SCF_SELECTION])>

Return a named hash containing the formatting of the current selection
if FLAG = SCF_SELECTION (1) or the default character character formatting