.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxTopLevelWindow 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxTopLevelWindow \- 
  Any top level window, dialog or frame
 
.SH DESCRIPTION

  


   wxTopLevelWindow is a common base class for
   wxDialog
   and
   wxFrame
   . It is an abstract base class meaning that you never work with objects of
   this class directly, but all of its methods are also applicable for the two
   classes above.
  
 
.SH "PARENTS"

  wxWindow
   
  wxEvtHandler
   
  wxObject
 
.SH "INCLUDE FILES"
wx/toplevel.h
.SH MEMBERS

  
.SS const wxIcon& GetIcon ()

     


      Returns the standard icon of the window. The icon will be invalid if it
      hadn't been previously set by
      SetIcon
      .
     
    
   
  
.SS const wxIconBundle& GetIcons ()

     


      Returns all icons associated with the window, there will be none of them
      if neither
      SetIcon
      nor
      SetIcons
      had been called before.
     
     


      Use
      GetIcon
      to get the main icon of the window.
     
    
   
  
.SS wxString GetTitle ()

     


      Gets a string containing the window title.
     
     


      See
      wxTopLevelWindow::SetTitle
      .
     
    
   
  
.SS bool IsActive ()

     


      Returns true if this window is currently active, i.e. if the user is
      currently working with it.
     
    
   
  
.SS void Iconize (bool iconize)

   
  
.SS bool IsFullScreen ()

     


      Returns true if the window is in fullscreen mode.
     
    
   
  
.SS bool IsIconized ()

     


      Returns true if the window is iconized.
     
    
   
  
.SS bool IsMaximized ()

     


      Returns true if the window is maximized.
     
    
   
  
.SS void Maximize (bool maximize)

     


      Maximizes or restores the window.
     
    
   
  
.SS void RequestUserAttention (int flags = wxUSER_ATTENTION_INFO)

     


      Use a system-dependent way to attract users attention to the window when
      it is in background.
     
     


      
       flags
      
      may have the value of either
      wxUSER_ATTENTION_INFO
      (default) or
      wxUSER_ATTENTION_ERROR
      which results in a more drastic action. When in doubt, use the default
      value.
     
     


      Note that this function should normally be only used when the application
      is not already in foreground.
     
     


      This function is currently implemented for Win32 where it flashes the
      window icon in the taskbar, and for wxGTK with task bars supporting it.
     
    
   
  
.SS void SetIcon (const wxIcon& icon)

     


      Sets the icon for this window.
     
    
   
  
.SS void SetIcons (const wxIconBundle& icons)

     


      Sets several icons of different sizes for this window: this allows to use
      different icons for different situations (e.g. task switching bar,
      taskbar, window title bar) instead of scaling, with possibly bad looking
      results, the only icon set by
      SetIcon
      .
     
    
   
  
.SS void SetLeftMenu (int id = wxID_ANYconst wxString& label = wxEmptyStringwxMenu * subMenu = NULL)

     


      Sets action or menu activated by pressing left hardware button on the
      smart phones. Unavailable on full keyboard machines.
     
    
   
  
.SS void SetRightMenu (int id = wxID_ANYconst wxString& label = wxEmptyStringwxMenu * subMenu = NULL)

     


      Sets action or menu activated by pressing right hardware button on the
      smart phones. Unavailable on full keyboard machines.
     
    
   
  
.SS bool SetShape (const wxRegion& region)

     


      If the platform supports it, sets the shape of the window to that depicted
      by
      
       region
      
      . The system will not display or respond to any mouse event for the pixels
      that lie outside of the region. To reset the window to the normal
      rectangular shape simply call
      
       SetShape
      
      again with an empty region. Returns TRUE if the operation is successful.
     
    
   
  
.SS virtual void SetTitle (const wxString&  title)

     


      Sets the window title.
     
    
   
  
.SS bool ShowFullScreen (bool showlong style = wxFULLSCREEN_ALL)

     


      Depending on the value of
      
       show
      
      parameter the window is either shown full screen or restored to its normal
      state.
      
       style
      
      is a bit list containing some or all of the following values, which
      indicate what elements of the window to hide in full-screen mode:
     
     


      
       wxFULLSCREEN_NOMENUBAR
        
       wxFULLSCREEN_NOTOOLBAR
        
       wxFULLSCREEN_NOSTATUSBAR
        
       wxFULLSCREEN_NOBORDER
        
       wxFULLSCREEN_NOCAPTION
        
       wxFULLSCREEN_ALL (all of the above)
      
     
     


      This function has not been tested with MDI frames.
     
     


      Note that showing a window full screen also actually
      Show()s
      if it hadn't been shown yet.
     
    
 
.SH "SEE ALSO"

  wxWindow
   
  wxEvtHandler
   
  wxObject
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.