iwidgets::finddialog(1) [incr Widgets] iwidgets::finddialog(1)

NAME
       iwidgets::finddialog - Create and manipulate a find dialog widget

SYNOPSIS
       iiwwiiddggeettss::::ffiinnddddiiaalloogg pathName ?options?

IINNHHEERRIITTAANNCCEE
       itk::Toplevel  <-  iwidgets::Shell  <-  iwidgets::Dialogshell  <- iwid-
       gets::Finddialog

SSTTAANNDDAARRDD OOPPTTIIOONNSS
       aaccttiivveeBBaacckkggrroouunndd   aaccttiivveeFFoorreeggrroouunndd    bbaacckkggrroouunndd        bboorrddeerrWWiiddtthh
       ccuurrssoorr             ddiissaabblleeddFFoorreeggrroouunndd  ffoonntt              ffoorreeggrroouunndd
       hhiigghhlliigghhttCCoolloorr     hhiigghhlliigghhttTThhiicckknneessss  iinnsseerrttBBaacckkggrroouunndd  iinnsseerrttBBoorrddeerrWWiiddtthh
       iinnsseerrttOOffffTTiimmee      iinnsseerrttOOnnTTiimmee        iinnsseerrttWWiiddtthh       sseelleeccttBBaacckkggrroouunndd
       sseelleeccttBBoorrddeerrWWiiddtthh  sseelleeccttCCoolloorr         sseelleeccttFFoorreeggrroouunndd

       See the "options" manual entry for details on the standard options.

AASSSSOOCCIIAATTEEDD OOPPTTIIOONNSS
       sseelleeccttCCoolloorr

       See the "checkbutton" widget manual entry  for  details  on  the  above
       associated options.

       sseelleeccttCCoolloorr

       See the "entryfield" widget manual entry for details on the above asso-
       ciated options.

       llaabbeellFFoonntt

       See the "labeledwidget" widget manual entry for details  on  the  above
       associated options.

IINNHHEERRIITTEEDD OOPPTTIIOONNSS
       bbuuttttoonnBBooxxPPaaddXX   bbuuttttoonnBBooxxPPaaddYY  bbuuttttoonnBBooxxPPooss    ppaaddXX
       ppaaddYY            sseeppaarraattoorr      tthhiicckknneessss

       See  the  "dialogshell"  widget   manual entry for details on the above
       inherited options.

       hheeiigghhtt          mmaasstteerr         mmooddaalliittyy        wwiiddtthh

       See the "shell" widget  manual entry for details on the above inherited
       options.

       ttiittllee

       See the "Toplevel" widget  manual entry for details on the above inher-
       ited options.

WWIIDDGGEETT-SSPPEECCIIFFIICC OOPPTTIIOONNSS
       Name:           cclleeaarrCCoommmmaanndd
       Class:          CCoommmmaanndd
       Command-Line Switch:           -cclleeaarrccoommmmaanndd

              Specifies a command to be invoked following a  clear  operation.
              The option is meant to be used as means of notification that the
              clear has taken place and allow other actions to take place such
              as disabling a find again menu.

       Name:           mmaattcchhCCoommmmaanndd
       Class:          CCoommmmaanndd
       Command-Line Switch:           -mmaattcchhccoommmmaanndd

              Specifies  a  command  to be invoked following a find operation.
              The command is called with a match point as  an  argument  which
              identifies  where exactly where in the text or scrolledtext wid-
              get that the match is located.  Should a match not be found  the
              match point is {}.  The option is meant to be used as a means of
              notification that the find operation  has  completed  and  allow
              other  actions to take place such as disabling a find again menu
              option if the match point was {}.

       Name:           ppaatttteerrnnBBaacckkggrroouunndd
       Class:          BBaacckkggrroouunndd
       Command-Line Switch:           -ppaatttteerrnnbbaacckkggrroouunndd

              Specifies the background color of the text matching  the  search
              pattern.   It may have any of the forms accepted by TkGetColor.
              The default is gray44.

       Name:           ppaatttteerrnnFFoorreeggrroouunndd
       Class:          BBaacckkggrroouunndd
       Command-Line Switch:           -ppaatttteerrnnffoorreeggrroouunndd

              Specifies the foreground color of the text matching  the  search
              pattern.   It may have any of the forms accepted by TkGetColor.
              The default is white.

       Name:           sseeaarrcchhBBaacckkggrroouunndd
       Class:          BBaacckkggrroouunndd
       Command-Line Switch:           -sseeaarrcchhbbaacckkggrroouunndd

              Specifies the background color of the line containing the match-
              ing  the  search pattern.  It may have any of the forms accepted
              by TkGetColor.  The default is gray77.

       Name:           sseeaarrcchhFFoorreeggrroouunndd
       Class:          BBaacckkggrroouunndd
       Command-Line Switch:           -sseeaarrcchhffoorreeggrroouunndd

              Specifies the foreground color of the line containing the match-
              ing  the  search pattern.  It may have any of the forms accepted
              by TkGetColor.  The default is black.

       Name:           tteexxttWWiiddggeett
       Class:          TTeexxttWWiiddggeett
       Command-Line Switch:           -tteexxttwwiiddggeett

              Specifies the text or scrolledtext widget to be searched.



