interface/minifram.h

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