# coyote: CGQUERY

- coyote/Graphics
- [Source code]

Description

      Provides information about any cgWindow applications currently on the display. Returns
      the window index numbers of any cgWindow applications current on the display.

Categories

      Graphics

Keywords

      count: out, optional, type=long
          The number of cgWindow applications currently on the display.
      current: in, optional, type=boolean
          If set, the current cgWindow application information is returned in the result
          of the function and in the information keywords.
      dimensions: out, optional, type=integer
          The dimensions of the ctWindow application, [xdim, ydim, n].
      objectref: out, optional, type=object
          A vector of FSC_CMDWINDOW object references for each cgWindow application currently
          on the display.
      title: out, optional, type=string
          A vector of window titles for each cgWindow application currently on the display.
      widgetID: out, optional, type=long
          A vector of widget identifiers of the top-level base widget for each cgWindow
          application currently on the display.

Returns

      windowIndexID: out, type=long
          An array of window index numbers for each cgWindow application currently on the display.

Examples

      Used as a query routine::
         IDL> wids = cgQuery(TITLE=titles, COUNT=count)
         IDL> index = Where(StrUpCase(titles) EQ 'PLOT WINDOW', tcnt)
         IDL> IF tcnt GT 0 THEN cgSet, wids[index]
         IDL> cgWindow, 'Oplot', thisData, /AddCmd

Author

      FANNING SOFTWARE CONSULTING::
          David W. Fanning
          1645 Sheely Drive
          Fort Collins, CO 80526 USA
          Phone: 970-221-0438
          E-mail: david@idlcoyote.com
          Coyote's Guide to IDL Programming: http://www.idlcoyote.com

History

      Change History::
         Written, 23 January 2011. DWF.
         Added DIMENSIONS keyword to return current dimensions of cgWindows. 24 Feb 2011. DWF.
         Made sure this program only returns information on devices that support windows. 20 July 2011. DWF.

Copyright

      Copyright (c) 2011, Fanning Software Consulting, Inc.