DESCRIPTION
       The iiwwiiddggeettss::::ffiinnddddiiaalloogg command creates a find dialog  that  works  in
       conjunction  with  a  text or scrolledtext widget to provide a means of
       performing search operations.  The user is prompted for a text  pattern
       to  be found in the text or scrolledtext widget.  The search can be for
       all occurances, by regular expression,  considerate  of  the  case,  or
       backwards.


MMEETTHHOODDSS
       The  iiwwiiddggeettss::::ffiinnddddiiaalloogg  command creates a new Tcl command whose name
       is pathName.  This command may be used to invoke various operations  on
       the widget.  It has the following general form:

              pathName option ?arg arg ...?

       Option  and  the args determine the exact behavior of the command.  The
       following commands are possible for finddialog widgets:

IINNHHEERRIITTEEDD MMEETTHHOODDSS
       aadddd             bbuuttttoonnccoonnffiigguurree                ddeeffaauulltthhiiddee
       iinnvvookkee          sshhooww

       See the "buttonbox" widget manual entry for details on the above inher-
       ited methods.

       aaccttiivvaattee        cceenntteerr         ddeeaaccttiivvaattee

       See  the "shell" widget manual entry for details on the above inherited
       methods.

WWIIDDGGEETT-SSPPEECCIIFFIICC MMEETTHHOODDSS
       pathName ccggeett option
              Returns the current value of the configuration option  given  by
              option.  Option may have any of the values accepted by the iiwwiidd-
              ggeettss::::ffiinnddddiiaalloogg command.

       pathName cclleeaarr
              Clears the pattern in the entry field and  the  pattern  matchin
              indicators in the text or scrolledtext widget.

       pathName ccoonnffiigguurree ?option? ?value option value ...?
              Query  or modify the configuration options of the widget.  If no
              option is specified, returns a list describing all of the avail-
              able  options for pathName (see TTkkCCoonnffiigguurreeIInnffoo for information
              on the format of this list).  If option  is  specified  with  no
              value,  then the command returns a list describing the one named
              option (this list will be identical to the corresponding sublist
              of  the  value  returned  if no option is specified).  If one or
              more option-value pairs are specified, then the command modifies
              the  given widget option(s) to have the given value(s);  in this
              case the command returns an empty string.  Option may  have  any
              of the values accepted by the iiwwiiddggeettss::::ffiinnddddiiaalloogg command.

       pathName ffiinndd
              Search  for  a  specific text string in the text widget given by
              the -textwidget option.  This method is  the  standard  callback
              for  the  Find button.  It is made available such that it can be
              bound to a find again action.


CCOOMMPPOONNEENNTTSS
       Name:           aallll
       Class:          CChheecckkbbuuttttoonn

              The all component specifies that all the matches of the  pattern
              should  be found when performing the search.  See the "checkbut-
              ton" widget manual entry for details on the all component  item.

       Name:           bbaacckkwwaarrddss
       Class:          CChheecckkbbuuttttoonn

              The  backwards  component  specifies that the search should con-
              tinue in a backwards direction towards the beginning of the text
              or  scrolledtext  widget.   See  the "checkbutton" widget manual
              entry for details on the backwards component item.

       Name:           ccaassee
       Class:          CChheecckkbbuuttttoonn

              The case component specifies that the case of the pattern should
              be taken into consideration when performing the search.  See the
              "checkbutton" widget manual entry for details on the case compo-
              nent item.

       Name:           ppaatttteerrnn
       Class:          EEnnttrryyffiieelldd

              The pattern component provides the pattern entry field.  See the
              "entryfield" widget manual entry for details on the pattern com-
              ponent item.

       Name:           rreeggeexxpp
       Class:          CChheecckkbbuuttttoonn

              The  regexp  component  specifies  that the pattern is a regular
              expression.  See  the  "checkbutton"  widget  manual  entry  for
              details on the regexp component item.


EEXXAAMMPPLLEE
               package require Iwidgets 4.0
               iwidgets::scrolledtext .st
               pack .st
               .st insert end "Now is the time for all good men\n"
               .st insert end "to come to the aid of their country"

               iwidgets::finddialog .fd -textwidget .st
               .fd center .st
               .fd activate


AUTHOR       Mark L. Ulferts

KKEEYYWWOORRDDSS
       finddialog, dialogshell, shell, widget




Tk                                                     iwidgets::finddialog(1)