wxWidgets/include/wx/osx/carbon/drawer.h
Vadim Zeitlin 233f573883 Fix file paths in the header comments.
Consistently use only "wx/foo.h" instead of "include/wx/foo.h" ("include" is
always implicit anyhow).

Also use "src/osx" instead of "src/mac" for the files in this directory.

See #12165.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@64943 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
2010-07-13 13:29:58 +00:00

72 lines
2.3 KiB
C++

/////////////////////////////////////////////////////////////////////////////
// Name: wx/osx/carbon/drawer.h
// Purpose: Drawer child window class.
// Drawer windows appear under their parent window and
// behave like a drawer, opening and closing to reveal
// content that does not need to be visible at all times.
// Author: Jason Bagley
// Modified by:
// Created: 2004-30-01
// RCS-ID: $Id$
// Copyright: (c) Jason Bagley; Art & Logic, Inc.
// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
#ifndef _WX_DRAWERWINDOW_H_
#define _WX_DRAWERWINDOW_H_
#include "wx/toplevel.h"
//
// NB: This is currently a private undocumented class -
// it is stable, but the API is not and will change in the
// near future
//
#if ( MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_2 )
class WXDLLIMPEXP_ADV wxDrawerWindow : public wxTopLevelWindow
{
DECLARE_DYNAMIC_CLASS(wxDrawerWindow)
public:
wxDrawerWindow();
wxDrawerWindow(wxWindow* parent,
wxWindowID id,
const wxString& title,
wxSize size = wxDefaultSize,
wxDirection edge = wxLEFT,
const wxString& name = wxT("drawerwindow"))
{
this->Create(parent, id, title, size, edge, name);
}
virtual ~wxDrawerWindow();
// Create a drawer window.
// If parent is NULL, create as a tool window.
// If parent is not NULL, then wxTopLevelWindow::Attach this window to parent.
bool Create(wxWindow *parent,
wxWindowID id,
const wxString& title,
wxSize size = wxDefaultSize,
wxDirection edge = wxLEFT,
const wxString& name = wxFrameNameStr);
bool Open(bool show = true); // open or close the drawer, possibility for async param, i.e. animate
bool Close() { return this->Open(false); }
bool IsOpen() const;
// Set the edge of the parent where the drawer attaches.
bool SetPreferredEdge(wxDirection edge);
wxDirection GetPreferredEdge() const;
wxDirection GetCurrentEdge() const; // not necessarily the preferred, due to screen constraints
};
#endif // defined( __WXMAC__ ) && TARGET_API_MAC_OSX && ( MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_2 )
#endif
// _WX_DRAWERWINDOW_H_