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