6244848856
fixed; some documentation fixes git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@1271 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
192 lines
6.1 KiB
C++
192 lines
6.1 KiB
C++
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: frame.h
|
|
// Purpose: wxFrame class
|
|
// Author: Julian Smart
|
|
// Modified by:
|
|
// Created: 01/02/97
|
|
// RCS-ID: $Id$
|
|
// Copyright: (c) Julian Smart and Markus Holzem
|
|
// Licence: wxWindows license
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_FRAME_H_
|
|
#define _WX_FRAME_H_
|
|
|
|
#ifdef __GNUG__
|
|
#pragma interface "frame.h"
|
|
#endif
|
|
|
|
#include "wx/window.h"
|
|
#include "wx/toolbar.h"
|
|
#include "wx/msw/accel.h"
|
|
|
|
WXDLLEXPORT_DATA(extern const char*) wxFrameNameStr;
|
|
WXDLLEXPORT_DATA(extern const char*) wxToolBarNameStr;
|
|
WXDLLEXPORT_DATA(extern const char*) wxStatusLineNameStr;
|
|
|
|
class WXDLLEXPORT wxMenuBar;
|
|
class WXDLLEXPORT wxStatusBar;
|
|
|
|
class WXDLLEXPORT wxFrame: public wxWindow {
|
|
|
|
DECLARE_DYNAMIC_CLASS(wxFrame)
|
|
|
|
public:
|
|
wxFrame(void);
|
|
inline wxFrame(wxWindow *parent,
|
|
wxWindowID id,
|
|
const wxString& title,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = wxDEFAULT_FRAME_STYLE,
|
|
const wxString& name = wxFrameNameStr)
|
|
{
|
|
Create(parent, id, title, pos, size, style, name);
|
|
}
|
|
|
|
~wxFrame(void);
|
|
|
|
bool Create(wxWindow *parent,
|
|
wxWindowID id,
|
|
const wxString& title,
|
|
const wxPoint& pos = wxDefaultPosition,
|
|
const wxSize& size = wxDefaultSize,
|
|
long style = wxDEFAULT_FRAME_STYLE,
|
|
const wxString& name = wxFrameNameStr);
|
|
|
|
virtual bool Destroy(void);
|
|
|
|
void SetClientSize(int width, int height);
|
|
void SetClientSize(const wxSize& sz) { wxWindow::SetClientSize(sz); }
|
|
|
|
void GetClientSize(int *width, int *height) const;
|
|
wxSize GetClientSize() const { return wxWindow::GetClientSize(); }
|
|
|
|
void GetSize(int *width, int *height) const ;
|
|
wxSize GetSize() const { return wxWindow::GetSize(); }
|
|
|
|
void GetPosition(int *x, int *y) const ;
|
|
wxPoint GetPosition() const { return wxWindow::GetPosition(); }
|
|
|
|
virtual void SetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO);
|
|
|
|
virtual void ClientToScreen(int *x, int *y) const;
|
|
|
|
virtual void ScreenToClient(int *x, int *y) const;
|
|
|
|
virtual bool OnClose(void);
|
|
|
|
void OnSize(wxSizeEvent& event);
|
|
void OnMenuHighlight(wxMenuEvent& event);
|
|
void OnActivate(wxActivateEvent& event);
|
|
void OnIdle(wxIdleEvent& event);
|
|
void OnCloseWindow(wxCloseEvent& event);
|
|
|
|
bool Show(bool show);
|
|
|
|
// Set menu bar
|
|
void SetMenuBar(wxMenuBar *menu_bar);
|
|
virtual wxMenuBar *GetMenuBar(void) const ;
|
|
|
|
// Set title
|
|
void SetTitle(const wxString& title);
|
|
wxString GetTitle(void) const ;
|
|
|
|
void Centre(int direction = wxBOTH);
|
|
|
|
// Call this to simulate a menu command
|
|
virtual void Command(int id);
|
|
virtual void ProcessCommand(int id);
|
|
|
|
// Set icon
|
|
virtual void SetIcon(const wxIcon& icon);
|
|
|
|
// Create status line
|
|
virtual wxStatusBar* CreateStatusBar(int number=1, long style = wxST_SIZEGRIP, wxWindowID id = 0,
|
|
const wxString& name = wxStatusLineNameStr);
|
|
inline wxStatusBar *GetStatusBar() const { return m_frameStatusBar; }
|
|
inline void SetStatusBar(wxStatusBar *statusBar) { m_frameStatusBar = statusBar; }
|
|
virtual void PositionStatusBar(void);
|
|
virtual wxStatusBar *OnCreateStatusBar(int number, long style, wxWindowID id,
|
|
const wxString& name);
|
|
|
|
// Create toolbar
|
|
virtual wxToolBar* CreateToolBar(long style = wxNO_BORDER | wxTB_HORIZONTAL | wxTB_FLAT,
|
|
wxWindowID id = -1,
|
|
const wxString& name = wxToolBarNameStr);
|
|
virtual wxToolBar *OnCreateToolBar(long style, wxWindowID id, const wxString& name);
|
|
// If made known to the frame, the frame will manage it automatically.
|
|
virtual inline void SetToolBar(wxToolBar *toolbar) { m_frameToolBar = toolbar; }
|
|
virtual inline wxToolBar *GetToolBar(void) const { return m_frameToolBar; }
|
|
virtual void PositionToolBar(void);
|
|
|
|
// Set status line text
|
|
virtual void SetStatusText(const wxString& text, int number = 0);
|
|
|
|
// Set status line widths
|
|
virtual void SetStatusWidths(int n, const int widths_field[]);
|
|
|
|
// Hint to tell framework which status bar to use
|
|
// TODO: should this go into a wxFrameworkSettings class perhaps?
|
|
static void UseNativeStatusBar(bool useNative) { m_useNativeStatusBar = useNative; };
|
|
static bool UsesNativeStatusBar(void) { return m_useNativeStatusBar; };
|
|
|
|
// Fit frame around subwindows
|
|
virtual void Fit(void);
|
|
|
|
// Iconize
|
|
virtual void Iconize(bool iconize);
|
|
|
|
virtual bool IsIconized(void) const ;
|
|
|
|
// Is it maximized?
|
|
virtual bool IsMaximized(void) const ;
|
|
|
|
// Compatibility
|
|
inline bool Iconized(void) const { return IsIconized(); }
|
|
|
|
virtual void Maximize(bool maximize);
|
|
// virtual bool LoadAccelerators(const wxString& table);
|
|
|
|
// Responds to colour changes
|
|
void OnSysColourChanged(wxSysColourChangedEvent& event);
|
|
|
|
// Query app for menu item updates (called from OnIdle)
|
|
void DoMenuUpdates(void);
|
|
void DoMenuUpdates(wxMenu* menu);
|
|
|
|
WXHMENU GetWinMenu(void) const ;
|
|
|
|
// Checks if there is a toolbar, and returns the first free client position
|
|
virtual wxPoint GetClientAreaOrigin() const;
|
|
|
|
// Handlers
|
|
bool MSWOnPaint(void);
|
|
WXHICON MSWOnQueryDragIcon(void);
|
|
void MSWOnSize(int x, int y, WXUINT flag);
|
|
bool MSWOnCommand(WXWORD id, WXWORD cmd, WXHWND control);
|
|
bool MSWOnClose(void);
|
|
void MSWOnMenuHighlight(WXWORD item, WXWORD flags, WXHMENU sysmenu);
|
|
bool MSWProcessMessage(WXMSG *msg);
|
|
bool MSWTranslateMessage(WXMSG *msg);
|
|
void MSWCreate(int id, wxWindow *parent, const char *WXUNUSED(wclass), wxWindow *wx_win, const char *title,
|
|
int x, int y, int width, int height, long style);
|
|
|
|
protected:
|
|
// propagate our state change to all child frames
|
|
void IconizeChildFrames(bool bIconize);
|
|
|
|
wxMenuBar * m_frameMenuBar;
|
|
wxStatusBar * m_frameStatusBar;
|
|
wxIcon m_icon;
|
|
bool m_iconized;
|
|
WXHICON m_defaultIcon;
|
|
static bool m_useNativeStatusBar;
|
|
wxToolBar * m_frameToolBar ;
|
|
|
|
DECLARE_EVENT_TABLE()
|
|
};
|
|
|
|
#endif
|
|
// _WX_FRAME_H_
|