interface/minifram.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        minifram.h
   3 // Purpose:     documentation for wxMiniFrame class
   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     @seealso
  52     wxMDIParentFrame, wxMDIChildFrame, wxFrame, wxDialog
  53 */
  54 class wxMiniFrame : public wxFrame
  55 {
  56 public:
  57     //@{
  58     /**
  59         Constructor, creating the window.
  60
  61         @param parent
  62             The window parent. This may be @NULL. If it is non-@NULL, the frame will
  63             always be displayed on top of the parent window on Windows.
  64         @param id
  65             The window identifier. It may take a value of -1 to indicate a default
  66         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
  72             either the windowing system or wxWidgets, depending on platform.
  73         @param size
  74             The window size. The value wxDefaultSize indicates a default size, chosen by
  75             either the windowing system or wxWidgets, depending on platform.
  76         @param style
  77             The window style. See wxMiniFrame.
  78         @param name
  79             The name of the window. This parameter is used to associate a name with the
  80         item,
  81             allowing the application user to set Motif resource values for
  82             individual windows.
  83
  84         @remarks The frame behaves like a normal frame on non-Windows platforms.
  85
  86         @see Create()
  87     */
  88     wxMiniFrame();
  89     wxMiniFrame(wxWindow* parent, wxWindowID id,
  90                 const wxString& title,
  91                 const wxPoint& pos = wxDefaultPosition,
  92                 const wxSize& size = wxDefaultSize,
  93                 long style = wxCAPTION | wxRESIZE_BORDER,
  94                 const wxString& name = "frame");
  95     //@}
  96
  97     /**
  98         Destructor. Destroys all child windows and menu bar if present.
  99     */
 100     ~wxMiniFrame();
 101
 102     /**
 103         Used in two-step frame construction. See wxMiniFrame()
 104         for further details.
 105     */
 106     bool Create(wxWindow* parent, wxWindowID id,
 107                 const wxString& title,
 108                 const wxPoint& pos = wxDefaultPosition,
 109                 const wxSize& size = wxDefaultSize,
 110                 long style = wxCAPTION | wxRESIZE_BORDER,
 111                 const wxString& name = "frame");
 112 };