office-gobmx/sd/source/ui/inc/TaskPaneViewShell.hxx
Rüdiger Timm 43e902495d INTEGRATION: CWS changefileheader (1.10.14); FILE MERGED
2008/04/01 15:35:17 thb 1.10.14.2: #i85898# Stripping all external header guards
2008/03/31 13:58:11 rt 1.10.14.1: #i87441# Change license header to LPGL v3.
2008-04-10 19:52:32 +00:00

229 lines
7.2 KiB
C++

/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2008 by Sun Microsystems, Inc.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* $RCSfile: TaskPaneViewShell.hxx,v $
* $Revision: 1.12 $
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef SD_TOOLPANEL_TASK_PANE_VIEW_SHELL_HXX
#define SD_TOOLPANEL_TASK_PANE_VIEW_SHELL_HXX
#include "ViewShell.hxx"
#include "glob.hxx"
#include "framework/FrameworkHelper.hxx"
#include <vcl/button.hxx>
#include <sfx2/shell.hxx>
#include <sfx2/viewfac.hxx>
#include <sfx2/dockwin.hxx>
#include <memory>
#include <boost/shared_ptr.hpp>
class PopupMenu;
namespace sd { namespace toolpanel {
class TaskPaneShellManager;
class TitleToolBox;
class TitleBar;
class TitledControl;
class ToolPanel;
/** The tool panel is a view shell for some very specific reasons:
- It fits better into the concept of panes being docking windows whose
content, a view shell, can be exchanged on runtime.
- A control in the tool panel that wants to show a context menu has to
do that over the dispatcher of a shell. These shells, usually
implemented by the controls themselves, have to be managed by someone.
If interpreted as object bars this can be handled by the
ObjectBarManager of the ViewShell.
*/
class TaskPaneViewShell
: public ViewShell
{
public:
TYPEINFO();
SFX_DECL_INTERFACE(SD_IF_SDTASKPANEVIEWSHELL)
/** List of top level panels that can be shown in the task pane.
*/
enum PanelId
{
PID__START = 0,
PID_UNKNOWN = PID__START,
PID_MASTER_PAGES,
PID_LAYOUT,
PID_TABLE_DESIGN,
PID_ANIMATION_SCHEMES,
PID_CUSTOM_ANIMATION,
PID_SLIDE_TRANSITION,
PID__END = PID_SLIDE_TRANSITION
};
TaskPaneViewShell (
SfxViewFrame* pFrame,
ViewShellBase& rViewShellBase,
::Window* pParentWindow,
FrameView* pFrameView);
virtual ~TaskPaneViewShell (void);
/** Register the SFX interfaces so that (some of) the controls can be
pushed as SFX shells on the shell stack and process slot calls and
so on.
*/
static void RegisterControls (void);
virtual void GetFocus (void);
virtual void LoseFocus (void);
virtual void KeyInput (const KeyEvent& rEvent);
using sd::ViewShell::KeyInput;
virtual SdPage* GetActualPage (void);
virtual SdPage* getCurrentPage (void) const;
void Execute (SfxRequest& rRequest);
void GetState (SfxItemSet& rItemSet);
virtual void ArrangeGUIElements (void);
TaskPaneShellManager& GetSubShellManager (void) const;
/** Called when a mouse button has been pressed but not yet
released, this handler is used to show the popup menu of the
title bar.
*/
DECL_LINK(ToolboxClickHandler, ToolBox*);
DECL_LINK(MenuSelectHandler, Menu*);
/** Make the specified panel visible and expand it.
@param nId
The id of the panel that is to be made visible.
*/
void ShowPanel (const PanelId nId);
/** Hide and collapse the specified panel.
@param nId
The id of the panel that is to hide.
*/
void HidePanel (const PanelId nId);
/** Expand the specified panel. Its visibility state is not modified.
@param nId
The id of the panel that is to expand.
*/
void ExpandPanel (const PanelId nId);
/** Collapse the specified panel. Its visibility state is not
modified.
@param nId
The id of the panel that is to collapse.
*/
void CollapsePanel (const PanelId nId);
virtual ::com::sun::star::uno::Reference<
::com::sun::star::accessibility::XAccessible>
CreateAccessibleDocumentView (::sd::Window* pWindow);
virtual css::uno::Reference<css::drawing::XDrawSubController> CreateSubController (void);
/** Relocate all toplevel controls to the given parent window.
*/
virtual bool RelocateToParentWindow (::Window* pParentWindow);
private:
class Implementation;
::std::auto_ptr<Implementation> mpImpl;
::std::auto_ptr<ToolPanel> mpTaskPane;
bool mbIsInitialized;
::boost::shared_ptr<TaskPaneShellManager> mpSubShellManager;
/** The id of the menu in the menu bar/tool box of the parent docking
window.
*/
USHORT mnMenuId;
/** Create a popup menu. it contains three sections, one for
docking or un-docking the tool panel, one for toggling the
visibility state of the tool panel items, and one for bringing
up a customization dialog.
@param bIsDocking
According to this flag one of the lock/unlock entries is
made disabled.
*/
::std::auto_ptr<PopupMenu> CreatePopupMenu (bool bIsDocking);
/** Make sure that as long as there is at least one visible
control there is exactly one expanded control.
If the currently expanded control is being hidden then try to
expand the control after the hidden one or if that does not
exist expand the one before.
*/
void EnsureExpandedControl (TitledControl* pHiddenControl);
/** Return a pointer to the docking window that is the parent or a
predecessor of the content window.
@return
When the view shell is not placed in a docking window, e.g. when
shown in the center pane, then <NULL?> is returned.
*/
DockingWindow* GetDockingWindow (void);
/** Initialize the task pane view shell if that has not yet been done
before. If mbIsInitialized is already set to <TRUE/> then this
method returns immediately.
*/
void Initialize (void);
};
/** This functor makes visible a panel in the task pane. It can be used
with the FrameworkHelper to make a panel visible after an asynchonous
update of the configuration, e.g. after switching to another view.
*/
class PanelActivation
{
public:
/** Create a new object that, when its operator() method is called, will
make the specified panel visible in the task pane that belongs to
the application window specified by the given ViewShellBase.
*/
PanelActivation (ViewShellBase& rBase, TaskPaneViewShell::PanelId nPanelId);
void operator() (bool);
private:
ViewShellBase& mrBase;
TaskPaneViewShell::PanelId mnPanelId;
};
} } // end of namespace ::sd::toolpanel
#endif