interface/wx/minifram.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        minifram.h
   3 // Purpose:     interface of wxMiniFrame
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxMiniFrame
  11
  12     A miniframe is a frame with a small title bar.
  13     It is suitable for floating toolbars that must not take up too much screen area.
  14
  15     An example of mini frame can be seen in the @ref page_samples_dialogs
  16     using the "Mini frame" command of the "Generic dialogs" submenu.
  17
  18     @beginStyleTable
  19     @style{wxICONIZE}
  20         Display the frame iconized (minimized) (Windows only).
  21     @style{wxCAPTION}
  22         Puts a caption on the frame.
  23     @style{wxMINIMIZE}
  24         Identical to wxICONIZE.
  25     @style{wxMINIMIZE_BOX}
  26         Displays a minimize box on the frame (Windows and Motif only).
  27     @style{wxMAXIMIZE}
  28         Displays the frame maximized (Windows only).
  29     @style{wxMAXIMIZE_BOX}
  30         Displays a maximize box on the frame (Windows and Motif only).
  31     @style{wxCLOSE_BOX}
  32         Displays a close box on the frame.
  33     @style{wxSTAY_ON_TOP}
  34         Stay on top of other windows (Windows only).
  35     @style{wxSYSTEM_MENU}
  36         Displays a system menu (Windows and Motif only).
  37     @style{wxRESIZE_BORDER}
  38         Displays a resizable border around the window.
  39     @endStyleTable
  40
  41     @remarks
  42     This class has miniframe functionality under Windows and GTK, i.e. the presence
  43     of mini frame will not be noted in the task bar and focus behaviour is different.
  44     On other platforms, it behaves like a normal frame.
  45
  46     @library{wxcore}
  47     @category{managedwnd}
  48
  49     @see wxMDIParentFrame, wxMDIChildFrame, wxFrame, wxDialog
  50 */
  51 class wxMiniFrame : public wxFrame
  52 {
  53 public:
  54     /**
  55         Default ctor.
  56     */
  57     wxMiniFrame();
  58
  59     /**
  60         Constructor, creating the window.
  61
  62         @param parent
  63             The window parent. This may be @NULL. If it is non-@NULL, the frame will
  64             always be displayed on top of the parent window on Windows.
  65         @param id
  66             The window identifier. It may take a value of -1 to indicate a default value.
  67         @param title
  68             The caption to be displayed on the frame's title bar.
  69         @param pos
  70             The window position. The value wxDefaultPosition indicates a default position,
  71             chosen by  either the windowing system or wxWidgets, depending on platform.
  72         @param size
  73             The window size. The value wxDefaultSize indicates a default size, chosen by
  74             either the windowing system or wxWidgets, depending on platform.
  75         @param style
  76             The window style. See wxMiniFrame.
  77         @param name
  78             The name of the window. This parameter is used to associate a name with
  79             the item, allowing the application user to set Motif resource values for
  80             individual windows.
  81
  82         @remarks The frame behaves like a normal frame on non-Windows platforms.
  83
  84         @see Create()
  85     */
  86     wxMiniFrame(wxWindow* parent, wxWindowID id,
  87                 const wxString& title,
  88                 const wxPoint& pos = wxDefaultPosition,
  89                 const wxSize& size = wxDefaultSize,
  90                 long style = wxCAPTION | wxRESIZE_BORDER,
  91                 const wxString& name = wxFrameNameStr);
  92
  93     /**
  94         Destructor. Destroys all child windows and menu bar if present.
  95     */
  96     virtual ~wxMiniFrame();
  97
  98     /**
  99         Used in two-step frame construction.
 100         See wxMiniFrame() for further details.
 101     */
 102     bool Create(wxWindow* parent, wxWindowID id, const wxString& title,
 103                 const wxPoint& pos = wxDefaultPosition,
 104                 const wxSize& size = wxDefaultSize,
 105                 long style = wxCAPTION | wxRESIZE_BORDER,
 106                 const wxString& name = wxFrameNameStr);
 107 };
 108